Skip to content

Commit 8c49a56

Browse files
committed
Merge remote-tracking branch 'origin/main' into release-notes-to-hugo
2 parents c746605 + 2c23210 commit 8c49a56

48 files changed

Lines changed: 426 additions & 283 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/guides/models/track/log/distributed-training.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Parameters prefixed by `x_` (such as `x_label`) are in public preview. Create a
105105
{{% /alert %}}
106106

107107
{{% alert %}}
108-
To track multiple processes to a single run, you must have W&B Python SDK version `v0.19.5` or newer.
108+
To track multiple processes to a single run, you must have W&B Python SDK version `v0.19.9` or newer.
109109
{{% /alert %}}
110110

111111
In this approach you use a primary node and one or more worker nodes. Within the primary node you initialize a W&B run. For each worker node, initialize a run using the run ID used by the primary node. During training each worker node logs to the same run ID as the primary node. W&B aggregates metrics from all nodes and displays them in the W&B App UI.
@@ -268,4 +268,4 @@ For optimal experience we do recommend you upgrade to the latest version.
268268

269269
**W&B SDK 0.12.4 and below**
270270

271-
Set the `WANDB_START_METHOD` environment variable to `"thread"` to use multithreading instead if you use a W&B SDK version 0.12.4 and below.
271+
Set the `WANDB_START_METHOD` environment variable to `"thread"` to use multithreading instead if you use a W&B SDK version 0.12.4 and below.

