Skip to content
Closed
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
4 changes: 2 additions & 2 deletions inference/lora.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ resp = client.chat.completions.create(
print(resp.choices[0].message.content)
```

Check out this [getting started notebook](https://wandb.me/lora_nb) for an interactive demonstration of how to create a LoRA and upload it to W&B as an artifact.
See this [getting started notebook](https://wandb.me/lora_nb) for an interactive demonstration of how to create a LoRA and upload it to W&B as an artifact.

## Prerequisites

Expand Down Expand Up @@ -104,7 +104,7 @@ Once your LoRA has been added to your project as an artifact, use the artifact's
model_name = f"wandb-artifact:///{WB_TEAM}/{WB_PROJECT}/your_trained_lora:latest"
```

## Supported Base Models
## Supported base models

Inference currently supports the following LLMs (use the exact strings in `wandb.base_model`). More models coming soon:

Expand Down
2 changes: 1 addition & 1 deletion models/app/features/cascade-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To edit settings that apply to the overall structure of this workspace:

1. Navigate to your project workspace.
2. Click the gear icon next to the **New report** button to view the workspace settings.
3. Choose **Workspace layout** to change the workspace's layout, or choose **Line plots** to configure default settings for line plots in the workspace.
3. Select **Workspace layout** to change the workspace's layout, or select **Line plots** to configure default settings for line plots in the workspace.
<Frame>
<img src="/images/app_ui/workspace_settings.png" alt="Workspace settings gear icon" />
</Frame>
Expand Down
2 changes: 1 addition & 1 deletion models/app/features/custom-charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Click **Edit** at the top of the panel to go into [Vega](https://vega.github.io/

**Field references**

To pull data into your chart from W&B, add template strings of the form `"${field:<field-name>}"` anywhere in your Vega spec. This will create a dropdown in the **Chart Fields** area on the right side, which users can use to select a query result column to map into Vega.
To pull data into your chart from W&B, add template strings of the form `"${field:<field-name>}"` anywhere in your Vega spec. This creates a dropdown in the **Chart Fields** area on the right side, which you can use to select a query result column to map into Vega.

To set a default value for a field, use this syntax: `"${field:<field-name>:<placeholder text>}"`

Expand Down
2 changes: 1 addition & 1 deletion models/app/features/custom-charts/walkthrough.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ with wandb.init() as run:

## 2. Create a query

Once you've logged data to visualize, go to your project page and click the **`+`** button to add a new panel, then select **Custom Chart**. You can follow along in the [custom charts demo workspace](https://app.wandb.ai/demo-team/custom-charts).
Once you've logged data to visualize, navigate to your project page and click the **`+`** button to add a new panel, then select **Custom Chart**. You can follow along in the [custom charts demo workspace](https://app.wandb.ai/demo-team/custom-charts).

<Frame>
<img src="/images/app_ui/create_a_query.png" alt="Blank custom chart" />
Expand Down
6 changes: 3 additions & 3 deletions models/app/features/panels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To configure the workspace layout, click **Settings** near the top of the worksp
- **Sort panels alphabetically** (turned off by default)
- **Section organization** (grouped by first prefix by default). To modify this setting:
1. Click the padlock icon.
1. Choose how to group panels within a section.
1. Select how to group panels within a section.

To configure defaults for the workspace's line plots, refer to [Line plots](/models/app/features/panels/line-plot/).

Expand Down Expand Up @@ -133,7 +133,7 @@ To get the code to embed or share a panel on social media:
1. From the workspace, hover over the panel, then click its action menu `...`.
1. Click the **Share** tab.
1. Change **Only those who are invited have access** to **Anyone with the link can view**. Otherwise, the choices in the next step are not available.
1. Choose **Share on Twitter**, **Share on Reddit**, **Share on LinkedIn**, or **Copy embed link**.
1. Select **Share on Twitter**, **Share on Reddit**, **Share on LinkedIn**, or **Copy embed link**.

### Email a panel report
To email a single panel as a stand-alone report:
Expand Down Expand Up @@ -208,7 +208,7 @@ Sections with a large number of panels are paginated by default. The default num
1. To resize a panel, hover over it, click the drag handle, and drag it to adjust the panel's size. Resizing one panel resizes all panels in the section.
1. If a section is paginated, you can customize the number of panels to show on a page:
1. At the top of the section, click **1 to `<X>` of `<Y>`**, where `<X>` is the number of visible panels and `<Y>` is the total number of panels.
1. Choose how many panels to show per page, up to 100.
1. Select how many panels to show per page, up to 100.
1. To delete a panel from a section:
1. Hover over the panel, then click its action `...` menu.
1. Click **Delete**.
Expand Down
4 changes: 2 additions & 2 deletions models/app/features/panels/line-plot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ with wandb.init() as run:

## Change the colors of the lines

Sometimes the default color of runs is not helpful for comparison. To help overcome this, wandb provides two instances with which one can manually change the colors.
Sometimes the default color of runs is not helpful for comparison. To help overcome this, W&B provides two ways to manually change the colors.

<Tabs>
<Tab title="From the run table">
Expand All @@ -192,7 +192,7 @@ Each run is given a random color by default upon initialization.
1. Navigate to your workspace.
1. Hover your mouse over the panel you want to edit its settings for.
1. Select the pencil icon that appears.
1. Choose the **Legend** tab.
1. Select the **Legend** tab.

<Frame>
<img src="/images/app_ui/plot_style_line_plot_legend.png" alt="Line plot legend settings" />
Expand Down
8 changes: 4 additions & 4 deletions models/app/features/panels/line-plot/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Available y-axis options:

### Point aggregation method

Choose the sampling mode for displaying data points:
Select the sampling mode for displaying data points:
* **Random sampling** (default): See [Random sampling](/models/app/features/panels/line-plot/sampling/#random-sampling).
* **Full fidelity**: See [Full fidelity](/models/app/features/panels/line-plot/sampling/#full-fidelity).

Expand Down Expand Up @@ -69,7 +69,7 @@ A workspace is limited to displaying a maximum of 1000 runs, regardless of its c

### Chart type

Choose the plot style:
Select the plot style:
- **Line plot**
<Frame>
<img src="/images/app_ui/plot_style_line_plot.png" alt="Line plot style" />
Expand Down Expand Up @@ -110,7 +110,7 @@ Customize the legend to show any config value logged and metadata from the runs,
Define a template for the legend name.

1. Click the gear icon to open the plot settings.
1. Go to the **Display preferences** tab.
1. Navigate to the **Display preferences** tab.
1. Expand **Advanced legend**, then specify the legend template.
1. Click **Apply**.

Expand All @@ -123,7 +123,7 @@ Example:
Set values inside `[[ ]]` to display point-specific values in the crosshair when hovering over a chart.

1. Click the gear icon to open the plot settings.
1. Go to the **Display preferences** tab.
1. Navigate to the **Display preferences** tab.
1. At the bottom of the tab, configure point-specific values for one or more of the plot's metrics.
1. Click **Apply**.

Expand Down
4 changes: 2 additions & 2 deletions models/app/features/panels/line-plot/sampling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ W&B uses full fidelity mode by default. To configure it manually, follow these s
1. Navigate to your workspace.
3. Select the gear icon on the top right corner of the screen next to the left of the **Add panels** button.
4. From the UI slider that appears, select **Line plots**
5. Choose **Full fidelity** from the **Point aggregation** section.
5. Select **Full fidelity** from the **Point aggregation** section.
6. Configure the **Smoothing** algorithm and settings.
7. Set **Aggregation** to **Mean**, **Min**, or **Max**.
8. Click **Apply**.
Expand Down Expand Up @@ -128,7 +128,7 @@ By default, W&B uses full fidelity mode. To enable random sampling, follow these
2. Select on the **Workspace** icon on the left tab
3. Select the gear icon on the top right corner of the screen next to the left of the **Add panels** button.
4. From the UI slider that appears, select **Line plots**
5. Choose **Random sampling** from the **Point aggregation** section
5. Select **Random sampling** from the **Point aggregation** section
</Tab>
<Tab title="Individual chart in a workspace">
1. Navigate to your W&B project
Expand Down
4 changes: 2 additions & 2 deletions models/app/features/panels/parameter-importance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ Discover which of your hyperparameters were the best predictors of, and highly c

Therefore W&B also calculates an **importance** metric. W&B trains a random forest with the hyperparameters as inputs and the metric as the target output and report the feature importance values for the random forest.

The idea for this technique was inspired by a conversation with [Jeremy Howard](https://twitter.com/jeremyphoward) who has pioneered the use of random forest feature importances to explore hyperparameter spaces at [Fast.ai](https://fast.ai). W&B highly recommends you check out this [lecture](https://course18.fast.ai/lessonsml1/lesson4.html) (and these [notes](https://forums.fast.ai/t/wiki-lesson-thread-lesson-4/7540)) to learn more about the motivation behind this analysis.
The idea for this technique was inspired by a conversation with [Jeremy Howard](https://twitter.com/jeremyphoward) who has pioneered the use of random forest feature importances to explore hyperparameter spaces at [Fast.ai](https://fast.ai). W&B highly recommends you see this [lecture](https://course18.fast.ai/lessonsml1/lesson4.html) (and these [notes](https://forums.fast.ai/t/wiki-lesson-thread-lesson-4/7540)) to learn more about the motivation behind this analysis.

Hyperparameter importance panel untangles the complicated interactions between highly correlated hyperparameters. In doing so, it helps you fine tune your hyperparameter searches by showing you which of your hyperparameters matter the most in terms of predicting model performance.

## Creating a hyperparameter importance panel

1. Navigate to your W&B project.
2. Select **Add panels** button.
3. Expand the **CHARTS** dropdown, choose **Parallel coordinates** from the dropdown.
3. Expand the **CHARTS** dropdown, select **Parallel coordinates** from the dropdown.


<Note>
Expand Down
2 changes: 1 addition & 1 deletion models/artifacts/delete-artifacts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ To delete an artifact version:
2. Select the **Artifacts** tab.
3. From the list of artifact types, select the type of artifact that contains the version you want to delete.
4. Click the three horizontal dots (`...`) next to the artifact version you want to delete.
5. From the dropdown, choose **Delete Version**.
5. From the dropdown, select **Delete Version**.

</Tab>
<Tab title="W&B Python SDK" value="sdk">
Expand Down
12 changes: 6 additions & 6 deletions models/automations/create-automations/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ At a high level, to create a Slack automation, you take these steps:
## Add a Slack integration
A team admin can add a Slack integration to the team.

1. Log in to W&B and go to **Team Settings**.
1. Log in to W&B and navigate to **Team Settings**.
1. In the **Slack channel integrations** section, click **Connect Slack** to add a new Slack instance. To add a channel for an existing Slack instance, click **New integration**.

![Screenshot showing two Slack integrations in a Team](/images/automations/slack_integrations.png)
1. If necessary, sign in to Slack in your browser. When prompted, grant W&B permission to post to the Slack channel you select. Read the page, then click **Search for a channel** and begin typing the channel name. Select the channel from the list, then click **Allow**.
1. In Slack, go to the channel you selected. If you see a post like `[Your Slack handle] added an integration to this channel: Weights & Biases`, the integration is configured correctly.
1. If necessary, log in to Slack in your browser. When prompted, grant W&B permission to post to the Slack channel you select. Read the page, then click **Search for a channel** and begin typing the channel name. Select the channel from the list, then click **Allow**.
1. In Slack, navigate to the channel you selected. If you see a post like `[Your Slack handle] added an integration to this channel: Weights & Biases`, the integration is configured correctly.

Now you can [create an automation](#create-an-automation) that notifies the Slack channel you configured.

## View and manage Slack integrations
A team admin can view and manage the team's Slack instances and channels.

1. Log in to W&B and go to **Team Settings**.
1. Log in to W&B and navigate to **Team Settings**.
1. View each Slack destination in the **Slack channel integrations** section.
1. Delete a destination by clicking its trash icon.

Expand All @@ -38,7 +38,7 @@ A Registry admin can create automations in that registry.
1. Log in to W&B.
1. Click the name of a registry to view its details,
1. To create an automation scoped to the registry, click the **Automations** tab, then click **Create automation**. An automation that is scoped to a registry is automatically applied to all of its collections (including those created in the future).
1. Choose the [event](/models/automations/automation-events/#registry-events) to watch for.
1. Select the [event](/models/automations/automation-events/#registry-events) to watch for.

Fill in any additional fields that appear, which depend upon the event. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**.

Expand All @@ -58,7 +58,7 @@ A W&B admin can create automations in a project.
<Frame>
<img src="/images/automations/run_metric_automation_from_panel.png" alt="Automation bell icon location" />
</Frame>
1. Choose the [event](/models/automations/automation-events/#project) to watch for.
1. Select the [event](/models/automations/automation-events/#project) to watch for.

1. Fill in any additional fields that appear. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**.

Expand Down
10 changes: 5 additions & 5 deletions models/automations/create-automations/webhook.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A team admin can add a webhook for the team.
If the webhook requires a Bearer token or its payload requires a sensitive string, [create a secret that contains it](/platform/secrets/#add-a-secret) before creating the webhook. You can configure at most one access token and one other secret for a webhook. Your webhook's authentication and authorization requirements are determined by the webhook's service.
</Note>

1. Log in to W&B and go to **Team Settings** page.
1. Log in to W&B and navigate to the **Team Settings** page.
1. In the **Webhooks** section, click **New webhook**.
1. Provide a name for the webhook.
1. Provide the endpoint URL for the webhook.
Expand Down Expand Up @@ -48,7 +48,7 @@ A Registry admin can create automations in that registry. Registry automations a
1. Click the name of a registry to view its details,
1. To create an automation scoped to the registry, click the **Automations** tab, then click **Create automation**.

1. Choose the [event](/models/automations/automation-events/#registry-events) to watch for.
1. Select the [event](/models/automations/automation-events/#registry-events) to watch for.

Fill in any additional fields that appear. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**.

Expand All @@ -62,14 +62,14 @@ A Registry admin can create automations in that registry. Registry automations a
<Tab title="Project">
A W&B admin can create automations in a project.

1. Log in to W&B and go to the project page.
1. Log in to W&B and navigate to the project page.
1. In the project sidebar, click **Automations**, then click **Create automation**.

Or, from a line plot in the workspace, you can quickly create a [run metric automation](/models/automations/automation-events/#run-events) for the metric it shows. Hover over the panel, then click the bell icon at the top of the panel.
<Frame>
<img src="/images/automations/run_metric_automation_from_panel.png" alt="Automation bell icon location" />
</Frame>
1. Choose the [event](/models/automations/automation-events/#project) to watch for, such as when an artifact alias is added or when a run metric meets a given threshold.
1. Select the [event](/models/automations/automation-events/#project) to watch for, such as when an artifact alias is added or when a run metric meets a given threshold.

1. Fill in any additional fields that appear, which depend upon the event. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**.

Expand Down Expand Up @@ -183,7 +183,7 @@ Use template strings to dynamically pass context from W&B to GitHub Actions and

- Watch the videos [Webhook Automations for Model Evaluation](https://www.youtube.com/watch?v=7j-Mtbo-E74&ab_channel=Weights%26Biases) and [Webhook Automations for Model Deployment](https://www.youtube.com/watch?v=g5UiAFjM2nA&ab_channel=Weights%26Biases), which guide you to create automations for model evaluation and deployment.

- Review a W&B [report](https://wandb.ai/wandb/wandb-model-cicd/reports/Model-CI-CD-with-W-B--Vmlldzo0OTcwNDQw), which illustrates how to use a Github Actions webhook automation for Model CI. Check out this [GitHub repository](https://github.com/hamelsmu/wandb-modal-webhook) to learn how to create model CI with a Modal Labs webhook.
- Review a W&B [report](https://wandb.ai/wandb/wandb-model-cicd/reports/Model-CI-CD-with-W-B--Vmlldzo0OTcwNDQw), which illustrates how to use a Github Actions webhook automation for Model CI. See this [GitHub repository](https://github.com/hamelsmu/wandb-modal-webhook) to learn how to create model CI with a Modal Labs webhook.
</Tab>
<Tab title="Microsoft Teams notification">
This example payload shows how to notify your Teams channel using a webhook:
Expand Down
2 changes: 1 addition & 1 deletion models/integrations/catalyst.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Catalyst

Catalyst includes a W&B integration for logging parameters, metrics, images, and other artifacts.

Check out their [documentation of the integration](https://catalyst-team.github.io/catalyst/api/loggers.html#catalyst.loggers.wandb.WandbLogger), which includes examples using Python and Hydra.
See their [documentation of the integration](https://catalyst-team.github.io/catalyst/api/loggers.html#catalyst.loggers.wandb.WandbLogger), which includes examples using Python and Hydra.

## Interactive example

Expand Down
2 changes: 1 addition & 1 deletion models/integrations/databricks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ W&B integrates with [Databricks](https://www.databricks.com/) by customizing the

1. Install wandb in the cluster

Navigate to your cluster configuration, choose your cluster, click **Libraries**. Click **Install New**, choose **PyPI**, and add the package `wandb`.
Navigate to your cluster configuration, select your cluster, click **Libraries**. Click **Install New**, select **PyPI**, and add the package `wandb`.

2. Set up authentication

Expand Down
2 changes: 1 addition & 1 deletion models/integrations/deepchem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ model.fit(…)

Explore the Using [W&B with DeepChem: Molecular Graph Convolutional Networks](https://wandb.ai/kshen/deepchem_graphconv/reports/Using-W-B-with-DeepChem-Molecular-Graph-Convolutional-Networks--Vmlldzo4MzU5MDc?galleryTag=) article for an example charts generated using the W&B DeepChem integration.

To dive straight into working code, check out this [Google Colab](https://colab.research.google.com/github/wandb/examples/blob/master/colabs/deepchem/W%26B_x_DeepChem.ipynb).
To dive straight into working code, see this [Google Colab](https://colab.research.google.com/github/wandb/examples/blob/master/colabs/deepchem/W%26B_x_DeepChem.ipynb).

## Track experiments

Expand Down
2 changes: 1 addition & 1 deletion models/integrations/farama-gymnasium.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If you're using [Farama Gymnasium](https://gymnasium.farama.org/#) we will autom

Our gymnasium integration is very light. We simply [look at the name of the video file](https://github.com/wandb/wandb/blob/c5fe3d56b155655980611d32ef09df35cd336872/wandb/integration/gym/__init__.py#LL69C67-L69C67) being logged from `gymnasium` and name it after that or fall back to `"videos"` if we don't find a match. If you want more control, you can always just manually [log a video](/models/track/log/media/).

Check out this [report](https://wandb.ai/raph-test/cleanrltest/reports/Mario-Bros-but-with-AI-Gymnasium-and-CleanRL---Vmlldzo0NTcxNTcw) to learn more on how to use Gymnasium with the CleanRL library.
See this [report](https://wandb.ai/raph-test/cleanrltest/reports/Mario-Bros-but-with-AI-Gymnasium-and-CleanRL---Vmlldzo0NTcxNTcw) to learn more on how to use Gymnasium with the CleanRL library.

<Frame>
<img src="/images/integrations/gymnasium.png" alt="Gymnasium RL environment" />
Expand Down
Loading
Loading