Skip to content

Commit ce35d57

Browse files
Update reference docs to sdk@v0.20.1, core@master (#1370)
Used wandb/wandb@ac7f2ca Co-authored-by: github-actions[bot]x <41898282+github-actions[bot]@users.noreply.github.com>
1 parent cbcf0e7 commit ce35d57

44 files changed

Lines changed: 265 additions & 265 deletions

Some content is hidden

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

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.20.0'` |
47+
| `__version__`<a id="__version__"></a> | `'0.20.1'` |
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.20.0/wandb/wandb_agent.py#L529-L573 >}}
5+
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/wandb_agent.py#L529-L573 >}}
66

77
Start one or more sweep agents.
88

content/ref/python/artifact.md

Lines changed: 29 additions & 29 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.20.0/wandb/sdk/artifacts/artifact.py#L124-L2658 >}}
5+
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L124-L2658 >}}
66

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

@@ -75,7 +75,7 @@ begin with `add`. Once the artifact has all the desired files, you can call
7575

7676
### `add`
7777

78-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1593-L1685)
78+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1593-L1685)
7979

8080
```python
8181
add(
@@ -103,7 +103,7 @@ Add wandb.WBValue `obj` to the artifact.
103103

104104
### `add_dir`
105105

106-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1442-L1508)
106+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1442-L1508)
107107

108108
```python
109109
add_dir(
@@ -132,7 +132,7 @@ Add a local directory to the artifact.
132132

133133
### `add_file`
134134

135-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1389-L1440)
135+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1389-L1440)
136136

137137
```python
138138
add_file(
@@ -167,7 +167,7 @@ Add a local file to the artifact.
167167

168168
### `add_reference`
169169

170-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1510-L1591)
170+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1510-L1591)
171171

172172
```python
173173
add_reference(
@@ -219,7 +219,7 @@ blank.
219219

220220
### `checkout`
221221

222-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2153-L2181)
222+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2153-L2181)
223223

224224
```python
225225
checkout(
@@ -246,7 +246,7 @@ artifact.
246246

247247
### `delete`
248248

249-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2289-L2313)
249+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2289-L2313)
250250

251251
```python
252252
delete(
@@ -271,7 +271,7 @@ Use `artifact.unlink()` instead of `artifact.delete()` to remove a link between
271271

272272
### `download`
273273

274-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1863-L1915)
274+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1863-L1915)
275275

276276
```python
277277
download(
@@ -307,7 +307,7 @@ the artifact.
307307

308308
### `file`
309309

310-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2221-L2245)
310+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2221-L2245)
311311

312312
```python
313313
file(
@@ -332,7 +332,7 @@ Download a single file artifact to the directory you specify with `root`.
332332

333333
### `files`
334334

335-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2247-L2264)
335+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2247-L2264)
336336

337337
```python
338338
files(
@@ -358,7 +358,7 @@ Iterate over all files stored in this artifact.
358358

359359
### `finalize`
360360

361-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1062-L1070)
361+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1062-L1070)
362362

363363
```python
364364
finalize() -> None
@@ -373,7 +373,7 @@ when you log the artifact with `log_artifact`.
373373

374374
### `get`
375375

376-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1780-L1825)
376+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1780-L1825)
377377

378378
```python
379379
get(
@@ -397,7 +397,7 @@ Get the WBValue object located at the artifact relative `name`.
397397

398398
### `get_added_local_path_name`
399399

400-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1827-L1839)
400+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1827-L1839)
401401

402402
```python
403403
get_added_local_path_name(
@@ -417,7 +417,7 @@ Get the artifact relative name of a file added by a local filesystem path.
417417

418418
### `get_entry`
419419

420-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1759-L1778)
420+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1759-L1778)
421421

422422
```python
423423
get_entry(
@@ -442,7 +442,7 @@ Get the entry with the given name.
442442

443443
### `get_path`
444444

445-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1751-L1757)
445+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1751-L1757)
446446

447447
```python
448448
get_path(
@@ -454,7 +454,7 @@ Deprecated. Use `get_entry(name)`.
454454

455455
### `is_draft`
456456

457-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1072-L1077)
457+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1072-L1077)
458458

459459
```python
460460
is_draft() -> bool
@@ -466,7 +466,7 @@ Returns: Boolean. `False` if artifact is saved. `True` if artifact is not saved.
466466

467467
### `json_encode`
468468

469-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2520-L2527)
469+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2520-L2527)
470470

471471
```python
472472
json_encode() -> dict[str, Any]
@@ -480,7 +480,7 @@ Returns the artifact encoded to the JSON format.
480480

481481
### `link`
482482

483-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2340-L2382)
483+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2340-L2382)
484484