content/guides/models/track/runs/_index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -505,8 +505,7 @@ The **Artifacts** tab lists the input and output [artifacts]({{< relref "/guides
505505

506506
{{< img src="/images/app_ui/artifacts_tab.png" alt="" >}}
507507

508-
View an example artifacts tab [here](https://wandb.ai/stacey/artifact_july_demo/runs/2cslp2rt/artifacts).
509-
508+
View [example artifact graphs]({{< relref "/guides/core/artifacts/explore-and-traverse-an-artifact-graph.md" >}}).
510509

511510
## Delete runs
512511

content/guides/quickstart.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ weight: 2
1010
---
1111
Install W&B to track, visualize, and manage machine learning experiments of any size.
1212

13+
{{% alert %}}
14+
Are you looking for information on W&B Weave? See the [Weave Python SDK quickstart](https://weave-docs.wandb.ai/quickstart) or [Weave TypeScript SDK quickstart](https://weave-docs.wandb.ai/reference/generated_typescript_docs/intro-notebook).
15+
{{% /alert %}}
16+
1317
## Sign up and create an API key
1418

1519
To authenticate your machine with W&B, generate an API key from your user profile or at [wandb.ai/authorize](https://wandb.ai/authorize). Copy the API key and store it securely.
@@ -41,6 +45,7 @@ pip install wandb
4145
```
4246
```python
4347
import wandb
48+
4449
wandb.login()
4550
```
4651

@@ -122,3 +127,4 @@ Explore more features of the W&B ecosystem:
122127
4. Automate hyperparameter searches and optimize models with [W&B Sweeps]({{< relref "/guides/models/sweeps/" >}}).
123128
5. Analyze runs, visualize model predictions, and share insights on a [central dashboard]({{< relref "/guides/models/tables/" >}}).
124129
6. Visit [W&B AI Academy](https://wandb.ai/site/courses/) to learn about LLMs, MLOps, and W&B Models through hands-on courses.
130+
7. Visit the [official W&B Weave documentation](https://weave-docs.wandb.ai/) to learn how to track track, experiment with, evaluate, deploy, and improve your LLM-based applications using Weave.

content/guides/weave/_index.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,29 @@ title: W&B Weave
66
weight: 4
77
---
88

9-
{{< cta-button colabLink="http://wandb.me/weave_colab" >}}
9+
{{% alert %}}
10+
Are you looking for the official Weave documentation? Head over to [https://weave-docs.wandb.ai/](https://weave-docs.wandb.ai/).
11+
{{% /alert %}}
1012

11-
Weave is a lightweight toolkit for tracking and evaluating LLM applications. Use W&B Weave to visualize and inspect the execution flow of your LLMs, analyze the inputs and outputs of your LLMs, view the intermediate results and securely store and manage your prompts and LLM chain configurations.
13+
W&B Weave is a framework for tracking, experimenting with, evaluating, deploying, and improving LLM-based applications. Designed for flexibility and scalability, Weave supports every stage of your LLM application development workflow:
1214

13-
{{< img src="/images/weave/weave-hero.png" alt="" >}}
15+
- **Tracing & Monitoring**: Track LLM calls and application logic to debug and analyze production systems.
16+
- **Systematic Iteration**: Refine and iterate on prompts, datasets and models.
17+
- **Experimentation**: Experiment with different models and prompts in the LLM Playground.
18+
- **Evaluation**: Use custom or pre-built scorers alongside our comparison tools to systematically assess and enhance application performance.
19+
- **Guardrails**: Protect your application with safeguards for content moderation, prompt safety, and more.
1420

15-
With W&B Weave, you can:
16-
* Log and debug language model inputs, outputs, and traces
17-
* Build rigorous, apples-to-apples evaluations for language model use cases
18-
* Organize all the information generated across the LLM workflow, from experimentation to evaluations to production
21+
## Get started with Weave
1922

20-
{{% alert %}}
21-
Looking for Weave docs? See the [W&B Weave Docs](https://weave-docs.wandb.ai/).
22-
{{% /alert %}}
23+
Are you new to Weave? Set up and start using Weave with the [Python quickstart](https://weave-docs.wandb.ai/quickstart) or [TypeScript quickstart](https://weave-docs.wandb.ai/reference/generated_typescript_docs/intro-notebook).
24+
25+
## Advanced guides
2326

24-
## How to get started
25-
Depending on your use case, explore the following resources to get started with W&B Weave:
27+
Learn more about advanced topics:
2628

27-
* [Quickstart: Track inputs and outputs of LLM calls](https://wandb.github.io/weave/quickstart)
28-
* [Build an Evaluation pipeline tutorial](https://wandb.github.io/weave/tutorial-eval)
29-
* [Model-Based Evaluation of RAG applications tutorial](https://wandb.github.io/weave/tutorial-rag)
29+
- [Integrations](https://weave-docs.wandb.ai/guides/integrations/): Use Weave with popular LLM providers, local models, frameworks, and third-party services.
30+
- [Cookbooks](https://weave-docs.wandb.ai/reference/gen_notebooks/intro_notebook): Build with Weave using Python and TypeScript. Tutorials are available as interactive notebooks.
31+
- [W&B AI Academy](https://www.wandb.courses/pages/w-b-courses): Build advanced RAG systems, improve LLM prompting, fine-tune LLMs, and more.
32+
- [Weave Python SDK](https://weave-docs.wandb.ai/reference/python-sdk/weave/)
33+
- [Weave TypeScript SDK](https://weave-docs.wandb.ai/reference/typescript-sdk/weave/)
34+
- [Weave Service API](https://weave-docs.wandb.ai/reference/service-api/call-start-call-start-post)

content/ref/python/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,6 @@ For reference documentation, see https://docs.wandb.com/ref/python.
4444

4545
| Other Members | |
4646
| :--- | :--- |
47-
| `__version__`<a id="__version__"></a> | `'0.19.9'` |
47+
| `__version__`<a id="__version__"></a> | `'0.19.10'` |
4848
| `config`<a id="config"></a> | |
4949
| `summary`<a id="summary"></a> | |

content/ref/python/agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: agent
33
---
44

5-
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/wandb_agent.py#L532-L576 >}}
5+
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/wandb_agent.py#L532-L576 >}}
66

77
Start one or more sweep agents.
88

content/ref/python/artifact.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Artifact
33
---
44

5-
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L85-L2444 >}}
5+
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L87-L2471 >}}
66

77
Flexible and lightweight building block for dataset and model versioning.
88

@@ -44,6 +44,7 @@ begin with `add`. Once the artifact has all the desired files, you can call
4444
| `digest` | The logical digest of the artifact. The digest is the checksum of the artifact's contents. If an artifact has the same digest as the current `latest` version, then `log_artifact` is a no-op. |
4545
| `entity` | The name of the entity of the secondary (portfolio) artifact collection. |
4646
| `file_count` | The number of files (including references). |
47+
| `history_step` | The nearest step at which history metrics were logged for the source run of the artifact. |
4748
| `id` | The artifact's ID. |
4849
| `manifest` | The artifact's manifest. The manifest lists all of its contents, and can't be changed once the artifact has been logged. |
4950
| `metadata` | User-defined artifact metadata. Structured data associated with the artifact. |
@@ -69,7 +70,7 @@ begin with `add`. Once the artifact has all the desired files, you can call
6970

7071
### `add`
7172

72-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1476-L1567)
73+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1503-L1594)
7374

7475
```python
7576
add(
@@ -97,7 +98,7 @@ Add wandb.WBValue `obj` to the artifact.
9798

9899
### `add_dir`
99100

100-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1331-L1391)
101+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1358-L1418)
101102

102103
```python
103104
add_dir(
@@ -124,7 +125,7 @@ Add a local directory to the artifact.
124125

125126
### `add_file`
126127

127-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1278-L1329)
128+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1305-L1356)
128129

129130
```python
130131
add_file(
@@ -159,7 +160,7 @@ Add a local file to the artifact.
159160

160161
### `add_reference`
161162

162-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1393-L1474)
163+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1420-L1501)
163164

164165
```python
165166
add_reference(
@@ -211,7 +212,7 @@ blank.
211212

212213
### `checkout`
213214

214-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2027-L2055)
215+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2050-L2078)
215216

216217
```python
217218
checkout(
@@ -238,7 +239,7 @@ artifact.
238239

239240
### `delete`
240241

241-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2165-L2184)
242+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2188-L2207)
242243

243244
```python
244245
delete(
@@ -261,7 +262,7 @@ source artifact is unaffected.
261262

262263
### `download`
263264

264-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1745-L1796)
265+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1772-L1818)
265266

266267
```python
267268
download(
@@ -292,11 +293,10 @@ the artifact.
292293
| Raises | |
293294
| :--- | :--- |
294295
| `ArtifactNotLoggedError` | If the artifact is not logged. |
295-
| `RuntimeError` | If the artifact is attempted to be downloaded in offline mode. |
296296

297297
### `file`
298298

299-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2097-L2121)
299+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2120-L2144)
300300

301301
```python
302302
file(
@@ -321,7 +321,7 @@ Download a single file artifact to the directory you specify with `root`.
321321

322322
### `files`
323323

324-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2123-L2140)
324+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2146-L2163)
325325

326326
```python
327327
files(
@@ -347,7 +347,7 @@ Iterate over all files stored in this artifact.
347347

348348
### `finalize`
349349

350-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L891-L899)
350+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L915-L923)
351351

352352
```python
353353
finalize() -> None
@@ -362,7 +362,7 @@ when you log the artifact with `log_artifact`.
362362

363363
### `get`
364364

365-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1662-L1707)
365+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1689-L1734)
366366

367367
```python
368368
get(
@@ -386,7 +386,7 @@ Get the WBValue object located at the artifact relative `name`.
386386

387387
### `get_added_local_path_name`
388388

389-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1709-L1721)
389+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1736-L1748)
390390

