Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
501 changes: 284 additions & 217 deletions docs.json

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions models/app/features/cascade-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can edit two main settings within **Line plots** settings: **Data** and **Di

| Line plot setting | Description |
| ----- | ----- |
| **X axis** | The scale of the x-axis in line plots. The x-axis is set to **Step** by default. See the proceeding table for the list of x-axis options. |
| **X axis** | The scale of the x-axis in line plots. The x-axis is set to **Step** by default. See the following table for the list of x-axis options. |
| **Range** | Minimum and maximum settings to display for x axis. |
| **Smoothing** | Change the smoothing on the line plot. For more information about smoothing, see [Smooth line plots](/models/app/features/panels/line-plot/smoothing/). |
| **Outliers** | Rescale to exclude outliers from the default plot min and max scale. |
Expand All @@ -79,7 +79,7 @@ For information on how to edit an individual line plot, see [Edit line panel set
</Note>


Within the **Display preferences** tab, you can toggle the proceeding settings:
Within the **Display preferences** tab, you can toggle the following settings:

| Display preference | Description |
| ----- | ----- |
Expand Down Expand Up @@ -110,7 +110,7 @@ From the dropdown, you can edit the following settings that apply to the entire
| **Sort panels A-Z** | Sort panels within a section alphabetically |
| **Rearrange panels** | Select and drag a panel within a section to manually order your panels |

The proceeding animation demonstrates how to rearrange panels within a section:
The following animation demonstrates how to rearrange panels within a section:

<Frame>
<img src="/images/app_ui/rearrange_panels.gif" alt="Rearranging panels" />
Expand Down
2 changes: 1 addition & 1 deletion models/app/features/panels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Share the link with the user or team. When they access the link, the panel opens
To return to a panel's workspace from full-screen mode, click the left-pointing arrow at the top of the page.

### Compose a panel's full-screen link programmatically
In certain situations, such as when [creating an automation](/models/automations/), it can be useful to include the panel's full-screen URL. This section shows the format for a panel's full-screen URL. In the proceeding example, replace the entity, project, panel, and section names in brackets.
In certain situations, such as when [creating an automation](/models/automations/), it can be useful to include the panel's full-screen URL. This section shows the format for a panel's full-screen URL. In the following example, replace the entity, project, panel, and section names in brackets.

```text
https://wandb.ai/<ENTITY_NAME>/<PROJECT_NAME>?panelDisplayName=<PANEL_NAME>&panelSectionName=<SECTON_NAME>
Expand Down
2 changes: 1 addition & 1 deletion models/app/features/panels/line-plot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Here is what the graph looks like before averaging:
<img src="/images/app_ui/demo_precision_lines.png" alt="Individual precision lines" />
</Frame>

The proceeding image shows a graph that represents average values across runs using grouped lines.
The following image shows a graph that represents average values across runs using grouped lines.

<Frame>
<img src="/images/app_ui/demo_average_precision_lines.png" alt="Averaged precision lines" />
Expand Down
2 changes: 1 addition & 1 deletion models/app/features/panels/line-plot/sampling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The shaded areas of a full-fidelity line plot can show:
```
- **None**: No shading (the default).

The proceeding image shows a blue line plot. The light blue shaded area represents the minimum and maximum values for each bucket.
The following image shows a blue line plot. The light blue shaded area represents the minimum and maximum values for each bucket.

<Frame>
<img src="/images/app_ui/shaded-areas.png" alt="Shaded confidence areas" />
Expand Down
2 changes: 1 addition & 1 deletion models/artifacts/artifacts-walkthrough.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ wandb.login()

## 2. Initialize a run

Use [`wandb.init()`](/models/ref/python/functions/init) to intialize a run. This generates a background process to sync and log data. Provide a project name and a job type:
Use [`wandb.init()`](/models/ref/python/functions/init) to initialize a run. This generates a background process to sync and log data. Provide a project name and a job type:

```python
# Create a W&B Run. Here we specify 'dataset' as the job type since this example
Expand Down
2 changes: 1 addition & 1 deletion models/artifacts/track-external-files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -275,4 +275,4 @@ Use the [`wandb artifact put`](/models/ref/cli/wandb-artifact/wandb-artifact-put
$ wandb artifact put --name project/artifact_name --type TYPE PATH
```

W&B will create a new project if a the project you specify does not exist. For information on how to download an artifact, see [Download and use artifacts](/models/artifacts/download-and-use-an-artifact). */}
W&B will create a new project if the project you specify does not exist. For information on how to download an artifact, see [Download and use artifacts](/models/artifacts/download-and-use-an-artifact). */}
10 changes: 5 additions & 5 deletions models/integrations/dagster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Find your W&B entity by checking the profile page for that user or team in the W
3. Set an environment variable for that API key: `export WANDB_API_KEY=YOUR_KEY`.


