Skip to content

Commit 09267dd

Browse files
mdlinvillemdlinville
committed
Regenerate refs for 0.23.0
1 parent 447cf1b commit 09267dd

37 files changed

Lines changed: 587 additions & 648 deletions

‎docs.json‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -624,9 +624,9 @@
624624
"group": "wandb artifact",
625625
"pages": [
626626
{
627-
"group": "wandb artifact cache",
627+
"group": "artifact cache",
628628
"pages": [
629-
"models/ref/cli/wandb-artifact/wandb-artifact-cache/wandb-artifact-cache-cleanup"
629+
"models/ref/cli/wandb-artifact/wandb-artifact-cache-cleanup"
630630
]
631631
},
632632
"models/ref/cli/wandb-artifact/wandb-artifact-get",
@@ -637,6 +637,7 @@
637637
{
638638
"group": "wandb beta",
639639
"pages": [
640+
"models/ref/cli/wandb-beta/wandb-beta-leet",
640641
"models/ref/cli/wandb-beta/wandb-beta-sync"
641642
]
642643
},
@@ -654,15 +655,15 @@
654655
"models/ref/cli/wandb-job/wandb-job-list"
655656
]
656657
},
657-
"models/ref/cli/wandb-launch",
658-
"models/ref/cli/wandb-launch-agent",
659-
"models/ref/cli/wandb-launch-sweep",
658+
"models/ref/cli/wandb-local",
660659
"models/ref/cli/wandb-login",
660+
"models/ref/cli/wandb-off",
661661
"models/ref/cli/wandb-offline",
662+
"models/ref/cli/wandb-on",
662663
"models/ref/cli/wandb-online",
664+
"models/ref/cli/wandb-projects",
663665
"models/ref/cli/wandb-pull",
664666
"models/ref/cli/wandb-restore",
665-
"models/ref/cli/wandb-scheduler",
666667
{
667668
"group": "wandb server",
668669
"pages": [
@@ -2299,15 +2300,15 @@
22992300
{
23002301
"source": "/guides/integrations/pytorch",
23012302
"destination": "/models/integrations"
2302-
},
2303+
},
23032304
{
23042305
"source": "/guides/launch/:slug*",
23052306
"destination": "/platform/launch/:slug*"
23062307
},
23072308
{
23082309
"source": "/models/registry/model_registry/:slug*",
23092310
"destination": "/models/registry"
2310-
},
2311+
},
23112312
{
23122313
"source": "/guides/registry/:slug*",
23132314
"destination": "/models/registry/:slug*"
@@ -2490,4 +2491,4 @@
24902491
}
24912492
],
24922493
"baseUrl": "https://docs.wandb.ai"
2493-
}
2494+
}

‎models/ref/cli.mdx‎

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,52 @@ title: CLI overview
33
description: Use the W&B Command Line Interface (CLI) to log in, run jobs, execute sweeps, and more using shell commands
44
---
55

6-
**Usage**
6+
{/* AUTO-GENERATED CONTENT STARTS HERE */}
7+
{/* WARNING: Do not edit below this line. This content is auto-generated by scripts/cli-docs-generator.py */}
78

8-
`wandb [OPTIONS] COMMAND [ARGS]...`
9+
## Usage
910

11+
```bash
12+
wandb [OPTIONS] COMMAND [ARGS]...
13+
```
1014

15+
## Options
1116

12-
**Options**
13-
14-
| **Option** | **Description** |
17+
| Option | Description |
1518
| :--- | :--- |
16-
| `--version` | Show the version and exit. |
17-
19+
| `--version` | Show the version and exit. (default: False) |
1820

19-
**Commands**
21+
## Commands
2022