391391
```python
392392
get_added_local_path_name(
@@ -406,7 +406,7 @@ Get the artifact relative name of a file added by a local filesystem path.
406406

407407
### `get_entry`
408408

409-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1641-L1660)
409+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1668-L1687)
410410

411411
```python
412412
get_entry(
@@ -431,7 +431,7 @@ Get the entry with the given name.
431431

432432
### `get_path`
433433

434-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1633-L1639)
434+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1660-L1666)
435435

436436
```python
437437
get_path(
@@ -443,7 +443,7 @@ Deprecated. Use `get_entry(name)`.
443443

444444
### `is_draft`
445445

446-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L901-L906)
446+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L925-L930)
447447

448448
```python
449449
is_draft() -> bool
@@ -455,7 +455,7 @@ Returns: Boolean. `False` if artifact is saved. `True` if artifact is not saved.
455455

456456
### `json_encode`
457457

458-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2372-L2379)
458+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2399-L2406)
459459

460460
```python
461461
json_encode() -> dict[str, Any]
@@ -469,7 +469,7 @@ Returns the artifact encoded to the JSON format.
469469

470470
### `link`
471471

472-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2211-L2239)
472+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2234-L2266)
473473

474474
```python
475475
link(
@@ -491,7 +491,7 @@ Link this artifact to a portfolio (a promoted collection of artifacts).
491491

492492
### `logged_by`
493493

494-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2328-L2370)
494+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2355-L2397)
495495

