Skip to content

Commit

Permalink
Merge branch 'master' into andrew/better-error-msg
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewtruong authored Dec 6, 2024
2 parents d50fad9 + 535f811 commit d89ec14
Show file tree
Hide file tree
Showing 64 changed files with 611 additions and 593 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ repos:
hooks:
- id: mypy
additional_dependencies:
[types-pkg-resources==0.1.3, types-all, wandb>=0.15.5]
[types-pkg-resources==0.1.3, types-all, wandb>=0.15.5, wandb<0.19.0]
# Note: You have to update pyproject.toml[tool.mypy] too!
args: ["--config-file=pyproject.toml"]
exclude: (.*pyi$)|(weave_query)|(tests)|(examples)
Expand Down
125 changes: 125 additions & 0 deletions docs/docs/guides/tools/comparison.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# Comparison

The Weave Comparison feature allows you to visually compare and diff code, traces, prompts, models, and model configurations. You can compare two objects side-by-side or analyze a larger set of objects to identify differences, patterns, and trends.

This guide covers the steps to start a comparison and the available actions to tailor your comparison view, including baseline comparisons, numeric diff formatting, and more.

## Access the Comparison view

1. In the sidebar, select the type of object you'd like to compare (e.g. **Traces**, **Models**, etc.).
2. Select the objects that you want to compare. The selection method varies depending on the type of object you are comparing:
- For **Traces**, select traces to compare by checking the checkboxes in the appropriate rows in the Traces column.
- For objects such as **Models**, navigate to the model Versions page and check the checkboxes next to the versions that you want to compare.
3. Click **Compare** to open the Comparison view. Now, you can refine your view using the [available actions](#available-actions).

## Available actions

In the Comparison view, you have multiple actions available, depending on how many objects are being compared. Make sure to look at the [usage notes](#usage-notes).

- [Change the diff display](#change-the-diff-display)
- [Display side-by-side](#display-side-by-side)
- [Display in a unified view](#display-in-a-unified-view)
- [Set a baseline](#set-a-baseline)
- [Remove a baseline](#remove-a-baseline)
- [Change the comparison order](#change-the-comparison-order)
- [Change numeric diff display format](#change-numeric-diff-display-format)
- [Compare with baseline or previous](#compare-with-baseline-or-previous)
- [Compare a pair from a multi-object comparison](#compare-a-pair-from-a-multi-object-comparison)
- [Remove an object from comparison](#remove-an-object-from-comparison)

### Change the diff display

By default, **Diff only** is set to off. To filter the table rows so that only changed rows are displayed, toggle **Diff only** on.

### Display side-by-side

> This option is only available when comparing two objects, or a [pair from a multi-object comparison](#compare-a-pair-from-a-multi-object-comparison).
To compare each object side-by-side in separate columns, select **Side-by-side**.

![Side-by-side Comparison view of two objects](imgs/comparison-2objs-sidebyside.png)

### Display in a unified view

> This option is only available when comparing two objects, or a [pair from a multi-object comparison](#compare-a-pair-from-a-multi-object-comparison).
To compare each object in a unified view, select **Unified**.

![Unified Comparison view of two objects](imgs/comparison-2objs-unified.png)

### Set a baseline

By default, each object in the Comparison view is compared to the object to its left. However, you can set an object as the _baseline_, which means that all objects will be compared to the leftmost object in the view.
To set an object as baseline, do the following:

1. In the Comparison view topbar, mouse over the object that you want to set as the baseline.
2. Click the three dots to the right of the ID.
![Make baseline option displayed.](imgs/comparison-2objs-baseline.png)
3. In the dropdown, select **Make baseline**. The UI refreshes so that the baseline object is furthest left in the topbar, and `Baseline` displays next to the ID.
![Baseline set.](imgs/comparison-2objs-baseline-set.png)

### Remove a baseline

To remove an object as baseline, do the following:

1. In the Comparison view topbar, mouse over the baseline object.
2. Click the three dots to the right of the ID.
3. In the dropdown, select **Remove baseline**. Now, `Baseline` no longer displays next to the call ID.

### Change the comparison order

To change the comparison order, do the following:

1. In the Comparison view topbar, mouse over the ID that you want to reorder.
2. Click the six dots to the left of the ID.
![Setting the order.](imgs/comparison-2objs-reorder.png)
3. Drag the ID to the left or the right, depending on which object was selected.
4. Place the ID in the desired ordering. The UI refreshes with an updated comparison ordering.

### Change numeric diff display format

For numeric values such as `completion_tokens` and `total_tokens`, you can view the diff as either an integer or a percentage. Additionally, positive numeric values can be viewed as a multiplier. To change a numeric diff's display format, do the following:

1. In the Comparison table, find the numeric value that you want to update the diff display format for.
![A numeric value displayed as an integer.](imgs/comparison-2objs-numericdiffformat.png)
2. Click the diff value. The format automatically updates to either an integer or a percentage.
![A numeric value updated to a percentage.](imgs/comparison-2objs-numericdiffformat-updated.png)

### Compare with baseline or previous

> This option is only available when comparing 3 or more objects.
> You can also [set](#set-a-baseline) or [remove an existing baseline by clicking the 3 dots to the right of the ID](#remove-a-baseline).
To perform a baseline comparison with 3 or more objects, do the following:

1. In the right hand corner of the Comparison view, click the dropdown. Depending on your current view configuration, the dropdown is either titled **Compare with previous** or **Compare with baseline**.
2. Depending on your current view configuration, select either **Compare with previous** or **Compare with baseline**.
- **Compare with baseline**: Sets the leftmost object as the baseline. The table updates so that the leftmost column is the baseline.
- **Compare with previous**: No object is set as baseline.

### Compare a pair from a multi-object comparison

> This option is only available when comparing 3 or more objects.
When comparing 3 or more objects, you can compare a single object to a previous object or baseline. This changes the Comparison table view so that the view is identical to a two-object comparison. To compare a pair of objects from a multi-object comparison, do the following:

1. In the Comparison view topbar, find the ID that you want to compare to previous or baseline.
2. To select the item, click the ID. The UI refreshes with a two-way comparison table.
![Comparing a pair from a multi-object comparison.](imgs/comparsion-7objs-diffonly-subset.png)

To reset the view so that the first 6 objects selected for comparison are displayed in the table, click the ID again.

### Remove an object from comparison

> This option is only available when comparing 3 or more objects.
To remove an object from comparison, do the following:

1. In the Comparison view topbar, find the object that you want to remove from comparison.
2. Click the three dots to the right of the ID.
3. In the dropdown, select **Remove object from comparison**. The UI refreshes with an updated table that no longer includes the removed object.

## Usage notes

- The Comparison feature is only available in the UI.
- You can compare as many objects as you'd like. However, the UI only displays a maximum of 6. To view an object in the comparison table that is not visible when comparing more than 6 objects, either [change the comparison order](#change-the-comparison-order) so that the object is one of the first 6 objects from left to right, or [pair from a multi-object comparison](#compare-a-pair-from-a-multi-object-comparison) for easy viewing.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 35 additions & 5 deletions docs/docs/guides/tools/playground.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Evaluating LLM prompts and responses is challenging. The Weave Playground is des
Get started with the Playground to optimize your LLM interactions and streamline your prompt engineering process and LLM application development.

- [Prerequisites](#prerequisites)
- [Add a provider API key](#add-a-provider-api-key)
- [Add provider credentials and information](#add-provider-credentials-and-information)
- [Access the Playground](#access-the-playground)
- [Select an LLM](#select-an-llm)
- [Adjust LLM parameters](#adjust-llm-parameters)
Expand All @@ -27,17 +27,21 @@ Get started with the Playground to optimize your LLM interactions and streamline

## Prerequisites

Before you can use Playground, you must [add an API key](#add-a-provider-api-key) for your preferred LLM provider(s), and [open the Playground UI](#access-the-playground).
Before you can use Playground, you must [add provider credentials](#add-provider-credentials-and-information), and [open the Playground UI](#access-the-playground).

### Add a provider API key
### Add provider credentials and information

Playground currently supports OpenAI, Anthropic, Gemini, and Groq models.
To use one of the available LLMs, your W&B admin must add the appropriate API key to your team secrets in W&B settings.
Playground currently supports OpenAI, Anthropic, Gemini, Groq, and Amazon Bedrock models.
To use one of the available models, add the appropriate information to your team secrets in W&B settings.

- OpenAI: `OPENAI_API_KEY`
- Anthropic: `ANTHROPIC_API_KEY`
- Gemini: `GOOGLE_API_KEY`
- Groq: `GEMMA_API_KEY`
- Amazon Bedrock:
- `AWS_ACCESS_KEY_ID`
- `AWS_SECRET_ACCESS_KEY`
- `AWS_REGION_NAME`

### Access the Playground

Expand Down Expand Up @@ -105,6 +109,32 @@ You can switch the LLM using the dropdown menu in the top left. Currently, the a
- o1-mini
- o1-preview-2024-09-12
- o1-preview
- ai21.j2-mid-v1
- ai21.j2-ultra-v1
- amazon.titan-text-lite-v1
- amazon.titan-text-express-v1
- mistral.mistral-7b-instruct-v0:2
- mistral.mixtral-8x7b-instruct-v0:1
- mistral.mistral-large-2402-v1:0
- mistral.mistral-large-2407-v1:0
- anthropic.claude-3-sonnet-20240229-v1:0
- anthropic.claude-3-5-sonnet-20240620-v1:0
- anthropic.claude-3-haiku-20240307-v1:0
- anthropic.claude-3-opus-20240229-v1:0
- anthropic.claude-v2
- anthropic.claude-v2:1
- anthropic.claude-instant-v1
- cohere.command-text-v14
- cohere.command-light-text-v14
- cohere.command-r-plus-v1:0
- cohere.command-r-v1:0
- meta.llama2-13b-chat-v1
- meta.llama2-70b-chat-v1
- meta.llama3-8b-instruct-v1:0
- meta.llama3-70b-instruct-v1:0
- meta.llama3-1-8b-instruct-v1:0
- meta.llama3-1-70b-instruct-v1:0
- meta.llama3-1-405b-instruct-v1:0

## Adjust LLM parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/guides/tracking/tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -361,16 +361,16 @@ You can also manually create Calls using the API directly.
import weave

# Initialize Weave Tracing
weave.init('intro-example')
client = weave.init('intro-example')

def my_function(name: str):
# Start a call
call = weave.create_call(op="my_function", inputs={"name": name})
call = client.create_call(op="my_function", inputs={"name": name})

# ... your function code ...

# End a call
weave.finish_call(call, output="Hello, World!")
client.finish_call(call, output="Hello, World!")

# Call your function
print(my_function("World"))
Expand Down
1 change: 1 addition & 0 deletions docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ const sidebars: SidebarsConfig = {
"guides/core-types/datasets",
"guides/tracking/feedback",
"guides/tracking/costs",
"guides/tools/comparison",
"guides/tools/playground",
"guides/core-types/media",
{
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ module = "weave_query.*"
ignore_errors = true

[tool.bumpversion]
current_version = "0.51.23-dev0"
current_version = "0.51.24-dev0"
parse = """(?x)
(?P<major>0|[1-9]\\d*)\\.
(?P<minor>0|[1-9]\\d*)\\.
Expand Down
4 changes: 2 additions & 2 deletions sdks/node/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 14 additions & 3 deletions sdks/node/package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
{
"name": "weave",
"version": "0.7.0",
"version": "0.7.3",
"description": "AI development toolkit",
"types": "dist/src/index.d.ts",
"main": "dist/src/index.js",
"types": "dist/index.d.ts",
"main": "dist/index.js",
"type": "commonjs",
"exports": {
".": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
}
},
"scripts": {
"build": "tsc --outDir dist",
"prepare": "npm run build",
"test": "jest --silent",
"test:coverage": "jest --coverage",
"test:watch": "jest --watch",
Expand All @@ -14,6 +22,9 @@
"generate-api": "swagger-typescript-api -p ./weave.openapi.json -o ./src/generated -n traceServerApi.ts",
"dev": "nodemon"
},
"files": [
"dist"
],
"repository": {
"type": "git",
"url": "https://github.com/wandb/weave/js"
Expand Down
29 changes: 19 additions & 10 deletions sdks/node/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,28 @@
"sourceMap": true,
"strict": true,
"esModuleInterop": true,
"outDir": "./dist",
"outDir": "dist",
"paths": {
"weave": ["./src/index.ts"]
}
},
"declaration": true,
"declarationMap": true,
"rootDir": "src",
"tsBuildInfoFile": "dist/.tsbuildinfo"
},
"include": ["src/**/*"],
"exclude": ["src", "examples", "dist", "node_modules"],
"references": [
{
"path": "./src/tsconfig.src.json"
},
{
"path": "./examples/tsconfig.examples.json"
}
"exclude": [
"examples",
"dist",
"node_modules",
"src/integrations/checkOpenai.ts"
]
// "references": [
// {
// "path": "./src/tsconfig.src.json"
// },
// {
// "path": "./examples/tsconfig.examples.json"
// }
// ]
}
2 changes: 1 addition & 1 deletion tests/trace/test_exec.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ def test_publish_works_for_code_with_no_source_file(

ref = captured["ref"]
op = ref.get()
actual_captured_code = op.art.path_contents["obj.py"].decode()
actual_captured_code = op.get_captured_code()
expected_captured_code = expected_captured_code[1:] # ignore first newline

assert actual_captured_code == expected_captured_code
8 changes: 4 additions & 4 deletions tests/trace/test_trace_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ def test_func():

ref = weave.publish(test_func)
test_func2 = ref.get()
code2 = test_func2.art.path_contents["obj.py"].decode()
code2 = test_func2.get_captured_code()
assert "Code-capture was disabled" in code2

parse_and_apply_settings(UserSettings(capture_code=True))
Expand All @@ -117,7 +117,7 @@ def test_func():

ref2 = weave.publish(test_func)
test_func3 = ref2.get()
code3 = test_func3.art.path_contents["obj.py"].decode()
code3 = test_func3.get_captured_code()
assert "Code-capture was disabled" not in code3


Expand All @@ -130,7 +130,7 @@ def test_func():

ref = weave.publish(test_func)
test_func2 = ref.get()
code2 = test_func2.art.path_contents["obj.py"].decode()
code2 = test_func2.get_captured_code()
assert "Code-capture was disabled" in code2

os.environ["WEAVE_CAPTURE_CODE"] = "true"
Expand All @@ -141,7 +141,7 @@ def test_func():

ref2 = weave.publish(test_func)
test_func3 = ref2.get()
code3 = test_func3.art.path_contents["obj.py"].decode()
code3 = test_func3.get_captured_code()
assert "Code-capture was disabled" not in code3


Expand Down
Loading

0 comments on commit d89ec14

Please sign in to comment.