21-
| **Command** | **Description** |
23+
| Command | Description |
2224
| :--- | :--- |
2325
| [agent](/models/ref/cli/wandb-agent) | Run the W&B agent |
2426
| [artifact](/models/ref/cli/wandb-artifact) | Commands for interacting with artifacts |
2527
| [beta](/models/ref/cli/wandb-beta) | Beta versions of wandb CLI commands. |
2628
| [controller](/models/ref/cli/wandb-controller) | Run the W&B local sweep controller |
2729
| [disabled](/models/ref/cli/wandb-disabled) | Disable W&B. |
2830
| [docker](/models/ref/cli/wandb-docker) | Run your code in a docker container. |
29-
| [docker-run](/models/ref/cli/wandb-docker-run) | Wrap `docker run` and adds WANDB_API_KEY and WANDB_DOCKER... |
31+
| [docker-run](/models/ref/cli/wandb-docker-run) | Wrap `docker run` and adds WANDB_API_KEY and WANDB_DOCKER environment variables. |
3032
| [enabled](/models/ref/cli/wandb-enabled) | Enable W&B. |
3133
| [init](/models/ref/cli/wandb-init) | Configure a directory with Weights & Biases |
3234
| [job](/models/ref/cli/wandb-job) | Commands for managing and viewing W&B jobs |
3335
| [launch](/models/ref/cli/wandb-launch) | Launch or queue a W&B Job. |
3436
| [launch-agent](/models/ref/cli/wandb-launch-agent) | Run a W&B launch agent. |
3537
| [launch-sweep](/models/ref/cli/wandb-launch-sweep) | Run a W&B launch sweep (Experimental). |
36-
| [login](/models/ref/cli/wandb-login) | Login to Weights & Biases |
37-
| [offline](/models/ref/cli/wandb-offline) | Disable W&B sync |
38-
| [online](/models/ref/cli/wandb-online) | Enable W&B sync |
38+
| [local](/models/ref/cli/wandb-local) | Start a local W&B container (deprecated, see wandb server --help) |
39+
| [login](/models/ref/cli/wandb-login) | Verify and store your API key for authentication with W&B services. |
40+
| [off](/models/ref/cli/wandb-off) | No description available |
41+
| [offline](/models/ref/cli/wandb-offline) | Save data logged to W&B locally without uploading it to the cloud. |
42+
| [on](/models/ref/cli/wandb-on) | No description available |
43+
| [online](/models/ref/cli/wandb-online) | Undo `wandb offline`. |
44+
| [projects](/models/ref/cli/wandb-projects) | List projects |
3945
| [pull](/models/ref/cli/wandb-pull) | Pull files from Weights & Biases |
4046
| [restore](/models/ref/cli/wandb-restore) | Restore code, config and docker state for a run. |
4147
| [scheduler](/models/ref/cli/wandb-scheduler) | Run a W&B launch sweep scheduler (Experimental) |
4248
| [server](/models/ref/cli/wandb-server) | Commands for operating a local W&B server |
4349
| [status](/models/ref/cli/wandb-status) | Show configuration settings |
4450
| [sweep](/models/ref/cli/wandb-sweep) | Initialize a hyperparameter sweep. |
45-
| [sync](/models/ref/cli/wandb-sync) | Upload an offline training directory to W&B |
51+
| [sync](/models/ref/cli/wandb-sync) | Synchronize W&B run data to the cloud. |
4652
| [verify](/models/ref/cli/wandb-verify) | Checks and verifies local instance of W&B. |
4753

54+
{/* AUTO-GENERATED CONTENT ENDS HERE */}

‎models/ref/cli/wandb-agent.mdx‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
---
2-
title: "wandb agent"
2+
title: wandb agent
33
---
44

5-
**Usage**
5+
Run the W&B agent
66

7-
`wandb agent [OPTIONS] SWEEP_ID`
7+
## Usage
88

9-
**Summary**
9+
```bash
10+
wandb agent SWEEP_ID [OPTIONS]
11+
```
1012

11-
Run the W&B agent
13+
## Arguments
1214

15+
| Argument | Description | Required |
16+
| :--- | :--- | :--- |
17+
| `SWEEP_ID` | No description available | Yes |
1318

14-
**Options**
19+
## Options
1520

16-
| **Option** | **Description** |
21+
| Option | Description |
1722
| :--- | :--- |
18-
| `-p, --project` | The name of the project where W&B runs created from the sweep are sent to. If the project is not specified, the run is sent to a project labeled 'Uncategorized'. |
19-
| `-e, --entity` | The username or team name where you want to send W&B runs created by the sweep to. Ensure that the entity you specify already exists. If you don't specify an entity, the run will be sent to your default entity, which is usually your username. |
23+
| `--project`, `-p` | The name of the project where W&B runs created from the sweep are sent to. If the project is not specified, the run is sent to a project labeled 'Uncategorized'. |
24+
| `--entity`, `-e` | The username or team name where you want to send W&B runs created by the sweep to. Ensure that the entity you specify already exists. If you don't specify an entity, the run will be sent to your default entity, which is usually your username. |
2025
| `--count` | The max number of runs for this agent. |
21-
22-
23-

‎models/ref/cli/wandb-artifact.mdx‎

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,20 @@
1-
---
2-
title: wandb artifact
3-
---
4-
5-
**Usage**
6-
7-
`wandb artifact [OPTIONS] COMMAND [ARGS]...`
8-
9-
**Summary**
10-
11-
Commands for interacting with artifacts
12-
13-
14-
**Options**
15-
16-
| **Option** | **Description** |
17-
| :--- | :--- |
18-
19-
20-
**Commands**
21-
22-
| **Command** | **Description** |
23-
| :--- | :--- |
24-
| cache | Commands for interacting with the artifact cache |
25-
| get | Download an artifact from wandb |
26-
| ls | List all artifacts in a wandb project |
27-
| put | Upload an artifact to wandb |
28-
1+
---
2+
title: wandb artifact
3+
---
4+
5+
Commands for interacting with artifacts
6+
7+
## Usage
8+
9+
```bash
10+
wandb artifact COMMAND [ARGS]...
11+
```
12+
13+
## Commands
14+
15+
| Command | Description |
16+
| :--- | :--- |
17+
| [cache](/models/ref/cli/wandb-artifact/wandb-artifact-cache) | Commands for interacting with the artifact cache |
18+
| [get](/models/ref/cli/wandb-artifact/wandb-artifact-get) | Download an artifact from wandb |
19+
| [ls](/models/ref/cli/wandb-artifact/wandb-artifact-ls) | List all artifacts in a wandb project |
20+
| [put](/models/ref/cli/wandb-artifact/wandb-artifact-put) | Upload an artifact to wandb |

