Skip to content

Commit 08ebbfb

Browse files
ngraylunawandb-docs-pr-writer[bot]
ngrayluna
and
wandb-docs-pr-writer[bot]
authored
W&B Agent: Release (#2618)
## Status Do not merge. Pending legal review + broader release. ## Description "W&B Agent" (codename) docs. --------- Co-authored-by: wandb-docs-pr-writer[bot] <281709622+wandb-docs-pr-writer[bot]@users.noreply.github.com>
1 parent 676b28d commit 08ebbfb

12 files changed

Lines changed: 412 additions & 1 deletion

‎aria/autoresearch.mdx‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: "Use ARIA for autoresearch"
3+
description: "Learn how to use ARIA, W&B's AI Research and Iteration Agent, to analyze results and run experiments."
4+
---
5+
6+
Use ARIA, W&B's AI Research and Iteration Agent, as your research assistant to analyze experiments, explain results, identify patterns across runs, recommend next steps, build visualizations, and more.
7+
8+
Based on your previous runs, ARIA can recommend and run new experiments.
9+
10+
ARIA uses W&B Launch to run experiments in a sandbox environment. Before ARIA can run experiments in your project, use [ARIA to help you set up W&B Launch](/aria/autoresearch#set-up-wb-launch-with-aria).
11+
12+
## Set up W&B Launch with ARIA
13+
14+
ARIA can help you configure W&B Launch from the chat. For example, if you ask ARIA:
15+
16+
```text title="User prompt"
17+
Can you help me set up W&B Launch?
18+
```
19+
20+
ARIA checks which [W&B Launch components](/aria/autoresearch#launch-components) are available in your project and guides you through the remaining setup steps.
21+
22+
The following example shows part of an ARIA response to the prompt, "Can you help me set up W&B Launch?":
23+
24+
25+
<Accordion title="ARIA response">
26+
27+
```text
28+
## 1. Decide where jobs will actually run
29+
30+
Pick one:
31+
32+
### Option A — Kubernetes / cluster setup
33+
Use this if you want shared GPU/CPU infrastructure and a
34+
persistent Launch agent.
35+
36+
Recommended for “real” team usage.
37+
38+
### Option B — Local Docker setup
39+
Use this if you want jobs to run on your own machine,
40+
e.g. local workstation with Docker and possibly a GPU.
41+
42+
Good for testing Launch quickly.
43+
44+
I’d usually start with **Kubernetes** if
45+
you have cluster access. If not, start with **Local Docker**.
46+
47+
## 2. Create a Launch queue in the W&B UI
48+
49+
Go to the Launch page for the entity: https://wandb.ai/wandb/launch
50+
51+
Then:
52+
53+
1. Click **Create Queue**.
54+
2. Select entity: `wandb`.
55+
3. Give the queue a name.
56+
4. Choose the queue resource type:
57+
- **Kubernetes** for cluster execution.
58+
- **Docker** for local execution.
59+
5. Add the queue resource configuration.
60+
6. Click **Create Queue**.
61+
62+
## 3. Kubernetes path: install a Launch agent with Helm
63+
64+
If using Kubernetes, you need:
65+
66+
- A Kubernetes cluster.
67+
- `kubectl` access to the cluster.
68+
- `helm` installed locally.
69+
- A W&B **service account API key**.
70+
- Permission to create/update/delete Kubernetes resources in the target namespace.
71+
72+
Do **not** use your personal API key for the agent if this is a real
73+
setup. Use a W&B service account key.
74+
```
75+
76+
</Accordion>
77+
78+
79+
### Launch components
80+
81+
W&B Launch has three core components:
82+
83+
* **Launch job**: A reusable blueprint for configuring and running a task in an ML workflow.
84+
* **Launch queue**: A first-in, first-out queue that submits jobs to a compute target, such as a Kubernetes cluster.
85+
* **Launch agent**: A process that polls a queue and runs jobs on the compute target configured for that queue.
86+
87+
ARIA can manage the W&B-side Launch workflow after a queue and active Launch agent are available. ARIA usually cannot start a durable Launch agent on your local machine, Kubernetes cluster, SageMaker environment, or Vertex AI environment. A user or administrator must provide the compute environment, credentials, and running agent.
88+
89+
The following table summarizes the steps and who usually performs them to enable ARIA to run experiments with W&B Launch.
90+
91+
| Step | Usually performed by | Details |
92+
| -------------------------------------- | ----------------------------------- | ---------------- |
93+
| Create a Launch queue | ARIA or team admin | ARIA can help create a queue when the required permissions and target backend are clear. Team admin permissions might be required |
94+
| Choose or provision a compute backend | Team member or infrastructure owner | ARIA needs access to a Docker host, Kubernetes cluster, SageMaker environment, or Vertex AI environment. ARIA cannot provision infrastructure unless it is already accessible through W&B Launch. |
95+
| Start the Launch agent | Team member or infrastructure owner | The Launch agent must run persistently on your machine or cluster with W&B credentials. |
96+
| Configure a service account or API key | Team admin | Create and store service account keys securely. For more information, see [Manage secrets](https://docs.wandb.ai/platform/secrets#manage-secrets). |
97+
| Submit experiments to the queue | ARIA | After a queue has an active agent, ARIA can submit jobs, relaunch runs with config overrides, monitor results, debug failures, and compare metrics. |

‎aria/chat.mdx‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: "Chat with ARIA"
3+
---
4+
5+
The following page describes how to start a new chat, view your chat history, delete previous conversations, undock the chat window, reference a specific run in your prompt, add an image to a conversation, and provide feedback on ARIA's responses.
6+
7+
## Start a new chat
8+
9+
To start a new chat, open ARIA, then click on the pencil icon in the upper right corner of the chat window.
10+
11+
You can run multiple chats in parallel at a time. ARIA will notify you when it responds to a chat, even if you have closed the chat window.
12+
13+
Starting a new chat does not delete your previous conversations. To [view previous conversations](/aria/chat#view-chat-history), open the chat history by clicking the three horizontal lines in the upper left corner of the chat window.
14+
15+
## View chat history
16+
17+
To view previous conversation:
18+
19+
1. Open ARIA.
20+
2. Click the three horizontal lines in the upper left corner of the chat window to open the chat history.
21+
3. Select a conversation.
22+
23+
W&B organizes your conversations with ARIA by project and by date. You can resume a previous conversation by selecting it from the chat history. You can also [delete a conversation by clicking the trash](/aria/chat#delete-previous-conversations) can icon next to the conversation.
24+
25+
## Delete previous conversations
26+
27+
To delete a previous conversation:
28+
29+
1. Open ARIA.
30+
2. Click the three horizontal lines in the upper left corner of the chat window to open the chat history.
31+
3. Click the trash can icon next to the conversation you want to delete.
32+
33+
## Undock chat window
34+
35+
You can undock the chat window into a separate window, which allows you to view the agent's response side-by-side with your project data.
36+
37+
To undock the chat, click the undock icon in the upper right corner of the chat window next to the close (**X**) button.
38+
39+
## Add context to a conversation
40+
41+
You can use the `@` symbol to specify a specific run in your prompt. For example, you can ask ARIA to analyze a specific run by including the run's name in your prompt:
42+
43+
```text title="User prompt"
44+
Analyze the run @run-20230615_123456-abcdefg and summarize the results
45+
```
46+
47+
## Add an image to a conversation
48+
49+
Click on the plus icon (`+`) in the lower left corner of the chat window to add an image to your conversation. You can then ask ARIA to analyze the image or provide information about it.
50+
51+
## Provide feedback
52+
53+
Click the thumbs up or thumbs down icon at the end of the response to provide feedback on ARIA's response. Your feedback helps W&B improve ARIA's performance and accuracy.
54+
55+
For information about how W&B handles data usage for ARIA, see [Governance and security](/aria/governance).

‎aria/governance.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "Governance and security"
3+
description: "Learn how W&B Admins can control how your organization's data is used by W&B's AI features like ARIA."
4+
---
5+
6+
<Info>
7+
**Smart features** control options are available for Enterprise and Pro accounts.
8+
</Info>
9+
10+
[W&B Admins](/platform/hosting/iam/access-management-intro#manage-users-and-teams-within-an-organization) can manage access to LLM-powered features and data sharing for performance improvement.
11+
12+
To toggle **Smart features** settings:
13+
14+
1. Navigate to the W&B App.
15+
1. In the upper right corner of the page, select the **User menu** dropdown. Within the **Account** section of the dropdown, select **Settings**.
16+
1. Within the **Settings** tab, select **Privacy**.
17+
1. Scroll to the **Smart features** section.
18+
1. Toggle the options according to your preferences. Changes are saved automatically.

0 commit comments

Comments
 (0)