496496
```python
497497
logged_by() -> (Run | None)
@@ -509,7 +509,7 @@ Get the W&B run that originally logged the artifact.
509509

510510
### `new_draft`
511511

512-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L413-L446)
512+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L417-L450)
513513

514514
```python
515515
new_draft() -> Artifact
@@ -531,7 +531,7 @@ modified and logged as a new version.
531531

532532
### `new_file`
533533

534-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1235-L1276)
534+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1262-L1303)
535535

536536
```python
537537
@contextlib.contextmanager
@@ -560,7 +560,7 @@ Open a new temporary file and add it to the artifact.
560560

561561
### `remove`
562562

563-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1603-L1631)
563+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1630-L1658)
564564

565565
```python
566566
remove(
@@ -581,7 +581,7 @@ Remove an item from the artifact.
581581

582582
### `save`
583583

584-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L911-L950)
584+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L935-L977)
585585

586586
```python
587587
save(
@@ -602,7 +602,7 @@ run, a run of type "auto" is created to track this artifact.
602602

603603
### `unlink`
604604

605-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2241-L2256)
605+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2268-L2283)
606606

607607
```python
608608
unlink() -> None
@@ -617,7 +617,7 @@ Unlink this artifact if it is currently a member of a portfolio (a promoted coll
617617

618618
### `used_by`
619619

620-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2282-L2326)
620+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2309-L2353)
621621

622622
```python
623623
used_by() -> list[Run]
@@ -635,7 +635,7 @@ Get a list of the runs that have used this artifact.
635635

636636
### `verify`
637637

638-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L2057-L2095)
638+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L2080-L2118)
639639

640640
```python
641641
verify(
@@ -659,7 +659,7 @@ cross-referenced against the artifact's manifest. References are not verified.
659659

660660
### `wait`
661661

662-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L960-L984)
662+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L987-L1011)
663663

664664
```python
665665
wait(
@@ -679,7 +679,7 @@ If needed, wait for this artifact to finish logging.
679679

680680
### `__getitem__`
681681

682-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1205-L1217)
682+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1232-L1244)
683683

684684
```python
685685
__getitem__(
@@ -703,7 +703,7 @@ Get the WBValue object located at the artifact relative `name`.
703703

704704
### `__setitem__`
705705

706-
[View source](https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/artifacts/artifact.py#L1219-L1233)
706+
[View source](https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/artifacts/artifact.py#L1246-L1260)
707707

708708
```python
709709
__setitem__(

content/ref/python/controller.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: controller
33
---
44

5-
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.19.9/wandb/sdk/wandb_sweep.py#L95-L119 >}}
5+
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.19.10/wandb/sdk/wandb_sweep.py#L95-L119 >}}
66

77
Public sweep controller constructor.
88

0 commit comments

Comments
 (0)