‎models/ref/cli/wandb-artifact/wandb-artifact-cache.mdx‎

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
1-
---
2-
title: wandb artifact cache
3-
---
4-
5-
**Usage**
6-
7-
`wandb artifact cache [OPTIONS] COMMAND [ARGS]...`
8-
9-
**Summary**
10-
11-
Commands for interacting with the artifact cache
12-
13-
14-
**Options**
15-
16-
| **Option** | **Description** |
17-
| :--- | :--- |
18-
19-
20-
**Commands**
21-
22-
| **Command** | **Description** |
23-
| :--- | :--- |
24-
| cleanup | Clean up less frequently used files from the artifacts cache |
25-
1+
---
2+
title: wandb artifact cache
3+
---
4+
5+
Commands for interacting with the artifact cache
6+
7+
## Usage
8+
9+
```bash
10+
wandb artifact cache COMMAND [ARGS]...
11+
```
12+
13+
## Commands
14+
15+
| Command | Description |
16+
| :--- | :--- |
17+
| [cleanup](/models/ref/cli/wandb-artifact/wandb-artifact-cache/wandb-artifact-cache-cleanup) | Clean up less frequently used files from the artifacts cache |

‎models/ref/cli/wandb-artifact/wandb-artifact-cache/wandb-artifact-cache-cleanup.mdx‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
---
2-
title: "wandb artifact cache cleanup"
2+
title: wandb artifact cache cleanup
33
---
44

5-
**Usage**
6-
7-
`wandb artifact cache cleanup [OPTIONS] TARGET_SIZE`
8-
9-
**Summary**
10-
115
Clean up less frequently used files from the artifacts cache
126

7+
## Usage
138

14-
**Options**
9+
```bash
10+
wandb cleanup TARGET_SIZE [OPTIONS]
11+
```
1512

16-
| **Option** | **Description** |
17-
| :--- | :--- |
18-
| `--remove-temp / --no-remove-temp` | Remove temp files |
13+
## Arguments
1914

15+
| Argument | Description | Required |
16+
| :--- | :--- | :--- |
17+
| `TARGET_SIZE` | No description available | Yes |
2018

19+
## Options
2120

21+
| Option | Description |
22+
| :--- | :--- |
23+
| `--remove-temp` | Remove temp files (default: False) |

‎models/ref/cli/wandb-artifact/wandb-artifact-get.mdx‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
---
2-
title: "wandb artifact get"
2+
title: wandb artifact get
33
---
44

5-
**Usage**
5+
Download an artifact from wandb
66

7-
`wandb artifact get [OPTIONS] PATH`
7+
## Usage
88

9-
**Summary**
9+
```bash
10+
wandb get PATH [OPTIONS]
11+
```
1012

11-
Download an artifact from wandb
13+
## Arguments
1214

15+
| Argument | Description | Required |
16+
| :--- | :--- | :--- |
17+
| `PATH` | No description available | Yes |
1318

14-
**Options**
19+
## Options
1520

16-
| **Option** | **Description** |
21+
| Option | Description |
1722
| :--- | :--- |
1823
| `--root` | The directory you want to download the artifact to |
1924
| `--type` | The type of artifact you are downloading |
20-
21-
22-

‎models/ref/cli/wandb-artifact/wandb-artifact-ls.mdx‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
---
2-
title: "wandb artifact ls"
2+
title: wandb artifact ls
33
---
44

5-
**Usage**
6-
7-
`wandb artifact ls [OPTIONS] PATH`
8-
9-
**Summary**
10-
115
List all artifacts in a wandb project
126

7+
## Usage
138

14-
**Options**
9+
```bash
10+
wandb ls PATH [OPTIONS]
11+
```
1512

16-
| **Option** | **Description** |
17-
| :--- | :--- |
18-
| `-t, --type` | The type of artifacts to list |
13+
## Arguments
1914

15+
| Argument | Description | Required |
16+
| :--- | :--- | :--- |
17+
| `PATH` | No description available | Yes |
2018

19+
## Options
2120

21+
| Option | Description |
22+
| :--- | :--- |
23+
| `--type`, `-t` | The type of artifacts to list |

0 commit comments

Comments
 (0)