The proceeding examples demonstrate where to specify your API key in your Dagster code. Make sure to specify your entity and project name within the `wandb_config` nested dictionary. You can pass different `wandb_config` values to different ops/assets if you want to use a different W&B Project. For more information about possible keys you can pass, see the Configuration section below.
The following examples demonstrate where to specify your API key in your Dagster code. Make sure to specify your entity and project name within the `wandb_config` nested dictionary. You can pass different `wandb_config` values to different ops/assets if you want to use a different W&B Project. For more information about possible keys you can pass, see the Configuration section below.


<Tabs>
Expand Down Expand Up @@ -111,7 +111,7 @@ Note that we are configuring the IO Manager cache duration in this example contr


### Configuration
The proceeding configuration options are used as settings on the W&B-specific Dagster resource and IO Manager provided by the integration.
The following configuration options are used as settings on the W&B-specific Dagster resource and IO Manager provided by the integration.

* `wandb_resource`: Dagster [resource](https://docs.dagster.io/guides/build/external-resources) used to communicate with the W&B API. It automatically authenticates using the provided API key. Properties:
* `api_key`: (str, required): a W&B API key necessary to communicate with the W&B API.
Expand Down Expand Up @@ -155,7 +155,7 @@ Return an object from a Python function to write a W&B Artifact. The following o
* W&B objects (Table, Image, Graph…)
* W&B Artifact objects

The proceeding examples demonstrate how to write W&B Artifacts with Dagster assets (`@asset`):
The following examples demonstrate how to write W&B Artifacts with Dagster assets (`@asset`):


<Tabs>
Expand Down Expand Up @@ -227,7 +227,7 @@ For `@op`, it’s located in the output metadata through the [Out](https://docs.
For `@asset`, it’s located in the metadata argument on the asset.
For `@multi_asset`, it’s located in each output metadata through the [AssetOut](https://docs.dagster.io/_apidocs/assets#dagster.AssetOut) metadata arguments.

The proceeding code examples demonstrate how to configure a dictionary on an `@op`, `@asset` and `@multi_asset` computations:
The following code examples demonstrate how to configure a dictionary on an `@op`, `@asset` and `@multi_asset` computations:

<Tabs>
<Tab title="Example for @op">
Expand Down Expand Up @@ -503,7 +503,7 @@ def read_artifact(context, my_artifact):


### Configuration
The proceeding configuration is used to indicate what the IO Manager should collect and provide as inputs to the decorated functions. The following read patterns are supported.
The following configuration is used to indicate what the IO Manager should collect and provide as inputs to the decorated functions. The following read patterns are supported.

1. To get an named object contained within an Artifact use get:

Expand Down
10 changes: 5 additions & 5 deletions models/ref/python/public-api/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ You can use the returned `ArtifactCollection` object to retrieve information abo


**Examples:**
In the proceeding code snippet "type", "entity", "project", and "artifact_name" are placeholders for the collection type, your W&B entity, name of the project the artifact is in, and the name of the artifact, respectively.
In the following code snippet "type", "entity", "project", and "artifact_name" are placeholders for the collection type, your W&B entity, name of the project the artifact is in, and the name of the artifact, respectively.

```python
import wandb
Expand Down Expand Up @@ -217,7 +217,7 @@ Whether an artifact collection exists within a specified project and entity.


**Examples:**
In the proceeding code snippet "type", and "collection_name" refer to the type of the artifact collection and the name of the collection, respectively.
In the following code snippet "type", and "collection_name" refer to the type of the artifact collection and the name of the collection, respectively.

```python
import wandb
Expand Down Expand Up @@ -279,7 +279,7 @@ Whether an artifact version exists within the specified project and entity.


**Examples:**
In the proceeding code snippets "entity", "project", "artifact", "version", and "alias" are placeholders for your W&B entity, name of the project the artifact is in, the name of the artifact, and artifact's version, respectively.
In the following code snippets "entity", "project", "artifact", "version", and "alias" are placeholders for your W&B entity, name of the project the artifact is in, the name of the artifact, and artifact's version, respectively.

```python
import wandb
Expand Down Expand Up @@ -379,7 +379,7 @@ Return an `Artifacts` collection.


**Examples:**
In the proceeding code snippet, "type", "entity", "project", and "artifact_name" are placeholders for the artifact type, W&B entity, name of the project the artifact was logged to, and the name of the artifact, respectively.
In the following code snippet, "type", "entity", "project", and "artifact_name" are placeholders for the artifact type, W&B entity, name of the project the artifact was logged to, and the name of the artifact, respectively.

```python
import wandb
Expand Down Expand Up @@ -876,7 +876,7 @@ Return a run, sweep, project or report from a path.


**Examples:**
In the proceeding code snippets "project", "team", "run_id", "sweep_id", and "report_name" are placeholders for the project, team, run ID, sweep ID, and the name of a specific report, respectively.
In the following code snippets "project", "team", "run_id", "sweep_id", and "report_name" are placeholders for the project, team, run ID, sweep ID, and the name of a specific report, respectively.

```python
import wandb
Expand Down
2 changes: 1 addition & 1 deletion models/ref/python/public-api/user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This allows managing a user's API keys and accessing information like team membe

Names of the user's API keys.

This property returns the names of the the API keys, *not* the secret associated with the key. The name of the key cannot be used as an API key.
This property returns the names of the API keys, *not* the secret associated with the key. The name of the key cannot be used as an API key.

The list is empty if the user has no API keys or if API keys have not been loaded.

Expand Down
4 changes: 2 additions & 2 deletions models/ref/wandb_workspaces/workspaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ Panel layout settings for a section, typically seen at the top right of the sect
## <kbd>class</kbd> `SectionPanelSettings`
Panel settings for a section, similar to `WorkspaceSettings` for a section.

Settings applied here can be overrided by more granular Panel settings in this priority: Section < Panel.
Settings applied here can be overridden by more granular Panel settings in this priority: Section < Panel.



Expand Down Expand Up @@ -288,7 +288,7 @@ Settings for the workspace, typically seen at the top of the workspace in the UI

This object includes settings for the x-axis, smoothing, outliers, panels, tooltips, runs, and panel query bar.

Settings applied here can be overrided by more granular Section and Panel settings in this priority: Workspace < Section < Panel
Settings applied here can be overridden by more granular Section and Panel settings in this priority: Workspace < Section < Panel



Expand Down
4 changes: 2 additions & 2 deletions models/registry/download_use_artifact.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Once you know the properties of the artifact, you can [construct the path to the

To download an artifact linked to a registry, you must know the path of that linked artifact. The path consists of the registry name, collection name, and the alias or index of the artifact version you want to access.

Once you have the registry, collection, and alias or index of the artifact version, you can construct the path to the linked artifact using the proceeding string template:
Once you have the registry, collection, and alias or index of the artifact version, you can construct the path to the linked artifact using the following string template:

```python
# Artifact name with version index specified
Expand All @@ -25,7 +25,7 @@ f"wandb-registry-{REGISTRY}/{COLLECTION}:{ALIAS}"
Replace the values within the curly braces `{}` with the name of the registry, collection, and the alias or index of the artifact version you want to access.


Use the `wandb.Run.use_artifact()` method to access the artifact and download its contents once you have the path of the linked artifact. The proceeding code snippet shows how to use and download an artifact linked to the W&B Registry. Ensure to replace values within `<>` with your own:
Use the `wandb.Run.use_artifact()` method to access the artifact and download its contents once you have the path of the linked artifact. The following code snippet shows how to use and download an artifact linked to the W&B Registry. Ensure to replace values within `<>` with your own:

```python
import wandb
Expand Down
2 changes: 1 addition & 1 deletion models/registry/lineage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ To view a collection's action history:
3. Select the dropdown menu next to the collection name.
4. Select the **Action History** option.

{/* Select a run node to view that run's details, such as the run's ID, the run's name, the run's state, and more. As an example, the proceeding image shows information about the `rural-feather-20` run:
{/* Select a run node to view that run's details, such as the run's ID, the run's name, the run's state, and more. As an example, the following image shows information about the `rural-feather-20` run:



Expand Down
4 changes: 2 additions & 2 deletions models/registry/registry_cards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Add descriptions and documentation to W&B Registry collections to
Add human-friendly text to your collections to help users understand the purpose of the collection and the artifacts it contains.


Depending on the collection, you might want to include information about the training data, model architecture, task, license, references, and deployment. The proceeding lists some topics worth documenting in a collection:
Depending on the collection, you might want to include information about the training data, model architecture, task, license, references, and deployment. The following lists some topics worth documenting in a collection:



Expand Down Expand Up @@ -67,7 +67,7 @@ collection.save()
</Tab>
</Tabs>

For example, the proceeding image shows a collection that documents a model's architecture, intended use, performance information and more.
For example, the following image shows a collection that documents a model's architecture, intended use, performance information and more.

<Frame>
<img src="/images/registry/registry_card.png" alt="Collection card" />
Expand Down
14 changes: 7 additions & 7 deletions models/reports/edit-a-report.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Enter a forward slash (`/`) in the report to display a dropdown menu. Select **A
Add plots to a report programmatically with the SDK. Pass a list of one or more plot or chart objects to the `panels` parameter in the `PanelGrid` Public API Class. Create a plot or chart object with its associated Python Class.


The proceeding examples demonstrates how to create a line plot and scatter plot.
The following examples demonstrate how to create a line plot and scatter plot.

```python
import wandb
Expand Down Expand Up @@ -92,7 +92,7 @@ If you import a panel into a report, run names are inherited from the project. I
1. Click **Publish report**.
</Tab>
<Tab title="Report and Workspace API">
Add run sets from projects with the `wr.Runset()` and `wr.PanelGrid` Classes. The proceeding procedure describes how to add a runset:
Add run sets from projects with the `wr.Runset()` and `wr.PanelGrid` Classes. The following procedure describes how to add a runset:

1. Create a `wr.Runset()` object instance. Provide the name of the project that contains the run sets for the project parameter and the entity that owns the project for the entity parameter.
2. Create a `wr.PanelGrid()` object instance. Pass a list of one or more runset objects to the `run sets` parameter.
Expand Down Expand Up @@ -507,7 +507,7 @@ Select the name of the programming language on the right hand of the code block.
<Tab title="Report and Workspace API">
Use the `wr.CodeBlock` Class to create a code block programmatically. Provide the name of the language and the code you want to display for the language and code parameters, respectively.

For example the proceeding example demonstrates a list in YAML file:
For example the following example demonstrates a list in YAML file:

```python
import wandb
Expand Down Expand Up @@ -535,7 +535,7 @@ cool:
- file
```

The proceeding example demonstrates a Python code block:
The following example demonstrates a Python code block:

```python
report = wr.Report(project="report-editing")
Expand Down Expand Up @@ -594,7 +594,7 @@ Add HTML elements to your report interactively with the App UI or with the W&B S
Enter a forward slash (`/`) in the report to display a dropdown menu. From the dropdown select a type of text block. For example, to create an H2 heading block, select the `Heading 2` option.
</Tab>
<Tab title="Report and Workspace API">
Pass a list of one or more HTML elements to `wandb.apis.reports.blocks` attribute. The proceeding example demonstrates how to create an H1, H2, and an unordered list:
Pass a list of one or more HTML elements to `wandb.apis.reports.blocks` attribute. The following example demonstrates how to create an H1, H2, and an unordered list:

```python
import wandb
Expand Down Expand Up @@ -653,7 +653,7 @@ Copy and paste a SoundCloud link to embed an audio file into a report.
</Frame>
</Tab>
<Tab title="Report and Workspace API">
Pass a list of one or more embedded media objects to the `wandb.apis.reports.blocks` attribute. The proceeding example demonstrates how to embed video and Twitter media into a report:
Pass a list of one or more embedded media objects to the `wandb.apis.reports.blocks` attribute. The following example demonstrates how to embed video and Twitter media into a report:

```python
import wandb
Expand Down Expand Up @@ -690,7 +690,7 @@ Select a panel grid and press `delete` on your keyboard to delete a panel grid.

## Collapse headers to organize Reports

Collapse headers in a Report to hide content within a text block. When the report is loaded, only headers that are expanded will show content. Collapsing headers in reports can help organize your content and prevent excessive data loading. The proceeding gif demonstrates the process.
Collapse headers in a Report to hide content within a text block. When the report is loaded, only headers that are expanded will show content. Collapsing headers in reports can help organize your content and prevent excessive data loading. The following gif demonstrates the process.

<Frame>
<img src="/images/reports/collapse_headers.gif" alt="Collapsing headers in a report." />
Expand Down
4 changes: 2 additions & 2 deletions models/reports/embed-reports.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ Only **public** reports are viewable when embedded.

## Confluence

The proceeding animation demonstrates how to insert the direct link to the report within an IFrame cell in Confluence.
The following animation demonstrates how to insert the direct link to the report within an IFrame cell in Confluence.

<Frame>
<img src="/images/reports/embed_iframe_confluence.gif" alt="Embedding in Confluence" />
</Frame>

## Notion

The proceeding animation demonstrates how to insert a report into a Notion document using an Embed block in Notion and the report's embedded code.
The following animation demonstrates how to insert a report into a Notion document using an Embed block in Notion and the report's embedded code.

<Frame>
<img src="/images/reports/embed_iframe_notion.gif" alt="Embedding in Notion" />
Expand Down
Loading
Loading