485485
```python
486486
link(
@@ -506,7 +506,7 @@ Link this artifact to a portfolio (a promoted collection of artifacts).
506506

507507
### `logged_by`
508508

509-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2476-L2518)
509+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2476-L2518)
510510

511511
```python
512512
logged_by() -> (Run | None)
@@ -524,7 +524,7 @@ Get the W&B run that originally logged the artifact.
524524

525525
### `new_draft`
526526

527-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L473-L506)
527+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L473-L506)
528528

529529
```python
530530
new_draft() -> Artifact
@@ -546,7 +546,7 @@ modified and logged as a new version.
546546

547547
### `new_file`
548548

549-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1346-L1387)
549+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1346-L1387)
550550

551551
```python
552552
@contextlib.contextmanager
@@ -575,7 +575,7 @@ Open a new temporary file and add it to the artifact.
575575

576576
### `remove`
577577

578-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1721-L1749)
578+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1721-L1749)
579579

580580
```python
581581
remove(
@@ -596,7 +596,7 @@ Remove an item from the artifact.
596596

597597
### `save`
598598

599-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1082-L1122)
599+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1082-L1122)
600600

601601
```python
602602
save(
@@ -617,7 +617,7 @@ run, a run of type "auto" is created to track this artifact.
617617

618618
### `unlink`
619619

620-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2384-L2399)
620+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2384-L2399)
621621

622622
```python
623623
unlink() -> None
@@ -632,7 +632,7 @@ Unlink this artifact if it is currently a member of a portfolio (a promoted coll
632632

633633
### `used_by`
634634

635-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2430-L2474)
635+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2430-L2474)
636636

637637
```python
638638
used_by() -> list[Run]
@@ -650,7 +650,7 @@ Get a list of the runs that have used this artifact and its linked artifacts.
650650

651651
### `verify`
652652

653-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L2183-L2219)
653+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L2183-L2219)
654654

655655
```python
656656
verify(
@@ -674,7 +674,7 @@ cross-referenced against the artifact's manifest. References are not verified.
674674

675675
### `wait`
676676

677-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1132-L1156)
677+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1132-L1156)
678678

679679
```python
680680
wait(
@@ -694,7 +694,7 @@ If needed, wait for this artifact to finish logging.
694694

695695
### `__getitem__`
696696

697-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1316-L1328)
697+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1316-L1328)
698698

699699
```python
700700
__getitem__(
@@ -718,7 +718,7 @@ Get the WBValue object located at the artifact relative `name`.
718718

719719
### `__setitem__`
720720

721-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/artifacts/artifact.py#L1330-L1344)
721+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/artifacts/artifact.py#L1330-L1344)
722722

723723
```python
724724
__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.20.0/wandb/sdk/wandb_sweep.py#L95-L119 >}}
5+
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/wandb_sweep.py#L95-L119 >}}
66

77
Public sweep controller constructor.
88

content/ref/python/data-types/audio.md

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

5-
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/data_types/audio.py#L17-L172 >}}
5+
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/data_types/audio.py#L17-L172 >}}
66

77
Wandb class for audio clips.
88

@@ -24,7 +24,7 @@ Audio(
2424

2525
### `durations`
2626

27-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/data_types/audio.py#L130-L132)
27+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/data_types/audio.py#L130-L132)
2828

2929
```python
3030
@classmethod
@@ -35,15 +35,15 @@ durations(
3535

3636
### `resolve_ref`
3737

38-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/data_types/audio.py#L146-L158)
38+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/data_types/audio.py#L146-L158)
3939

4040
```python
4141
resolve_ref()
4242
```
4343

4444
### `sample_rates`
4545

46-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/data_types/audio.py#L134-L136)
46+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/data_types/audio.py#L134-L136)
4747

4848
```python
4949
@classmethod

content/ref/python/data-types/boundingboxes2d.md

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

5-
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/data_types/helper_types/bounding_boxes_2d.py#L28-L329 >}}
5+
{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/data_types/helper_types/bounding_boxes_2d.py#L28-L329 >}}
66

77
Format images with 2D bounding box overlays for logging to W&B.
88

@@ -136,7 +136,7 @@ run.log({"driving_scene": table})
136136

137137
### `type_name`
138138

139-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/data_types/helper_types/bounding_boxes_2d.py#L249-L251)
139+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/data_types/helper_types/bounding_boxes_2d.py#L249-L251)
140140

141141
```python
142142
@classmethod
@@ -145,7 +145,7 @@ type_name() -> str
145145

146146
### `validate`
147147

148-
[View source](https://www.github.com/wandb/wandb/tree/v0.20.0/wandb/sdk/data_types/helper_types/bounding_boxes_2d.py#L253-L310)
148+
[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/sdk/data_types/helper_types/bounding_boxes_2d.py#L253-L310)
149149

150150
```python
151151
validate(

0 commit comments

Comments
 (0)