-
Notifications
You must be signed in to change notification settings - Fork 54
docs(weave): add how-to for creating a custom agent signal #3089
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
anastasiaguspan
wants to merge
2
commits into
main
Choose a base branch
from
aguspan/docs-create-custom-signal
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,34 @@ | ||||||
| --- | ||||||
| title: "Create a custom signal" | ||||||
| description: "Create a custom W&B Weave signal to tag agent turns for a behavior you define." | ||||||
| keywords: ["signals", "custom signal", "agent monitoring", "tags"] | ||||||
| --- | ||||||
|
|
||||||
| A custom signal scores agent turns against a behavior you define, then shows that result as a tag in the [Agents view](/weave/guides/tracking/view-agent-activity). W&B Weave also provides [built-in signals](/weave/guides/tracking/view-agent-signals) for common cases such as user frustration and jailbreaking. When those built-in signals don't cover what you want to monitor, create a custom signal. This page shows you how to create that custom tag signal in the Weave UI. | ||||||
|
|
||||||
| ## Create a custom tag signal | ||||||
|
|
||||||
| To create a custom tag signal: | ||||||
|
|
||||||
| 1. Navigate to [wandb.ai](https://wandb.ai/) and select your project. | ||||||
| 1. In the **Weave project sidebar**, click **Agents**. | ||||||
| 1. In the tab bar, click **Signals**. | ||||||
| 1. On the Signals tab, click **+ Create your first signal**. | ||||||
| 1. In the dialog, click **Custom Signal**. | ||||||
|
|
||||||
| <Frame> | ||||||
|  | ||||||
| </Frame> | ||||||
|
|
||||||
| 1. In the **Custom tags** drawer, configure the following fields: | ||||||
| - **Tag name**: The label that appears in the Agents view for the behavior you want to monitor. | ||||||
| - **Definition**: Describe the behavior the signal should detect. | ||||||
| - (Optional) **+ Add tag**: Click to define another tag on the same signal. | ||||||
| - **Scorer name**: The display name for this signal. | ||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - **Inference model or custom runtime**: The model used to score matching turns. [Serverless Inference](/inference/) is the default. CoreWeave Serverless Inference consumes credits from your W&B account. | ||||||
| - (Optional) **Include tool calls**: Expand **Advanced**, then include the turn's tool calls in the context sent to the scoring model. | ||||||
| - (Optional) **Only score turns matching**: Expand **Advanced**, then add filters to restrict which turns the signal scores. To score every agent turn, leave this field empty. | ||||||
| - (Optional) **Sample rate**: Expand **Advanced**, then set the fraction of matching agent turns the signal scores. To reduce cost on high-traffic agents, we recommend lowering the sample rate. | ||||||
| 1. In the **Custom tags** drawer, click **Create signal**. | ||||||
|
|
||||||
| After you create the signal, Weave scores matching turns. The tag appears in the Agents view, including on the Signals tab. | ||||||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.