YOLO Fine-tuning Experiments
-Here's how epoch-wise validation results are visualized using a [W&B Table](../tables/intro.md):
+Here's how epoch-wise validation results are visualized using a [W&B Table]({{< relref "/guides/core/tables/" >}}):
WandB Validation Visualization Table
@@ -108,14 +108,14 @@ Download a few images to test the integration on. You can use still images, vide
!wget https://raw.githubusercontent.com/wandb/examples/ultralytics/colabs/ultralytics/assets/img5.png
```
-Next, initialize a W&B [run](../runs/intro.md) using `wandb.init`.
+Next, initialize a W&B [run]({{< relref "/guides/models/track/runs/" >}}) using `wandb.init`.
```python
# Initialize W&B run
wandb.init(project="ultralytics", job_type="inference")
```
-Next, initialize your desired `YOLO` model and invoke the `add_wandb_callback` function on it before you perform inference with the model. This ensures that when you perform inference, it automatically logs the images overlaid with your [interactive overlays for computer vision tasks](../track/log/media#image-overlays-in-tables) along with additional insights in a [`wandb.Table`](../tables/intro.md).
+Next, initialize your desired `YOLO` model and invoke the `add_wandb_callback` function on it before you perform inference with the model. This ensures that when you perform inference, it automatically logs the images overlaid with your [interactive overlays for computer vision tasks]({{< relref "/guides/models/track/log/media#image-overlays-in-tables" >}}) along with additional insights in a [`wandb.Table`]({{< relref "/guides/core/tables/" >}}).
```python
# Initialize YOLO Model
@@ -145,7 +145,7 @@ Here's how the interactive bbox overlay looks:
WandB Image Overlay
-You can fine more information on the W&B image overlays [here](../track/log/media.md#image-overlays).
+You can fine more information on the W&B image overlays [here]({{< relref "/guides/models/track/log/media.md#image-overlays" >}}).
## More resources
diff --git a/content/guides/integrations/xgboost.md b/content/guides/integrations/xgboost.md
index cca58b168..6886bd84a 100644
--- a/content/guides/integrations/xgboost.md
+++ b/content/guides/integrations/xgboost.md
@@ -63,7 +63,7 @@ For additional examples, check out the [repository of examples on GitHub](https:
## Tune your hyperparameters with Sweeps
-Attaining the maximum performance out of models requires tuning hyperparameters, like tree depth and learning rate. Weights & Biases includes [Sweeps](../sweeps/intro.md), a powerful toolkit for configuring, orchestrating, and analyzing large hyperparameter testing experiments.
+Attaining the maximum performance out of models requires tuning hyperparameters, like tree depth and learning rate. Weights & Biases includes [Sweeps]({{< relref "/guides/models/sweeps/" >}}), a powerful toolkit for configuring, orchestrating, and analyzing large hyperparameter testing experiments.
{{< cta-button colabLink="https://colab.research.google.com/github/wandb/examples/blob/master/colabs/boosting/Using_W%26B_Sweeps_with_XGBoost.ipynb" >}}
diff --git a/content/guides/integrations/yolov5.md b/content/guides/integrations/yolov5.md
index 200c4bd97..e2a44c705 100644
--- a/content/guides/integrations/yolov5.md
+++ b/content/guides/integrations/yolov5.md
@@ -18,7 +18,7 @@ All W&B logging features are compatible with data-parallel multi-GPU training, s
{{% /alert %}}
## Track core experiments
-Simply by installing `wandb`, you'll activate the built-in W&B [logging features](../track/log/intro.md): system metrics, model metrics, and media logged to interactive [Dashboards](../track/workspaces.md).
+Simply by installing `wandb`, you'll activate the built-in W&B [logging features]({{< relref "/guides/models/track/log/" >}}): system metrics, model metrics, and media logged to interactive [Dashboards]({{< relref "/guides/models/track/workspaces.md" >}}).
```python
pip install wandb
@@ -34,9 +34,9 @@ Just follow the links printed to the standard out by wandb.
By passing a few simple command line arguments to YOLO, you can take advantage of even more W&B features.
-* Passing a number to `--save_period` will turn on [model versioning](../model_registry/intro.md). At the end of every `save_period` epochs, the model weights will be saved to W&B. The best-performing model on the validation set will be tagged automatically.
+* Passing a number to `--save_period` will turn on [model versioning]({{< relref "/guides/models/registry/model_registry/" >}}). At the end of every `save_period` epochs, the model weights will be saved to W&B. The best-performing model on the validation set will be tagged automatically.
* Turning on the `--upload_dataset` flag will also upload the dataset for data versioning.
-* Passing a number to `--bbox_interval` will turn on [data visualization](../intro.md). At the end of every `bbox_interval` epochs, the outputs of the model on the validation set will be uploaded to W&B.
+* Passing a number to `--bbox_interval` will turn on [data visualization]({{< relref "../" >}}). At the end of every `bbox_interval` epochs, the outputs of the model on the validation set will be uploaded to W&B.
{{< tabpane text=true >}}
{{% tab header="Model Versioning Only" value="modelversioning" %}}
diff --git a/content/guides/integrations/yolox.md b/content/guides/integrations/yolox.md
index 24a9e9394..9e8347a92 100644
--- a/content/guides/integrations/yolox.md
+++ b/content/guides/integrations/yolox.md
@@ -14,7 +14,7 @@ weight: 490
To use YOLOX with Weights & Biases you will first need to sign up for a Weights & Biases account [here](https://wandb.ai/site).
-Then just use the `--logger wandb` command line argument to turn on logging with wandb. Optionally you can also pass all of the arguments that [wandb.init](/ref/python/init) would expect, just prepend `wandb-` to the start of each argument
+Then just use the `--logger wandb` command line argument to turn on logging with wandb. Optionally you can also pass all of the arguments that [wandb.init]({{< relref "/ref/python/init" >}}) would expect, just prepend `wandb-` to the start of each argument
`num_eval_imges` controls the number of validation set images and predictions that are logged to Weights & Biases tables for model evaluation.
diff --git a/content/guides/models/_index.md b/content/guides/models/_index.md
index 52075a467..b03bd5a2d 100644
--- a/content/guides/models/_index.md
+++ b/content/guides/models/_index.md
@@ -13,11 +13,9 @@ W&B Models is the system of record for ML Practitioners who want to organize the
With W&B Models, you can:
-- Track and visualize all [ML experiments](./track/intro.md).
-- Optimize and fine-tune models at scale with [hyperparameter sweeps](./sweeps/intro.md).
-- [Maintain a centralized hub of all models](./model_registry/intro.md), with a seamless handoff point to devops and deployment
-- Configure custom automations that trigger key workflows for [model CI/CD](./model_registry/model-registry-automations.md).
-
-
+- Track and visualize all [ML experiments]({{< relref "./track/" >}}).
+- Optimize and fine-tune models at scale with [hyperparameter sweeps]({{< relref "./sweeps/" >}}).
+- [Maintain a centralized hub of all models]({{< relref "./registry/" >}}), with a seamless handoff point to devops and deployment
+- Configure custom automations that trigger key workflows for [model CI/CD]({{< relref "./automations/model-registry-automations.md" >}}).
Machine learning practitioners rely on W&B Models as their ML system of record to track and visualize experiments, manage model versions and lineage, and optimize hyperparameters.
\ No newline at end of file
diff --git a/content/guides/models/app/_index.md b/content/guides/models/app/_index.md
index 60dbf30db..5a297feb5 100644
--- a/content/guides/models/app/_index.md
+++ b/content/guides/models/app/_index.md
@@ -6,6 +6,6 @@ menu:
title: W&B App UI Reference
url: guides/app
aliases:
-- /guides/app/features
+- /guides/models/app/features
---
diff --git a/content/guides/models/app/features/cascade-settings.md b/content/guides/models/app/features/cascade-settings.md
index e56654f04..93ae271e3 100644
--- a/content/guides/models/app/features/cascade-settings.md
+++ b/content/guides/models/app/features/cascade-settings.md
@@ -7,14 +7,14 @@ title: Manage workspace, section, and panel settings
url: guides/app/features/cascade-settings
---
-Within a given workspace page there are three different setting levels: workspaces, sections, and panels. [Workspace settings](#workspace-settings) apply to the entire workspace. [Section settings](#section-settings) apply to all panels within a section. [Panel settings](#panel-settings) apply to individual panels.
+Within a given workspace page there are three different setting levels: workspaces, sections, and panels. [Workspace settings]({{< relref "#workspace-settings" >}}) apply to the entire workspace. [Section settings]({{< relref "#section-settings" >}}) apply to all panels within a section. [Panel settings]({{< relref "#panel-settings" >}}) apply to individual panels.
## Workspace settings
-Workspace settings apply to all sections and all panels within those sections. You can edit two types of workspace settings: [**Workspace layout**](#workspace-layout-options) and [**Line plots**](#line-plots-options). **Workspace layouts** determine the structure of the workspace, while **Line plots** settings control the default settings for line plots in the workspace.
+Workspace settings apply to all sections and all panels within those sections. You can edit two types of workspace settings: [**Workspace layout**]({{< relref "#workspace-layout-options" >}}) and [**Line plots**]({{< relref "#line-plots-options" >}}). **Workspace layouts** determine the structure of the workspace, while **Line plots** settings control the default settings for line plots in the workspace.
To edit settings that apply to the overall structure of this workspace:
@@ -29,7 +29,7 @@ Configure a workspaces layout to define the overall structure of the workspace.
{{< img src="/images/app_ui/workspace_layout_settings.png" alt="" >}}
-The workspace layout options page shows whether the workspace generates panels automatically or manually. To adjust a workspace's panel generation mode, refer to [Panels](panels/intro.md).
+The workspace layout options page shows whether the workspace generates panels automatically or manually. To adjust a workspace's panel generation mode, refer to [Panels]({{< relref "panels/" >}}).
This table describes each workspace layout option.
@@ -55,9 +55,9 @@ You can edit two main settings within **Line plots** settings: **Data** and **Di
| ----- | ----- |
| **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. |
| **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](./panels/line-plot/smoothing.md). |
+| **Smoothing** | Change the smoothing on the line plot. For more information about smoothing, see [Smooth line plots]({{< relref "./panels/line-plot/smoothing.md" >}}). |
| **Outliers** | Rescale to exclude outliers from the default plot min and max scale. |
-| **Point aggregation method** | Improve data visualization accuracy and performance. See [Point aggregation](./panels/line-plot/sampling.md) for more information. |
+| **Point aggregation method** | Improve data visualization accuracy and performance. See [Point aggregation]({{< relref "./panels/line-plot/sampling.md" >}}) for more information. |
| **Max number of runs or groups** | Limit the number of runs or groups displayed on the line plot. |
In addition to **Step**, there are other options for the x-axis:
@@ -72,7 +72,7 @@ In addition to **Step**, there are other options for the x-axis:
{{% alert %}}
-For information on how to edit an individual line plot, see [Edit line panel settings](./panels/line-plot/intro.md#edit-line-panel-settings) in Line plots.
+For information on how to edit an individual line plot, see [Edit line panel settings]({{< relref "./panels/line-plot/#edit-line-panel-settings" >}}) in Line plots.
{{% /alert %}}
@@ -123,4 +123,4 @@ Customize an individual panel's settings to compare multiple lines on the same p
3. Within the modal that appears, you can edit settings related to the panel's data, display preferences, and more.
{{< img src="/images/app_ui/panel_settings_modal.png" alt="" >}}
-For a complete list of settings you can apply to a panel, see [Edit line panel settings](./panels/line-plot/intro.md#edit-line-panel-settings).
\ No newline at end of file
+For a complete list of settings you can apply to a panel, see [Edit line panel settings]({{< relref "./panels/line-plot/#edit-line-panel-settings" >}}).
\ No newline at end of file
diff --git a/content/guides/models/app/features/custom-charts/_index.md b/content/guides/models/app/features/custom-charts/_index.md
index 787b5de5b..f8105f1cd 100644
--- a/content/guides/models/app/features/custom-charts/_index.md
+++ b/content/guides/models/app/features/custom-charts/_index.md
@@ -21,7 +21,7 @@ Use **Custom Charts** to create charts that aren't possible right now in the def
### How it works
-1. **Log data**: From your script, log [config](../../../../guides/track/config.md) and summary data as you normally would when running with W&B. To visualize a list of multiple values logged at one specific time, use a custom`wandb.Table`
+1. **Log data**: From your script, log [config]({{< relref "/guides/models/track/config.md" >}}) and summary data as you normally would when running with W&B. To visualize a list of multiple values logged at one specific time, use a custom`wandb.Table`
2. **Customize the chart**: Pull in any of this logged data with a [GraphQL](https://graphql.org) query. Visualize the results of your query with [Vega](https://vega.github.io/vega/), a powerful visualization grammar.
3. **Log the chart**: Call your own preset from your script with `wandb.plot_table()`.
diff --git a/content/guides/models/app/features/custom-charts/walkthrough.md b/content/guides/models/app/features/custom-charts/walkthrough.md
index b3586363b..df305173d 100644
--- a/content/guides/models/app/features/custom-charts/walkthrough.md
+++ b/content/guides/models/app/features/custom-charts/walkthrough.md
@@ -12,7 +12,7 @@ Use custom charts to control the data you're loading in to a panel and its visua
## 1. Log data to W&B
-First, log data in your script. Use [wandb.config](../../../../guides/track/config.md) for single points set at the beginning of training, like hyperparameters. Use [wandb.log()](../../../../guides/track/log/intro.md) for multiple points over time, and log custom 2D arrays with `wandb.Table()`. We recommend logging up to 10,000 data points per logged key.
+First, log data in your script. Use [wandb.config]({{< relref "/guides/models/track/config.md" >}}) for single points set at the beginning of training, like hyperparameters. Use [wandb.log()]({{< relref "/guides/models/track/log/" >}}) for multiple points over time, and log custom 2D arrays with `wandb.Table()`. We recommend logging up to 10,000 data points per logged key.
```python
# Logging a custom table of data
diff --git a/content/guides/models/app/features/panels/_index.md b/content/guides/models/app/features/panels/_index.md
index 3605dba25..3be2f11ab 100644
--- a/content/guides/models/app/features/panels/_index.md
+++ b/content/guides/models/app/features/panels/_index.md
@@ -10,7 +10,7 @@ cascade:
- url: guides/app/features/panels/:filename
---
-Use workspace panel visualizations to explore your [logged data](/ref/python/log.md) by key, visualize the relationships between hyperparameters and output metrics, and more.
+Use workspace panel visualizations to explore your [logged data]({{< relref "/ref/python/log.md" >}}) by key, visualize the relationships between hyperparameters and output metrics, and more.
## Workspace modes
@@ -21,7 +21,7 @@ W&B projects support two different workspace modes. The icon next to the workspa
| {{< img src="/images/app_ui/automated_workspace.svg" alt="automated workspace icon" width="32px" >}} | **Automated workspaces** automatically generate panels for all keys logged in the project. This can help you get started by visualizing all available data for the project. |
| {{
}} | **Manual workspaces** start as blank slates and display only those panels intentionally added by users. Choose a manual workspace when you care mainly about a fraction of the keys logged in the project, or for a more focused analysis. |
-To change how a workspace generates panels, [reset the workspace](#reset-a-workspace).
+To change how a workspace generates panels, [reset the workspace]({{< relref "#reset-a-workspace" >}}).
{{% alert title="Undo changes to your workspace" %}}
To undo changes to your workspace, click the Undo button (arrow that points left) or type **CMD + Z** (macOS) or **CTRL + Z** (Windows / Linux).
@@ -43,7 +43,8 @@ To add a panel:
1. To add a panel globally, click **Add panels** in the control bar near the panel search field.
1. To add a panel directly to a section instead, click the section's action `...` menu, then click **+ Add panels**.
1. Select the type of panel to add.
-
+
+ {{< img src="/images/app_ui/add_single_panel.gif" >}}
### Quick add
@@ -58,7 +59,7 @@ To add a custom panel to your workspace:
1. Select the type of panel you’d like to create.
1. Follow the prompts to configure the panel.
-To learn more about the options for each type of panel, refer to the relevant section below, such as [Line plots](line-plot/intro.md) or [Bar plots](bar-plot.md).
+To learn more about the options for each type of panel, refer to the relevant section below, such as [Line plots]({{< relref "line-plot/" >}}) or [Bar plots]({{< relref "bar-plot.md" >}}).
## Manage panels
@@ -88,7 +89,7 @@ To duplicate a panel:
1. At the top of the panel, click the action `...` menu.
1. Click **Duplicate**.
-If desired, you can [customize](#edit-a-panel) or [move](#move-a-panel) the duplicated panel.
+If desired, you can [customize]({{< relref "#edit-a-panel" >}}) or [move]({{< relref "#move-a-panel" >}}) the duplicated panel.
### Remove panels
@@ -100,7 +101,7 @@ To remove a panel:
To remove all panels from a manual workspace, click its action `...` menu, then click **Clear all panels**.
-To remove all panels from an automatic or manual workspace, you can [reset the workspace](#reset-a-workspace). Select **Automatic** to start with the default set of panels, or select **Manual** to start with an empty workspace with no panels.
+To remove all panels from an automatic or manual workspace, you can [reset the workspace]({{< relref "#reset-a-workspace" >}}). Select **Automatic** to start with the default set of panels, or select **Manual** to start with an empty workspace with no panels.
## Manage sections
diff --git a/content/guides/models/app/features/panels/code.md b/content/guides/models/app/features/panels/code.md
index 983caf1d5..2433b8df0 100644
--- a/content/guides/models/app/features/panels/code.md
+++ b/content/guides/models/app/features/panels/code.md
@@ -32,7 +32,7 @@ import wandb
wandb.init(settings=wandb.Settings(code_dir="."))
```
-This captures all python source code files in the current directory and all subdirectories as an [artifact](../../../../ref/python/artifact.md). For more control over the types and locations of source code files that are saved, see the [reference docs](../../../../ref/python/run.md#log_code).
+This captures all python source code files in the current directory and all subdirectories as an [artifact]({{< relref "/ref/python/artifact.md" >}}). For more control over the types and locations of source code files that are saved, see the [reference docs]({{< relref "/ref/python/run.md#log_code" >}}).
### Set code saving in the UI
diff --git a/content/guides/models/app/features/panels/line-plot/reference.md b/content/guides/models/app/features/panels/line-plot/reference.md
index 2392f0bc4..44a6363c5 100644
--- a/content/guides/models/app/features/panels/line-plot/reference.md
+++ b/content/guides/models/app/features/panels/line-plot/reference.md
@@ -62,7 +62,7 @@ You can aggregate all of the runs by turning on grouping, or group over an indiv
## Smoothing
-You can set the [smoothing coefficient](../../../../../support/formula_smoothing_algorithm.md) to be between 0 and 1 where 0 is no smoothing and 1 is maximum smoothing.
+You can set the [smoothing coefficient]({{< relref "/support/formula_smoothing_algorithm.md" >}}) to be between 0 and 1 where 0 is no smoothing and 1 is maximum smoothing.
## Ignore outliers
diff --git a/content/guides/models/app/features/panels/line-plot/sampling.md b/content/guides/models/app/features/panels/line-plot/sampling.md
index b5124e5e3..1e9e1037c 100644
--- a/content/guides/models/app/features/panels/line-plot/sampling.md
+++ b/content/guides/models/app/features/panels/line-plot/sampling.md
@@ -8,7 +8,7 @@ weight: 20
---
-Use point aggregation methods within your line plots for improved data visualization accuracy and performance. There are two types of point aggregation modes: [full fidelity](#full-fidelity) and [random sampling](#random-sampling). W&B uses full fidelity mode by default.
+Use point aggregation methods within your line plots for improved data visualization accuracy and performance. There are two types of point aggregation modes: [full fidelity]({{< relref "#full-fidelity" >}}) and [random sampling]({{< relref "#random-sampling" >}}). W&B uses full fidelity mode by default.
## Full fidelity
@@ -120,7 +120,7 @@ By default, W&B uses full fidelity mode. To enable random sampling, follow these
### Access non sampled data
-You can access the complete history of metrics logged during a run using the [W&B Run API](../../../../../ref/python/public-api/run.md). The following example demonstrates how to retrieve and process the loss values from a specific run:
+You can access the complete history of metrics logged during a run using the [W&B Run API]({{< relref "/ref/python/public-api/run.md" >}}). The following example demonstrates how to retrieve and process the loss values from a specific run:
```python
diff --git a/content/guides/models/app/features/panels/line-plot/smoothing.md b/content/guides/models/app/features/panels/line-plot/smoothing.md
index 738688542..ce80cbaf5 100644
--- a/content/guides/models/app/features/panels/line-plot/smoothing.md
+++ b/content/guides/models/app/features/panels/line-plot/smoothing.md
@@ -10,10 +10,10 @@ weight: 30
W&B supports three types of smoothing:
-- [exponential moving average](smoothing.md#exponential-moving-average-default) (default)
-- [gaussian smoothing](smoothing.md#gaussian-smoothing)
-- [running average](smoothing.md#running-average)
-- [exponential moving average - Tensorboard](smoothing.md#exponential-moving-average-deprecated) (deprecated)
+- [exponential moving average]({{< relref "smoothing.md#exponential-moving-average-default" >}}) (default)
+- [gaussian smoothing]({{< relref "smoothing.md#gaussian-smoothing" >}})
+- [running average]({{< relref "smoothing.md#running-average" >}})
+- [exponential moving average - Tensorboard]({{< relref "smoothing.md#exponential-moving-average-deprecated" >}}) (deprecated)
See these live in an [interactive W&B report](https://wandb.ai/carey/smoothing-example/reports/W-B-Smoothing-Features--Vmlldzo1MzY3OTc).
diff --git a/content/guides/models/app/features/panels/parallel-coordinates.md b/content/guides/models/app/features/panels/parallel-coordinates.md
index 71b485999..e2380bf31 100644
--- a/content/guides/models/app/features/panels/parallel-coordinates.md
+++ b/content/guides/models/app/features/panels/parallel-coordinates.md
@@ -12,7 +12,7 @@ Parallel coordinates charts summarize the relationship between large numbers of
{{< img src="/images/app_ui/parallel_coordinates.gif" alt="" >}}
-* **Axes**: Different hyperparameters from [`wandb.config`](../../../../guides/track/config.md) and metrics from [`wandb.log`](../../../../guides/track/log/intro.md).
+* **Axes**: Different hyperparameters from [`wandb.config`]({{< relref "/guides/models/track/config.md" >}}) and metrics from [`wandb.log`]({{< relref "/guides/models/track/log/" >}}).
* **Lines**: Each line represents a single run. Mouse over a line to see a tooltip with details about the run. All lines that match the current filters will be shown, but if you turn off the eye, lines will be grayed out.
## Panel Settings
diff --git a/content/guides/models/app/features/panels/parameter-importance.md b/content/guides/models/app/features/panels/parameter-importance.md
index 18b2c2e99..922d99a57 100644
--- a/content/guides/models/app/features/panels/parameter-importance.md
+++ b/content/guides/models/app/features/panels/parameter-importance.md
@@ -44,7 +44,7 @@ With the parameter manager, we can manually set the visible and hidden parameter
{{< img src="/images/general/parameter-importance-4.png" alt="" >}}
-This panel shows you all the parameters passed to the [wandb.config](/guides/track/config/) object in your training script. Next, it shows the feature importances and correlations of these config parameters with respect to the model metric you select (`val_loss` in this case).
+This panel shows you all the parameters passed to the [wandb.config]({{< relref "/guides/models/track/config/" >}}) object in your training script. Next, it shows the feature importances and correlations of these config parameters with respect to the model metric you select (`val_loss` in this case).
### Importance
diff --git a/content/guides/models/app/features/panels/query-panels/_index.md b/content/guides/models/app/features/panels/query-panels/_index.md
index fd77e490d..8ccdf9773 100644
--- a/content/guides/models/app/features/panels/query-panels/_index.md
+++ b/content/guides/models/app/features/panels/query-panels/_index.md
@@ -74,7 +74,7 @@ runs.summary["cifar10_sample_table"]
Breaking this down:
-* `runs` is a variable automatically injected in Query Panel Expressions when the Query Panel is in a Workspace. Its "value" is the list of runs which are visible for that particular Workspace. [Read about the different attributes available within a run here](../../../../track/public-api-guide.md#understanding-the-different-attributes).
+* `runs` is a variable automatically injected in Query Panel Expressions when the Query Panel is in a Workspace. Its "value" is the list of runs which are visible for that particular Workspace. [Read about the different attributes available within a run here]({{< relref "../../../../track/public-api-guide.md#understanding-the-different-attributes" >}}).
* `summary` is an op which returns the Summary object for a Run. Ops are _mapped_, meaning this op is applied to each Run in the list, resulting in a list of Summary objects.
* `["cifar10_sample_table"]` is a Pick op (denoted with brackets), with a parameter of `predictions`. Since Summary objects act like dictionaries or maps, this operation picks the `predictions` field off of each Summary object.
diff --git a/content/guides/models/app/settings-page/_index.md b/content/guides/models/app/settings-page/_index.md
index dfa0d9efa..df4868c61 100644
--- a/content/guides/models/app/settings-page/_index.md
+++ b/content/guides/models/app/settings-page/_index.md
@@ -8,6 +8,6 @@ menu:
title: Settings
---
-Within your individual user account you can edit: your profile picture, display name, geography location, biography information, emails associated to your account, and manage alerts for runs. You can also use the settings page to link your GitHub repository and delete your account. For more information, see [User settings](./user-settings.md).
+Within your individual user account you can edit: your profile picture, display name, geography location, biography information, emails associated to your account, and manage alerts for runs. You can also use the settings page to link your GitHub repository and delete your account. For more information, see [User settings]({{< relref "./user-settings.md" >}}).
-Use the team settings page to invite or remove new members to a team, manage alerts for team runs, change privacy settings, and view and manage storage usage. For more information about team settings, see [Team settings](./team-settings.md).
\ No newline at end of file
+Use the team settings page to invite or remove new members to a team, manage alerts for team runs, change privacy settings, and view and manage storage usage. For more information about team settings, see [Team settings]({{< relref "./team-settings.md" >}}).
\ No newline at end of file
diff --git a/content/guides/models/app/settings-page/storage.md b/content/guides/models/app/settings-page/storage.md
index c0e42fcb3..4e3762f00 100644
--- a/content/guides/models/app/settings-page/storage.md
+++ b/content/guides/models/app/settings-page/storage.md
@@ -13,11 +13,11 @@ If you are approaching or exceeding your storage limit, there are multiple paths
## Manage storage consumption
W&B offers different methods of optimizing your storage consumption:
-- Use [reference artifacts](../../artifacts/track-external-files.md) to track files saved outside the W&B system, instead of uploading them to W&B storage.
-- Use an [external cloud storage bucket](../features/teams.md) for storage. *(Enterprise only)*
+- Use [reference artifacts]({{< relref "/guides/core/artifacts/track-external-files.md" >}}) to track files saved outside the W&B system, instead of uploading them to W&B storage.
+- Use an [external cloud storage bucket]({{< relref "teams.md" >}}) for storage. *(Enterprise only)*
## Delete data
You can also choose to delete data to remain under your storage limit. There are several ways to do this:
- Delete data interactively with the app UI.
-- [Set a TTL policy](../../artifacts/ttl.md) on Artifacts so they are automatically deleted.
\ No newline at end of file
+- [Set a TTL policy]({{< relref "/guides/core/artifacts/manage-data/ttl.md" >}}) on Artifacts so they are automatically deleted.
\ No newline at end of file
diff --git a/content/guides/models/app/settings-page/system-metrics.md b/content/guides/models/app/settings-page/system-metrics.md
index c513ea32e..48a0a8f09 100644
--- a/content/guides/models/app/settings-page/system-metrics.md
+++ b/content/guides/models/app/settings-page/system-metrics.md
@@ -64,7 +64,7 @@ W&B assigns a `disk.in` tag to this metric.
### Disk Out
Represents the total system disk write in megabytes (MB).
-Similar to [Disk In](#disk-in), the initial disk write bytes are recorded when the first sample is taken. Subsequent samples calculate the difference between the current write bytes and the initial value.
+Similar to [Disk In]({{< relref "#disk-in" >}}), the initial disk write bytes are recorded when the first sample is taken. Subsequent samples calculate the difference between the current write bytes and the initial value.
W&B assigns a `disk.out` tag to this metric.
@@ -104,7 +104,7 @@ W&B assigns a `network.sent` tag to this metric.
### Network Received
Indicates the total bytes received over the network.
-Similar to [Network Sent](#network-sent), the initial bytes received are recorded when the metric is first initialized. Subsequent samples calculate the difference between the current bytes received and the initial value.
+Similar to [Network Sent]({{< relref "#network-sent" >}}), the initial bytes received are recorded when the metric is first initialized. Subsequent samples calculate the difference between the current bytes received and the initial value.
W&B assigns a `network.recv` tag to this metric.
diff --git a/content/guides/models/app/settings-page/team-settings.md b/content/guides/models/app/settings-page/team-settings.md
index 285f2b3db..6e955996d 100644
--- a/content/guides/models/app/settings-page/team-settings.md
+++ b/content/guides/models/app/settings-page/team-settings.md
@@ -21,7 +21,7 @@ Only Administration account types can change team settings or remove a member fr
## Members
The Members section shows a list of all pending invitations and the members that have either accepted the invitation to join the team. Each member listed displays a member’s name, username, email, team role, as well as their access privileges to Models and Weave, which is inherited by from the Organization. There are three standard team roles: Administrator (Admin), Member, and View-only.
-See [Add and Manage teams](../../hosting/iam/manage-organization.md#add-and-manage-teams) for information on how to create a tea, invite users to a team, remove users from a team, and change a user's role.
+See [Add and Manage teams]({{< relref "/guides/hosting/iam/access-management/manage-organization.md#add-and-manage-teams" >}}) for information on how to create a tea, invite users to a team, remove users from a team, and change a user's role.
## Avatar
@@ -39,7 +39,7 @@ Toggle the switch next to the event type you want to receive alerts from. Weight
* **Runs finished**: whether a Weights and Biases run successfully finished.
* **Run crashed**: if a run has failed to finish.
-For more information about how to set up and manage alerts, see [Send alerts with wandb.alert](../../runs/alert.md).
+For more information about how to set up and manage alerts, see [Send alerts with wandb.alert]({{< relref "/guides/models/track/runs/alert.md" >}}).
## Privacy
@@ -54,4 +54,4 @@ The **Usage** section describes the total memory usage the team has consumed on
## Storage
-The **Storage** section describes the cloud storage bucket configuration that is being used for the team's data. For more information, see [Secure Storage Connector](../features/teams.md#secure-storage-connector) or check out our [W&B Server](../../hosting/data-security/secure-storage-connector.md) docs if you are self-hosting.
\ No newline at end of file
+The **Storage** section describes the cloud storage bucket configuration that is being used for the team's data. For more information, see [Secure Storage Connector]({{< relref "teams.md#secure-storage-connector" >}}) or check out our [W&B Server]({{< relref "/guides/hosting/data-security/secure-storage-connector.md" >}}) docs if you are self-hosting.
\ No newline at end of file
diff --git a/content/guides/models/app/settings-page/teams.md b/content/guides/models/app/settings-page/teams.md
index c51c30b9c..d308876fa 100644
--- a/content/guides/models/app/settings-page/teams.md
+++ b/content/guides/models/app/settings-page/teams.md
@@ -53,7 +53,7 @@ Select a team role when you invite colleagues to join a team. There are followin
- **Member**: A regular member of the team. An admin invites a team member by email. A team member cannot invite other members. Team members can only delete runs and sweep runs created by that member. Suppose you have two members A and B. Member B moves a Run from team B's project to a different project owned by Member A. Member A can not delete the Run Member B moved to Member A's project. Only the member that creates the Run, or the team admin, can delete the run.
- **View-Only (Enterprise-only feature)**: View-Only members can view assets within the team such as runs, reports, and workspaces. They can follow and comment on reports, but they can not create, edit, or delete project overview, reports, or runs. View-Only members do not have an API key.
- **Custom roles (Enterprise-only feature)**: Custom roles allow organization admins to compose new roles based on either of the **View-Only** or **Member** roles, together with additional permissions to achieve fine-grained access control. Team admins can then assign any of those custom roles to users in their respective teams. Refer to [Introducing Custom Roles for W&B Teams](https://wandb.ai/wandb_fc/announcements/reports/Introducing-Custom-Roles-for-W-B-Teams--Vmlldzo2MTMxMjQ3) for details.
-- **Service accounts (Enterprise-only feature)**: Refer to [Use service accounts to automate workflows](../../hosting/iam/service-accounts.md).
+- **Service accounts (Enterprise-only feature)**: Refer to [Use service accounts to automate workflows]({{< relref "/guides/hosting/iam/authentication/service-accounts.md" >}}).
{{% alert %}}
W&B recommends to have more than one admin in a team. It is a best practice to ensure that admin operations can continue when the primary admin is not available.
@@ -80,7 +80,7 @@ The proceeding table lists permissions that apply to all projects across a given
|Add/Remove Registry Admins | | | X | X |
|Add/Remove Protected Aliases| | | X | |
-See the [Model Registry](../../model_registry/access_controls.md) chapter for more information about protected aliases.
+See the [Model Registry]({{< relref "/guides/models/registry/model_registry/access_controls.md" >}}) chapter for more information about protected aliases.
### Reports
Report permissions grant access to create, view, and edit reports. The proceeding table lists permissions that apply to all reports across a given team.
@@ -140,7 +140,7 @@ For example, to add a Twitter follow badge, add `[{{< img src="https://img.shiel
## Team trials
-See the [pricing page](https://wandb.ai/site/pricing) for more information on W&B plans. You can download all your data at any time, either using the dashboard UI or the [Export API](../../../ref/python/public-api/README.md).
+See the [pricing page](https://wandb.ai/site/pricing) for more information on W&B plans. You can download all your data at any time, either using the dashboard UI or the [Export API]({{< relref "/ref/python/public-api/" >}}).
## Privacy settings
@@ -151,4 +151,4 @@ You can see the privacy settings of all team projects on the team settings page:
### Secure storage connector
-The team-level secure storage connector allows teams to use their own cloud storage bucket with W&B. This provides greater data access control and data isolation for teams with highly sensitive data or strict compliance requirements. Refer to [Secure Storage Connector](../../hosting/data-security/secure-storage-connector.md) for more information.
\ No newline at end of file
+The team-level secure storage connector allows teams to use their own cloud storage bucket with W&B. This provides greater data access control and data isolation for teams with highly sensitive data or strict compliance requirements. Refer to [Secure Storage Connector]({{< relref "/guides/hosting/data-security/secure-storage-connector.md" >}}) for more information.
\ No newline at end of file
diff --git a/content/guides/models/app/settings-page/user-settings.md b/content/guides/models/app/settings-page/user-settings.md
index 8219efc8b..9f46f9386 100644
--- a/content/guides/models/app/settings-page/user-settings.md
+++ b/content/guides/models/app/settings-page/user-settings.md
@@ -34,12 +34,12 @@ Within the **Beta Features** section you can optionally enable fun add-ons and s
## Alerts
-Get notified when your runs crash, finish, or set custom alerts with [wandb.alert()](../../runs/alert.md). Receive notifications either through Email or Slack. Toggle the switch next to the event type you want to receive alerts from.
+Get notified when your runs crash, finish, or set custom alerts with [wandb.alert()]({{< relref "/guides/models/track/runs/alert.md" >}}). Receive notifications either through Email or Slack. Toggle the switch next to the event type you want to receive alerts from.
* **Runs finished**: whether a Weights and Biases run successfully finished.
* **Run crashed**: notification if a run has failed to finish.
-For more information about how to set up and manage alerts, see [Send alerts with wandb.alert](../../runs/alert.md).
+For more information about how to set up and manage alerts, see [Send alerts with wandb.alert]({{< relref "/guides/models/track/runs/alert.md" >}}).
## Personal GitHub integration
diff --git a/content/guides/models/automations/model-registry-automations.md b/content/guides/models/automations/model-registry-automations.md
index cd97f1326..9ca508fd4 100644
--- a/content/guides/models/automations/model-registry-automations.md
+++ b/content/guides/models/automations/model-registry-automations.md
@@ -9,7 +9,7 @@ title: Model registry automations
url: guides/model_registry/model-registry-automations
---
-Create an automation to trigger workflow steps, such as automated model testing and deployment. To create an automation, define the action you want to occur based on an [event type](#event-types).
+Create an automation to trigger workflow steps, such as automated model testing and deployment. To create an automation, define the action you want to occur based on an [event type]({{< relref "#event-types" >}}).
For example, you can create a trigger that automatically deploys a model to GitHub when you add a new version of a registered model.
@@ -26,7 +26,7 @@ An *event* is a change that takes place in the W&B ecosystem. The Model Registry
- Use **Linking a new artifact to a registered model** to test new model candidates.
- Use **Adding a new alias to a version of the registered model** to specify an alias that represents a special step of your workflow, like `deploy`, and any time a new model version has that alias applied.
-See [Link a model version](./link-model-version.md) and [Create a custom alias](../artifacts/create-a-custom-alias.md).
+See [Link a model version]({{< relref "/guides/models/registry/link_version.md" >}}) and [Create a custom alias]({{< relref "/guides/core/artifacts/create-a-custom-alias.md" >}}).
## Create a webhook automation
@@ -44,7 +44,7 @@ To use a secret in your webhook, you must first add that secret to your team's s
{{% alert %}}
* Only W&B Admins can create, edit, or delete a secret.
* Skip this section if the external server you send HTTP POST requests to does not use secrets.
-* Secrets are also available if you use [W&B Server](../hosting/intro.md) in an Azure, GCP, or AWS deployment. Connect with your W&B account team to discuss how you can use secrets in W&B if you use a different deployment type.
+* Secrets are also available if you use [W&B Server]({{< relref "/guides/hosting/" >}}) in an Azure, GCP, or AWS deployment. Connect with your W&B account team to discuss how you can use secrets in W&B if you use a different deployment type.
{{% /alert %}}
There are two types of secrets W&B suggests that you create when you use a webhook automation:
@@ -62,7 +62,7 @@ Follow the instructions below to create a webhook:
6. Add your secret into the **Secret** field.
7. (Optional) Repeat steps 5 and 6 to create another secret (such as an access token) if your webhook requires additional secret keys or tokens to authenticate your webhook.
-Specify the secrets you want to use for your webhook automation when you configure the webhook. See the [Configure a webhook](#configure-a-webhook) section for more information.
+Specify the secrets you want to use for your webhook automation when you configure the webhook. See the [Configure a webhook]({{< relref "#configure-a-webhook" >}}) section for more information.
{{% alert %}}
Once you create a secret, you can access that secret in your W&B workflows with `$`.
@@ -81,7 +81,7 @@ Before you can use a webhook, first configure that webhook in the W&B App UI.
{{% alert %}}
* Only W&B Admins can configure a webhook for a W&B Team.
-* Ensure you already [created one or more secrets](#add-a-secret-for-authentication-or-authorization) if your webhook requires additional secret keys or tokens to authenticate your webhook.
+* Ensure you already [created one or more secrets]({{< relref "#add-a-secret-for-authentication-or-authorization" >}}) if your webhook requires additional secret keys or tokens to authenticate your webhook.
{{% /alert %}}
1. Navigate to the W&B App UI.
@@ -95,7 +95,7 @@ Before you can use a webhook, first configure that webhook in the W&B App UI.
9. (Optional) From the **Access token** dropdown menu select additional secret keys or tokens required to authenticate a webhook (such as an access token).
{{% alert %}}
-See the [Troubleshoot your webhook](#troubleshoot-your-webhook) section to view where the secret and access token are specified in
+See the [Troubleshoot your webhook]({{< relref "#troubleshoot-your-webhook" >}}) section to view where the secret and access token are specified in
the POST request.
{{% /alert %}}
@@ -103,7 +103,7 @@ the POST request.
### Add a webhook
Once you have a webhook configured and (optionally) a secret, navigate to the Model Registry App at [https://wandb.ai/registry/model](https://wandb.ai/registry/model).
-1. From the **Event type** dropdown, select an [event type](#event-types).
+1. From the **Event type** dropdown, select an [event type]({{< relref "#event-types" >}}).
{{< img src="/images/models/webhook_select_event.png" alt="" >}}
2. (Optional) If you selected **A new version is added to a registered model** event, provide the name of a registered model from the **Registered model** dropdown.
{{< img src="/images/models/webhook_new_version_reg_model.png" alt="" >}}
@@ -111,7 +111,7 @@ Once you have a webhook configured and (optionally) a secret, navigate to the Mo
4. Click on the **Next step** button.
5. Select a webhook from the **Webhook** dropdown.
{{< img src="/images/models/webhooks_select_from_dropdown.png" alt="" >}}
-6. (Optional) Provide a payload in the JSON expression editor. See the [Example payload](#example-payloads) section for common use case examples.
+6. (Optional) Provide a payload in the JSON expression editor. See the [Example payload]({{< relref "#example-payloads" >}}) section for common use case examples.
7. Click on **Next step**.
8. Provide a name for your webhook automation in the **Automation name** field.
{{< img src="/images/models/webhook_name_automation.png" alt="" >}}
@@ -179,7 +179,7 @@ Verify that your access tokens have required set of permissions to trigger your
${entity_name} --> "Example: Download and use a logged model
@@ -62,7 +62,7 @@ downloaded_model_path = run.use_model(name=f"{entity/project/model_artifact_name {{% alert title="Planned deprecation for W&B Model Registry in 2024" %}} The proceeding tabs demonstrate how to consume model artifacts using the soon to be deprecated Model Registry. -Use the W&B Registry to track, organize and consume model artifacts. For more information see the [Registry docs](../registry/intro.md). +Use the W&B Registry to track, organize and consume model artifacts. For more information see the [Registry docs]({{< relref "/guides/models/registry/" >}}). {{% /alert %}} {{< tabpane text=true >}} @@ -81,7 +81,7 @@ Reference a model version with one of following formats listed: * `v#` - Use `v0`, `v1`, `v2`, and so on to fetch a specific version in the Registered Model * `alias` - Specify the custom alias that you and your team assigned to your model version -See [`use_model`](../../ref/python/run.md#use_model) in the API Reference guide for more information on possible parameters and return type. +See [`use_model`]({{< relref "/ref/python/run.md#use_model" >}}) in the API Reference guide for more information on possible parameters and return type. {{% /tab %}} {{% tab header="W&B App" %}} 1. Navigate to the Model Registry App at [https://wandb.ai/registry/model](https://wandb.ai/registry/model). diff --git a/content/guides/models/registry/model_registry/create-registered-model.md b/content/guides/models/registry/model_registry/create-registered-model.md index 45f6aee86..65b0dd3d5 100644 --- a/content/guides/models/registry/model_registry/create-registered-model.md +++ b/content/guides/models/registry/model_registry/create-registered-model.md @@ -10,7 +10,7 @@ weight: 4 --- -Create a [registered model](./model-management-concepts.md#registered-model) to hold all the candidate models for your modeling tasks. You can create a registered model interactively within the Model Registry or programmatically with the Python SDK. +Create a [registered model]({{< relref "./model-management-concepts.md#registered-model" >}}) to hold all the candidate models for your modeling tasks. You can create a registered model interactively within the Model Registry or programmatically with the Python SDK. ## Programmatically create registered a model Programmatically register a model with the W&B Python SDK. W&B automatically creates a registered model for you if the registered model doesn't exist. @@ -44,7 +44,7 @@ Interactively create a registered model within the [Model Registry App](https:// {{% alert %}} -Manual linking a model to the model registry is useful for one-off models. However, it is often useful to [programmatically link model versions to the model registry](link-model-version#programmatically-link-a-model). +Manual linking a model to the model registry is useful for one-off models. However, it is often useful to [programmatically link model versions to the model registry]({{< relref "link-model-version#programmatically-link-a-model" >}}). For example, suppose you have a nightly job. It is tedious to manually link a model created each night. Instead, you could create a script that evaluates the model, and if the model improves in performance, link that model to the model registry with the W&B Python SDK. {{% /alert %}} \ No newline at end of file diff --git a/content/guides/models/registry/model_registry/link-model-version.md b/content/guides/models/registry/model_registry/link-model-version.md index d09973257..bcc1efa25 100644 --- a/content/guides/models/registry/model_registry/link-model-version.md +++ b/content/guides/models/registry/model_registry/link-model-version.md @@ -14,7 +14,7 @@ Link a model version to a registered model with the W&B App or programmatically ## Programmatically link a model -Use the [`link_model`](../../ref/python/run.md#link_model) method to programmatically log model files to a W&B run and link it to the [W&B Model Registry](./intro.md). +Use the [`link_model`]({{< relref "/ref/python/run.md#link_model" >}}) method to programmatically log model files to a W&B run and link it to the [W&B Model Registry]({{< relref "./" >}}). Ensure to replace other the values enclosed in `<>` with your own: diff --git a/content/guides/models/registry/model_registry/log-model-to-experiment.md b/content/guides/models/registry/model_registry/log-model-to-experiment.md index a730cc956..39bc31c03 100644 --- a/content/guides/models/registry/model_registry/log-model-to-experiment.md +++ b/content/guides/models/registry/model_registry/log-model-to-experiment.md @@ -12,11 +12,11 @@ weight: 3 Track a model, the model's dependencies, and other information relevant to that model with the W&B Python SDK. -Under the hood, W&B creates a lineage of [model artifact](./model-management-concepts.md#model-artifact) that you can view with the W&B App UI or programmatically with the W&B Python SDK. See the [Create model lineage map](./model-lineage.md) for more information. +Under the hood, W&B creates a lineage of [model artifact]({{< relref "./model-management-concepts.md#model-artifact" >}}) that you can view with the W&B App UI or programmatically with the W&B Python SDK. See the [Create model lineage map]({{< relref "./model-lineage.md" >}}) for more information. ## How to log a model -Use the `run.log_model` API to log a model. Provide the path where your model files are saved to the `path` parameter. The path can be a local file, directory, or [reference URI](../artifacts/track-external-files.md#amazon-s3--gcs--azure-blob-storage-references) to an external bucket such as `s3://bucket/path`. +Use the `run.log_model` API to log a model. Provide the path where your model files are saved to the `path` parameter. The path can be a local file, directory, or [reference URI]({{< relref "/guides/core/artifacts/track-external-files.md#amazon-s3--gcs--azure-blob-storage-references" >}}) to an external bucket such as `s3://bucket/path`. Optionally provide a name for the model artifact for the `name` parameter. If `name` is not specified, W&B uses the basename of the input path prepended with the run ID. diff --git a/content/guides/models/registry/model_registry/model-lineage.md b/content/guides/models/registry/model_registry/model-lineage.md index e316d5f9b..2083339d3 100644 --- a/content/guides/models/registry/model_registry/model-lineage.md +++ b/content/guides/models/registry/model_registry/model-lineage.md @@ -10,7 +10,7 @@ weight: 7 A useful feature of logging model artifacts to W&B are lineage graphs. Lineage graphs show artifacts logged by a run as well as artifacts used by specific run. -This means that, when you log a model artifact, you at a minimum have access to view the W&B run that used or produced the model artifact. If you [track a dependency](#track-an-artifact-dependency), you also see the inputs used by the model artifact. +This means that, when you log a model artifact, you at a minimum have access to view the W&B run that used or produced the model artifact. If you [track a dependency]({{< relref "#track-an-artifact-dependency" >}}), you also see the inputs used by the model artifact. For example, the proceeding image shows artifacts created and used throughout an ML experiment: diff --git a/content/guides/models/registry/model_registry/model-management-concepts.md b/content/guides/models/registry/model_registry/model-management-concepts.md index 33714d60b..e9d75385c 100644 --- a/content/guides/models/registry/model_registry/model-management-concepts.md +++ b/content/guides/models/registry/model_registry/model-management-concepts.md @@ -8,14 +8,14 @@ title: Model Registry Terms and Concepts weight: 2 --- -The following terms describe key components of the W&B Model Registry: [*model version*](#model-version), [*model artifact*](#model-artifact), and [*registered model*](#registered-model). +The following terms describe key components of the W&B Model Registry: [*model version*]({{< relref "#model-version" >}}), [*model artifact*]({{< relref "#model-artifact" >}}), and [*registered model*]({{< relref "#registered-model" >}}). ## Model version A model version represents a single model checkpoint. Model versions are a snapshot at a point in time of a model and its files within an experiment. A model version is an immutable directory of data and metadata that describes a trained model. W&B suggests that you add files to your model version that let you store (and restore) your model architecture and learned parameters at a later date. -A model version belongs to one, and only one, [model artifact](#model-artifact). A model version can belong to zero or more, [registered models](#registered-model). Model versions are stored in a model artifact in the order they are logged to the model artifact. W&B automatically creates a new model version if it detects that a model you log (to the same model artifact) has different contents than a previous model version. +A model version belongs to one, and only one, [model artifact]({{< relref "#model-artifact" >}}). A model version can belong to zero or more, [registered models]({{< relref "#registered-model" >}}). Model versions are stored in a model artifact in the order they are logged to the model artifact. W&B automatically creates a new model version if it detects that a model you log (to the same model artifact) has different contents than a previous model version. Store files within model versions that are produced from the serialization process provided by your modeling library (for example, [PyTorch](https://pytorch.org/tutorials/beginner/saving_loading_models.html) and [Keras](https://www.tensorflow.org/guide/keras/save_and_serialize)). @@ -42,16 +42,16 @@ Model tags are keywords or labels that belong to one or more registered models. Use model tags to organize registered models into categories and to search over those categories in the Model Registry's search bar. Model tags appear at the top of the Registered Model Card. You might choose to use them to group your registered models by ML task, owning team, or priority. The same model tag can be added to multiple registered models to allow for grouping. {{% alert %}} -Model tags, which are labels applied to registered models for grouping and discoverability, are different from [model aliases](#model-alias). Model aliases are unique identifiers or nicknames that you use to fetch a model version programatically. To learn more about using tags to organize the tasks in your Model Registry, see [Organize models](./organize-models.md). +Model tags, which are labels applied to registered models for grouping and discoverability, are different from [model aliases]({{< relref "#model-alias" >}}). Model aliases are unique identifiers or nicknames that you use to fetch a model version programatically. To learn more about using tags to organize the tasks in your Model Registry, see [Organize models]({{< relref "./organize-models.md" >}}). {{% /alert %}} ## Model artifact -A model artifact is a collection of logged [model versions](#model-version). Model versions are stored in a model artifact in the order they are logged to the model artifact. +A model artifact is a collection of logged [model versions]({{< relref "#model-version" >}}). Model versions are stored in a model artifact in the order they are logged to the model artifact. A model artifact can contain one or more model versions. A model artifact can be empty if no model versions are logged to it. -For example, suppose you create a model artifact. During model training, you periodically save your model during checkpoints. Each checkpoint corresponds to its own [model version](#model-version). All of the model versions created during your model training and checkpoint saving are stored in the same model artifact you created at the beginning of your training script. +For example, suppose you create a model artifact. During model training, you periodically save your model during checkpoints. Each checkpoint corresponds to its own [model version]({{< relref "#model-version" >}}). All of the model versions created during your model training and checkpoint saving are stored in the same model artifact you created at the beginning of your training script. @@ -63,7 +63,7 @@ The proceeding image shows a model artifact that contains three model versions: View an [example model artifact here](https://wandb.ai/timssweeney/model_management_docs_official_v0/artifacts/model/mnist-zws7gt0n). ## Registered model -A registered model is a collection of pointers (links) to model versions. You can think of a registered model as a folder of "bookmarks" of candidate models for the same ML task. Each "bookmark" of a registered model is a pointer to a [model version](#model-version) that belongs to a [model artifact](#model-artifact). You can use [model tags](#model-tags) to group your registered models. +A registered model is a collection of pointers (links) to model versions. You can think of a registered model as a folder of "bookmarks" of candidate models for the same ML task. Each "bookmark" of a registered model is a pointer to a [model version]({{< relref "#model-version" >}}) that belongs to a [model artifact]({{< relref "#model-artifact" >}}). You can use [model tags]({{< relref "#model-tags" >}}) to group your registered models. Registered models often represent candidate models for a single modeling use case or task. For example, you might create registered model for different image classification task based on the model you use: `ImageClassifier-ResNet50`, `ImageClassifier-VGG16`, `DogBreedClassifier-MobileNetV2` and so on. Model versions are assigned version numbers in the order in which they were linked to the registered model. diff --git a/content/guides/models/registry/model_registry/walkthrough.md b/content/guides/models/registry/model_registry/walkthrough.md index fd54ea2e9..64ff926e6 100644 --- a/content/guides/models/registry/model_registry/walkthrough.md +++ b/content/guides/models/registry/model_registry/walkthrough.md @@ -68,7 +68,7 @@ def generate_raw_data(train_size=6000): (x_train, y_train), (x_eval, y_eval) = generate_raw_data() ``` -Next, upload the dataset to W&B. To do this, create an [artifact](../artifacts/intro.md) object and add the dataset to that artifact. +Next, upload the dataset to W&B. To do this, create an [artifact]({{< relref "/guides/core/artifacts/" >}}) object and add the dataset to that artifact. ```python project = "model-registry-dev" @@ -116,7 +116,7 @@ Train a model with the artifact dataset you created in the previous step. ### Declare dataset artifact as an input to the run -Declare the dataset artifact you created in a previous step as the input to the W&B run. This is particularly useful in the context of logging models because declaring an artifact as an input to a run lets you track the dataset (and the version of the dataset) used to train a specific model. W&B uses the information collected to create a [lineage map](./model-lineage.md). +Declare the dataset artifact you created in a previous step as the input to the W&B run. This is particularly useful in the context of logging models because declaring an artifact as an input to a run lets you track the dataset (and the version of the dataset) used to train a specific model. W&B uses the information collected to create a [lineage map]({{< relref "./model-lineage.md" >}}). Use the `use_artifact` API to both declare the dataset artifact as the input of the run and to retrieve the artifact itself. @@ -143,7 +143,7 @@ x_train = train_table.get_column("x_train", convert_to="numpy") y_train = train_table.get_column("y_train", convert_to="numpy") ``` -For more information about tracking the inputs and output of a model, see [Create model lineage](./model-lineage.md) map. +For more information about tracking the inputs and output of a model, see [Create model lineage]({{< relref "./model-lineage.md" >}}) map. ### Define and train model @@ -210,7 +210,7 @@ model.save(path) ## Log and link a model to the Model Registry -Use the [`link_model`](../../ref/python/run.md#link_model) API to log model one ore more files to a W&B run and link it to the [W&B Model Registry](./intro.md). +Use the [`link_model`]({{< relref "/ref/python/run.md#link_model" >}}) API to log model one ore more files to a W&B run and link it to the [W&B Model Registry]({{< relref "./" >}}). ```python path = "./model.h5" @@ -222,7 +222,7 @@ run.finish() W&B creates a registered model for you if the name you specify for `registered-model-name` does not already exist. -See [`link_model`](../../ref/python/run.md#link_model) in the API Reference guide for more information on optional parameters. +See [`link_model`]({{< relref "/ref/python/run.md#link_model" >}}) in the API Reference guide for more information on optional parameters. ## Evaluate the performance of a model It is common practice to evaluate the performance of a one or more models. @@ -248,7 +248,7 @@ x_eval = eval_table.get_column("x_eval", convert_to="numpy") y_eval = eval_table.get_column("y_eval", convert_to="numpy") ``` -Download the [model version](./model-management-concepts.md#model-version) from W&B that you want to evaluate. Use the `use_model` API to access and download your model. +Download the [model version]({{< relref "./model-management-concepts.md#model-version" >}}) from W&B that you want to evaluate. Use the `use_model` API to access and download your model. ```python alias = "latest" # alias @@ -277,7 +277,7 @@ run.log(data={"loss": (loss, _)}) ## Promote a model version -Mark a model version ready for the next stage of your machine learning workflow with a [*model alias*](./model-management-concepts.md#model-alias). Each registered model can have one or more model aliases. A model alias can only belong to a single model version at a time. +Mark a model version ready for the next stage of your machine learning workflow with a [*model alias*]({{< relref "./model-management-concepts.md#model-alias" >}}). Each registered model can have one or more model aliases. A model alias can only belong to a single model version at a time. For example, suppose that after evaluating a model's performance, you are confident that the model is ready for production. To promote that model version, add the `production` alias to that specific model version. diff --git a/content/guides/models/registry/model_registry_eol.md b/content/guides/models/registry/model_registry_eol.md index 612bf0871..7c5b24c2c 100644 --- a/content/guides/models/registry/model_registry_eol.md +++ b/content/guides/models/registry/model_registry_eol.md @@ -7,7 +7,7 @@ title: Migrate from legacy Model Registry weight: 8 --- -W&B will transition assets from the legacy [W&B Model Registry](../model_registry/intro.md) to the new [W&B Registry](./intro.md). This migration will be fully managed and triggered by W&B, requiring no intervention from users. The process is designed to be as seamless as possible, with minimal disruption to existing workflows. +W&B will transition assets from the legacy [W&B Model Registry]({{< relref "/guides/models/registry/model_registry/" >}}) to the new [W&B Registry]({{< relref "./" >}}). This migration will be fully managed and triggered by W&B, requiring no intervention from users. The process is designed to be as seamless as possible, with minimal disruption to existing workflows. The transition will take place once the new W&B Registry includes all the functionalities currently available in the Model Registry. W&B will attempt to preserve current workflows, codebases, and references. @@ -28,10 +28,10 @@ Artifacts linked to the legacy Model Registry have team level visibility. This m ### Restrict visibility to a registry -Restrict who can view and access a custom registry. You can restrict visibility to a registry when you create a custom registry or after you create a custom registry. In a Restricted registry, only selected members can access the content, maintaining privacy and control. For more information about registry visibility, see [Registry visibility types](./configure_registry.md#registry-visibility-types). +Restrict who can view and access a custom registry. You can restrict visibility to a registry when you create a custom registry or after you create a custom registry. In a Restricted registry, only selected members can access the content, maintaining privacy and control. For more information about registry visibility, see [Registry visibility types]({{< relref "./configure_registry.md#registry-visibility-types" >}}). ### Create custom registries -Unlike the legacy Model Registry, W&B Registry is not limited to models or dataset registries. You can create custom registries tailored to specific workflows or project needs, capable of holding any arbitrary object type. This flexibility allows teams to organize and manage artifacts according to their unique requirements. For more information on how to create a custom registry, see [Create a custom registry](./create_registry.md). +Unlike the legacy Model Registry, W&B Registry is not limited to models or dataset registries. You can create custom registries tailored to specific workflows or project needs, capable of holding any arbitrary object type. This flexibility allows teams to organize and manage artifacts according to their unique requirements. For more information on how to create a custom registry, see [Create a custom registry]({{< relref "./create_registry.md" >}}). {{< img src="/images/registry/mode_reg_eol.png" alt="" >}} @@ -61,7 +61,7 @@ W&B will migrate registered models (now called collections) and associated artif ### Team visibility to organization visibility -After the migration, your model registry will have organization level visibility. You can restrict who has access to a registry by [assigning roles](./configure_registry.md). This helps ensure that only specific members have access to specific registries. +After the migration, your model registry will have organization level visibility. You can restrict who has access to a registry by [assigning roles]({{< relref "./configure_registry.md" >}}). This helps ensure that only specific members have access to specific registries. The migration will preserve existing permission boundaries of your current team-level registered models (soon to be called collections) in the legacy W&B Model Registry. Permissions currently defined in the legacy Model Registry will be preserved in the new Registry. This means that collections currently restricted to specific team members will remain protected during and after the migration. @@ -83,7 +83,7 @@ Users are encouraged to explore the new features and capabilities available in t Support is available if you are interested in trying the W&B Registry early, or for new users that prefer to start with Registry and not the legacy W&B Model Registry. Contact support@wandb.com or your Sales MLE to enable this functionality. Note that any early migration will be into a BETA version. The BETA version of W&B Registry might not have all the functionality or features of the legacy Model Registry. -For more details and to learn about the full range of features in the W&B Registry, visit the [W&B Registry Guide](./intro.md). +For more details and to learn about the full range of features in the W&B Registry, visit the [W&B Registry Guide]({{< relref "./" >}}). ## FAQs diff --git a/content/guides/models/registry/organize-with-tags.md b/content/guides/models/registry/organize-with-tags.md index 8b1de0b04..5546b7165 100644 --- a/content/guides/models/registry/organize-with-tags.md +++ b/content/guides/models/registry/organize-with-tags.md @@ -66,7 +66,7 @@ collection.save() Update a tag programmatically by reassigning or by mutating the `tags` attribute. W&B recommends, and it is good Python practice, that you reassign the `tags` attribute instead of in-place mutation. -For example, the proceeding code snippet shows common ways to update a list with reassignment. For brevity, we continue the code example from the [Add a tag to a collection section](#add-a-tag-to-a-collection): +For example, the proceeding code snippet shows common ways to update a list with reassignment. For brevity, we continue the code example from the [Add a tag to a collection section]({{< relref "#add-a-tag-to-a-collection" >}}): ```python collection.tags = [*collection.tags, "new-tag", "other-tag"] @@ -190,7 +190,7 @@ artifact.save() Update a tag programmatically by reassigning or by mutating the `tags` attribute. W&B recommends, and it is good Python practice, that you reassign the `tags` attribute instead of in-place mutation. -For example, the proceeding code snippet shows common ways to update a list with reassignment. For brevity, we continue the code example from the [Add a tag to an artifact version section](#add-a-tag-to-an-artifact-version): +For example, the proceeding code snippet shows common ways to update a list with reassignment. For brevity, we continue the code example from the [Add a tag to an artifact version section]({{< relref "#add-a-tag-to-an-artifact-version" >}}): ```python artifact.tags = [*artifact.tags, "new-tag", "other-tag"] diff --git a/content/guides/models/registry/registry_types.md b/content/guides/models/registry/registry_types.md index 785b11ab2..e6e376ec5 100644 --- a/content/guides/models/registry/registry_types.md +++ b/content/guides/models/registry/registry_types.md @@ -7,7 +7,7 @@ title: Registry types weight: 1 --- -W&B supports two types of registries: [Core registries](#core-registry) and [Custom registries](#custom-registry). +W&B supports two types of registries: [Core registries]({{< relref "#core-registry" >}}) and [Custom registries]({{< relref "#custom-registry" >}}). ## Core registry A core registry is a template for specific use cases: **Models** and **Datasets**. @@ -20,7 +20,7 @@ By default, the **Models** registry is configured to accept `"model"` artifact t The preceding image shows the **Models** and the **Dataset** core registry along with a custom registry called **Fine_Tuned_Models** in the W&B Registry App UI. -A core registry has [organization visibility](./configure_registry.md#registry-visibility-types). A registry admin can not change the visibility of a core registry. +A core registry has [organization visibility]({{< relref "./configure_registry.md#registry-visibility-types" >}}). A registry admin can not change the visibility of a core registry. ## Custom registry Custom registries are not restricted to `"model"` artifact types or `"dataset"` artifact types. @@ -31,9 +31,9 @@ For example, you might create a registry called "Benchmark_Datasets" for organiz {{< img src="/images/registry/custom_registry_example.png" alt="" >}} -A custom registry can have either [organization or restricted visibility](./configure_registry.md#registry-visibility-types). A registry admin can change the visibility of a custom registry from organization to restricted. However, the registry admin can not change a custom registry's visibility from restricted to organizational visibility. +A custom registry can have either [organization or restricted visibility]({{< relref "./configure_registry.md#registry-visibility-types" >}}). A registry admin can change the visibility of a custom registry from organization to restricted. However, the registry admin can not change a custom registry's visibility from restricted to organizational visibility. -For information on how to create a custom registry, see [Create a custom registry](./create_collection.md). +For information on how to create a custom registry, see [Create a custom registry]({{< relref "./create_collection.md" >}}). ## Summary diff --git a/content/guides/models/sweeps/_index.md b/content/guides/models/sweeps/_index.md index 043f1b5fa..00a586697 100644 --- a/content/guides/models/sweeps/_index.md +++ b/content/guides/models/sweeps/_index.md @@ -18,7 +18,7 @@ Use W&B Sweeps to automate hyperparameter search and visualize rich, interactive {{< img src="/images/sweeps/intro_what_it_is.png" alt="Draw insights from large hyperparameter tuning experiments with interactive dashboards." >}} ### How it works -Create a sweep with two [W&B CLI](../../ref/cli/README.md) commands: +Create a sweep with two [W&B CLI]({{< relref "/ref/cli/" >}}) commands: 1. Initialize a sweep @@ -34,7 +34,7 @@ wandb agent
-## Weave
+## W&B Weave
##### Use AI models in your app
@@ -24,7 +24,7 @@ Use [W&B Weave](https://weave-docs.wandb.ai/) to manage all aspects of integrati
{{% /card %}}
{{% card %}}
-## Models
+## W&B Models
##### Build AI models
diff --git a/content/guides/_index.md b/content/guides/_index.md
index 7557af4ed..221af4ea6 100644
--- a/content/guides/_index.md
+++ b/content/guides/_index.md
@@ -27,15 +27,15 @@ W&B consists of three major components: [Models]({{< relref "/guides/models.md"
- [Sweeps]({{< relref "/guides/models/sweeps/" >}}): Hyperparameter tuning and model optimization
- [Registry]({{< relref "/guides/models/registry/" >}}): Publish and share your ML models and datasets
-**[W&B Weave](/guides/weave/)** is a lightweight toolkit for tracking and evaluating LLM applications.
+**[W&B Weave]({{< relref "/guides/weave/" >}})** is a lightweight toolkit for tracking and evaluating LLM applications.
**[W&B Core]({{< relref "/guides/core/" >}})** is set of powerful building blocks for tracking and visualizing data and models, and communicating results.
- [Artifacts]({{< relref "/guides/core/artifacts/" >}}): Version assets and track lineage
- [Tables]({{< relref "/guides/core/tables/" >}}): Visualize and query tabular data
- [Reports]({{< relref "/guides/core/reports/" >}}): Document and collaborate on your discoveries
-
## How does W&B work?
+
Read the following sections in this order if you are a first-time user of W&B and you are interested in training, tracking, and visualizing machine learning models and experiments:
1. Learn about [runs]({{< relref "/guides/models/track/runs/" >}}), W&B's basic unit of computation.
diff --git a/content/guides/core/reports/reports-gallery.md b/content/guides/core/reports/reports-gallery.md
index 4ef109a9d..798c6c338 100644
--- a/content/guides/core/reports/reports-gallery.md
+++ b/content/guides/core/reports/reports-gallery.md
@@ -50,8 +50,4 @@ Tell the story of a project, which you and others can reference later to underst
{{< img src="/images/reports/intro_work_log_2.png" alt="" >}}
-See the [Learning Dexterity End-to-End Using W&B Reports](https://bit.ly/wandb-learning-dexterity) for an example of how W&B Reports were used to explore how the OpenAI Robotics team used W&B Reports to run massive machine learning projects.
-
-
-
-
\ No newline at end of file
+See the [Learning Dexterity End-to-End Using W&B Reports](https://bit.ly/wandb-learning-dexterity) for an example of how W&B Reports were used to explore how the OpenAI Robotics team used W&B Reports to run massive machine learning projects.
\ No newline at end of file
diff --git a/content/guides/hosting/data-security/presigned-urls.md b/content/guides/hosting/data-security/presigned-urls.md
index bad5297ad..2ecd3e030 100644
--- a/content/guides/hosting/data-security/presigned-urls.md
+++ b/content/guides/hosting/data-security/presigned-urls.md
@@ -27,7 +27,7 @@ In case of AWS, one can use [VPC or IP address based network restriction](https:
## Audit logs
-W&B also recommends to use [W&B audit logs](../monitoring-usage/audit-logging.md) in addition to blob storage specific audit logs. For latter, refer to [AWS S3 access logs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html),[Google Cloud Storage audit logs](https://cloud.google.com/storage/docs/audit-logging) and [Monitor Azure blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/monitor-blob-storage). Admin and security teams can use audit logs to keep track of which user is doing what in the W&B product and take necessary action if they determine that some operations need to be limited for certain users.
+W&B also recommends to use [W&B audit logs]({{< relref "../monitoring-usage/audit-logging.md" >}}) in addition to blob storage specific audit logs. For latter, refer to [AWS S3 access logs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html),[Google Cloud Storage audit logs](https://cloud.google.com/storage/docs/audit-logging) and [Monitor Azure blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/monitor-blob-storage). Admin and security teams can use audit logs to keep track of which user is doing what in the W&B product and take necessary action if they determine that some operations need to be limited for certain users.
{{% alert %}}
Pre-signed URLs are the only supported blob storage access mechanism in W&B. W&B recommends configuring some or all of the above list of security controls depending on your risk appetite.
diff --git a/content/guides/hosting/data-security/private-connectivity.md b/content/guides/hosting/data-security/private-connectivity.md
index f1d18bd9b..2cc060407 100644
--- a/content/guides/hosting/data-security/private-connectivity.md
+++ b/content/guides/hosting/data-security/private-connectivity.md
@@ -7,7 +7,7 @@ title: Configure private connectivity to Dedicated Cloud
weight: 4
---
-You can connect to your [Dedicated Cloud](../hosting-options/dedicated_cloud.md) instance over the cloud provider's secure private network. This applies to the access from your AI workloads to the W&B APIs and optionally from your user browsers to the W&B app UI as well. When using private connectivity, the relevant requests and responses do not transit through the public network or internet.
+You can connect to your [Dedicated Cloud]({{< relref "../hosting-options/dedicated_cloud.md" >}}) instance over the cloud provider's secure private network. This applies to the access from your AI workloads to the W&B APIs and optionally from your user browsers to the W&B app UI as well. When using private connectivity, the relevant requests and responses do not transit through the public network or internet.
{{% alert %}}
Secure private connectivity is available in preview as an advanced security option with Dedicated Cloud.
diff --git a/content/guides/integrations/lightning.md b/content/guides/integrations/lightning.md
index b3c16e643..ea82f9048 100644
--- a/content/guides/integrations/lightning.md
+++ b/content/guides/integrations/lightning.md
@@ -63,7 +63,7 @@ fabric.log_dict({"important_metric": important_metric})
3. In your browser, find your API key on the [Authorize page](https://wandb.ai/authorize).
-4. If you are using Weights and Biases for the first time you might want to check out our [**quickstart**](../../quickstart.md)
+4. If you are using Weights and Biases for the first time you might want to check out our [**quickstart**]({{< relref "/guides/quickstart.md" >}})
{{< tabpane text=true >}}
{{% tab header="Command Line" value="cli" %}}
@@ -300,7 +300,7 @@ for epoch in range(num_epochs):
## Log the min/max of a metric
-Using wandb's [`define_metric`](/ref/python/run#define_metric) function you can define whether you'd like your W&B summary metric to display the min, max, mean or best value for that metric. If `define`_`metric` _ isn't used, then the last value logged with appear in your summary metrics. See the `define_metric` [reference docs here](/ref/python/run#define_metric) and the [guide here](/guides/models/track/log/customize-logging-axes) for more.
+Using wandb's [`define_metric`]({{< relref "/ref/python/run#define_metric" >}}) function you can define whether you'd like your W&B summary metric to display the min, max, mean or best value for that metric. If `define`_`metric` _ isn't used, then the last value logged with appear in your summary metrics. See the `define_metric` [reference docs here]({{< relref "/ref/python/run#define_metric" >}}) and the [guide here]({{< relref "/guides/models/track/log/customize-logging-axes" >}}) for more.
To tell W&B to keep track of the max validation accuracy in the W&B summary metric, call `wandb.define_metric` only once, at the beginning of training:
@@ -338,7 +338,7 @@ fabric.log_dict({"val_accuracy": val_accuracy})
## Checkpoint a model
-To save model checkpoints as W&B [Artifacts](/guides/core/artifacts/),
+To save model checkpoints as W&B [Artifacts]({{< relref "/guides/core/artifacts/" >}}),
use the Lightning [`ModelCheckpoint`](https://pytorch-lightning.readthedocs.io/en/stable/api/pytorch_lightning.callbacks.ModelCheckpoint.html#pytorch_lightning.callbacks.ModelCheckpoint) callback and set the `log_model` argument in the `WandbLogger`.
{{< tabpane text=true >}}
@@ -361,7 +361,7 @@ fabric = L.Fabric(loggers=[wandb_logger], callbacks=[checkpoint_callback])
{{< /tabpane >}}
-The _latest_ and _best_ aliases are automatically set to easily retrieve a model checkpoint from a W&B [Artifact](/guides/core/artifacts/):
+The _latest_ and _best_ aliases are automatically set to easily retrieve a model checkpoint from a W&B [Artifact]({{< relref "/guides/core/artifacts/" >}}):
```python
# reference can be retrieved in artifacts panel
@@ -414,11 +414,11 @@ optimizer.load_state_dict(full_checkpoint["optimizer"])
{{% /tab %}}
{{< /tabpane >}}
-The model checkpoints you log are viewable through the [W&B Artifacts](/guides/core/artifacts) UI, and include the full model lineage (see an example model checkpoint in the UI [here](https://wandb.ai/wandb/arttest/artifacts/model/iv3_trained/5334ab69740f9dda4fed/lineage?_gl=1*yyql5q*_ga*MTQxOTYyNzExOS4xNjg0NDYyNzk1*_ga_JH1SJHJQXJ*MTY5MjMwNzI2Mi4yNjkuMS4xNjkyMzA5NjM2LjM3LjAuMA..)).
+The model checkpoints you log are viewable through the [W&B Artifacts]({{< relref "/guides/core/artifacts" >}}) UI, and include the full model lineage (see an example model checkpoint in the UI [here](https://wandb.ai/wandb/arttest/artifacts/model/iv3_trained/5334ab69740f9dda4fed/lineage?_gl=1*yyql5q*_ga*MTQxOTYyNzExOS4xNjg0NDYyNzk1*_ga_JH1SJHJQXJ*MTY5MjMwNzI2Mi4yNjkuMS4xNjkyMzA5NjM2LjM3LjAuMA..)).
-To bookmark your best model checkpoints and centralize them across your team, you can link them to the [W&B Model Registry](/guides/models).
+To bookmark your best model checkpoints and centralize them across your team, you can link them to the [W&B Model Registry]({{< relref "/guides/models" >}}).
-Here you can organize your best models by task, manage model lifecycle, facilitate easy tracking and auditing throughout the ML lifecyle, and [automate](/guides/core/artifacts/project-scoped-automations/#create-a-webhook-automation) downstream actions with webhooks or jobs.
+Here you can organize your best models by task, manage model lifecycle, facilitate easy tracking and auditing throughout the ML lifecyle, and [automate]({{< relref "/guides/models/automations/project-scoped-automations/#create-a-webhook-automation" >}}) downstream actions with webhooks or jobs.
## Log images, text, and more
@@ -617,7 +617,7 @@ The core integration is based on the [Lightning `loggers` API](https://pytorch-l
### What does the integration log without any additional code?
-We'll save your model checkpoints to W&B, where you can view them or download them for use in future runs. We'll also capture [system metrics](../app/features/system-metrics.md), like GPU usage and network I/O, environment information, like hardware and OS information, [code state](../app/features/panels/code.md) (including git commit and diff patch, notebook contents and session history), and anything printed to the standard out.
+We'll save your model checkpoints to W&B, where you can view them or download them for use in future runs. We'll also capture [system metrics]({{< relref "/guides/models/app/settings-page/system-metrics.md" >}}), like GPU usage and network I/O, environment information, like hardware and OS information, [code state]({{< relref "/guides/models/app/features/panels/code.md" >}}) (including git commit and diff patch, notebook contents and session history), and anything printed to the standard out.
### What if I need to use `wandb.run` in my training setup?
From a78c4d4d05e5e739613fdacf7018212d467b5464 Mon Sep 17 00:00:00 2001
From: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Date: Wed, 15 Jan 2025 09:33:01 -0800
Subject: [PATCH 04/13] Docs share panels (#981)
## Description
Docs on linking to a specific panel.
## Ticket
https://wandb.atlassian.net/browse/DOCS-1156
---------
Co-authored-by: Matt Linville
---
content/guides/models/app/features/panels/_index.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/content/guides/models/app/features/panels/_index.md b/content/guides/models/app/features/panels/_index.md
index 3be2f11ab..0da7bb2d5 100644
--- a/content/guides/models/app/features/panels/_index.md
+++ b/content/guides/models/app/features/panels/_index.md
@@ -61,6 +61,7 @@ To add a custom panel to your workspace:
To learn more about the options for each type of panel, refer to the relevant section below, such as [Line plots]({{< relref "line-plot/" >}}) or [Bar plots]({{< relref "bar-plot.md" >}}).
+
## Manage panels
### Edit a panel
@@ -103,6 +104,17 @@ To remove all panels from a manual workspace, click its action `...` menu, then
To remove all panels from an automatic or manual workspace, you can [reset the workspace]({{< relref "#reset-a-workspace" >}}). Select **Automatic** to start with the default set of panels, or select **Manual** to start with an empty workspace with no panels.
+### Share a full-screen panel directly
+Direct colleagues to a specific panel in your project. The link redirects users to a full screen view of that panel when they click that link. To create a link to a panel:
+
+1. Hover your mouse over the panel.
+2. Select the action `...` menu.
+3. Click **Copy panel URL**.
+
+The settings of the project determine who can view the panel. This means that if the project is private, only members of the project can view the panel. If the project is public, anyone with the link can view the panel.
+
+If multiple panels have the same name, W&B shares the first panel with the name.
+
## Manage sections
By default, sections in a workspace reflect the logging hierarchy of your keys. However, in a manual workspace, sections appear only after you start adding panels.
From a2a9a9d4e274052296d7a7532fab07866b3f72a9 Mon Sep 17 00:00:00 2001
From: johndmulhausen
Date: Wed, 15 Jan 2025 12:50:52 -0500
Subject: [PATCH 05/13] Update feedback links
---
hugo.yaml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/hugo.yaml b/hugo.yaml
index a11a1d5dd..c39f015cc 100644
--- a/hugo.yaml
+++ b/hugo.yaml
@@ -173,9 +173,9 @@ params:
enable: true
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
'yes': >-
- Glad to hear it! Please tell us how we can improve.
+ Glad to hear it! Please tell us how we can improve.
'no': >-
- Sorry to hear that. Please tell us how we can improve.
+ Sorry to hear that. Please tell us how we can improve.
# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
From d96b966c9e55208ae7f0952235ad48d69ba5b9cb Mon Sep 17 00:00:00 2001
From: Nicolas Remerscheid
Date: Wed, 15 Jan 2025 21:08:48 +0100
Subject: [PATCH 06/13] Fix broken image in weave_models_registry.md (#990)
## Description
Fix the broken overview image.
## Ticket
Didn't create an issue.
---
content/tutorials/weave_models_registry.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/content/tutorials/weave_models_registry.md b/content/tutorials/weave_models_registry.md
index 19d37e61c..0543bb41f 100644
--- a/content/tutorials/weave_models_registry.md
+++ b/content/tutorials/weave_models_registry.md
@@ -15,7 +15,7 @@ This notebook shows how to use W&B Weave together with W&B Models. Specifically,
Find the public workspace for both W&B Models and W&B Weave [here](https://wandb.ai/wandb-smle/weave-cookboook-demo/weave/evaluations).
-
+
The workflow covers the following steps:
@@ -224,4 +224,4 @@ with wandb.init(project=PROJECT, entity=ENTITY) as run:
run.link_artifact(
artifact_model, target_path="wandb32/wandb-registry-RAG Models/RAG Model"
)
-```
\ No newline at end of file
+```
From 9d779557ad6a788c0ca5e811b47fefa989b8c774 Mon Sep 17 00:00:00 2001
From: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Date: Wed, 15 Jan 2025 12:10:54 -0800
Subject: [PATCH 07/13] Revert "Fix broken image in weave_models_registry.md"
(#994)
Reverts wandb/docs#990
---
content/tutorials/weave_models_registry.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/content/tutorials/weave_models_registry.md b/content/tutorials/weave_models_registry.md
index 0543bb41f..19d37e61c 100644
--- a/content/tutorials/weave_models_registry.md
+++ b/content/tutorials/weave_models_registry.md
@@ -15,7 +15,7 @@ This notebook shows how to use W&B Weave together with W&B Models. Specifically,
Find the public workspace for both W&B Models and W&B Weave [here](https://wandb.ai/wandb-smle/weave-cookboook-demo/weave/evaluations).
-
+
The workflow covers the following steps:
@@ -224,4 +224,4 @@ with wandb.init(project=PROJECT, entity=ENTITY) as run:
run.link_artifact(
artifact_model, target_path="wandb32/wandb-registry-RAG Models/RAG Model"
)
-```
+```
\ No newline at end of file
From 6afff1c7b729c117d472813eb3805b6be3d6dc60 Mon Sep 17 00:00:00 2001
From: Audrey <16946477+AudreyBeard@users.noreply.github.com>
Date: Wed, 15 Jan 2025 16:03:11 -0500
Subject: [PATCH 08/13] Fix mixed-up CLI / Python labels for Sweep
configuration examples (#993)
Follow-on from #991, adjusted per @johndmulhausen 's request
Sweep configuration options (CLI / Python) examples were mixed up, such
that the Python dictionary specification was labeled "CLI" and the YAML
specification was labeled "Python script or Jupyter notebook".
## Description
This change fixes the mislabeled Sweep configuration by correctly
labeling each of the two examples.
Co-authored-by: Matt Linville
---
.../define-sweep-configuration/_index.md | 38 +++++++++----------
1 file changed, 19 insertions(+), 19 deletions(-)
diff --git a/content/guides/models/sweeps/define-sweep-configuration/_index.md b/content/guides/models/sweeps/define-sweep-configuration/_index.md
index 520b6fd28..cf0cbcee2 100644
--- a/content/guides/models/sweeps/define-sweep-configuration/_index.md
+++ b/content/guides/models/sweeps/define-sweep-configuration/_index.md
@@ -32,25 +32,6 @@ For example, the proceeding code snippets show the same sweep configuration defi
{{< tabpane text=true >}}
{{% tab header="CLI" %}}
-Define a sweep in a Python dictionary data structure if you define training algorithm in a Python script or Jupyter notebook.
-
-The proceeding code snippet stores a sweep configuration in a variable named `sweep_configuration`:
-
-```python title="train.py"
-sweep_configuration = {
- "name": "sweepdemo",
- "method": "bayes",
- "metric": {"goal": "minimize", "name": "validation_loss"},
- "parameters": {
- "learning_rate": {"min": 0.0001, "max": 0.1},
- "batch_size": {"values": [16, 32, 64]},
- "epochs": {"values": [5, 10, 15]},
- "optimizer": {"values": ["adam", "sgd"]},
- },
-}
-```
- {{% /tab %}}
- {{% tab header="Python script or Jupyter notebook" %}}
Define a sweep configuration in a YAML file if you want to manage sweeps interactively from the command line (CLI)
```yaml title="config.yaml"
@@ -70,6 +51,25 @@ parameters:
values: [5, 10, 15]
optimizer:
values: ["adam", "sgd"]
+```
+ {{% /tab %}}
+ {{% tab header="Python script or Jupyter notebook" %}}
+Define a sweep in a Python dictionary data structure if you define training algorithm in a Python script or Jupyter notebook.
+
+The proceeding code snippet stores a sweep configuration in a variable named `sweep_configuration`:
+
+```python title="train.py"
+sweep_configuration = {
+ "name": "sweepdemo",
+ "method": "bayes",
+ "metric": {"goal": "minimize", "name": "validation_loss"},
+ "parameters": {
+ "learning_rate": {"min": 0.0001, "max": 0.1},
+ "batch_size": {"values": [16, 32, 64]},
+ "epochs": {"values": [5, 10, 15]},
+ "optimizer": {"values": ["adam", "sgd"]},
+ },
+}
```
{{% /tab %}}
{{< /tabpane >}}
From 57d006a50cc928fab23b250a25250056a3a9d02c Mon Sep 17 00:00:00 2001
From: John Mulhausen
Date: Wed, 15 Jan 2025 16:23:45 -0500
Subject: [PATCH 09/13] Add JavaScript to CodeQL scanning CI (#992)
## Description
What it says on the tin. :) Just realizing it's likely we'll touch some
JS on the site, would be good to have it properly conforming to best
practices.
---
.github/workflows/codeql.yml | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
index 595aeb8ef..0d154b278 100644
--- a/.github/workflows/codeql.yml
+++ b/.github/workflows/codeql.yml
@@ -19,6 +19,7 @@ on:
branches: [ "main" ]
paths:
- '**/*.py'
+ - '**/*.js'
jobs:
analyze:
@@ -32,7 +33,7 @@ jobs:
strategy:
fail-fast: false
matrix:
- language: [ 'python' ]
+ language: [ 'python', 'javascript' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
From fad645620684628a94afe3f30261d912d43a3aec Mon Sep 17 00:00:00 2001
From: Matt Linville
Date: Wed, 15 Jan 2025 13:40:11 -0800
Subject: [PATCH 10/13] Fix TOC for reference architecture (#984)
## Description
Fix port of https://github.com/wandb/docs/pull/933 to replicate
[Docusaurus
TOC](https://3c25867f.docodile.pages.dev/guides/hosting/hosting-options/self-managed/)
in Hugo
## Ticket
Does this PR fix an existing issue? If yes, provide a link here.
---
.../self-managed/bare-metal.md | 75 ++--------
.../self-managed/basic-setup.md | 136 ------------------
.../kubernetes-operator/_index.md | 2 +-
.../{install-on-public-cloud => }/ref-arch.md | 8 +-
.../self-managed/server-upgrade-process.md | 1 +
5 files changed, 17 insertions(+), 205 deletions(-)
delete mode 100644 content/guides/hosting/hosting-options/self-managed/basic-setup.md
rename content/guides/hosting/hosting-options/self-managed/{install-on-public-cloud => }/ref-arch.md (98%)
diff --git a/content/guides/hosting/hosting-options/self-managed/bare-metal.md b/content/guides/hosting/hosting-options/self-managed/bare-metal.md
index ace2a1f42..b2e3216b4 100644
--- a/content/guides/hosting/hosting-options/self-managed/bare-metal.md
+++ b/content/guides/hosting/hosting-options/self-managed/bare-metal.md
@@ -5,6 +5,7 @@ menu:
identifier: bare-metal
parent: self-managed
title: Deploy W&B Platform On-premises
+weight: 5
---
{{% alert %}}
@@ -16,69 +17,7 @@ Reach out to the W&B Sales Team for related question: [contact@wandb.com](mailto
## Infrastructure guidelines
-Before you start deploying W&B, refer to the [reference architecture]({{< relref "./install-on-public-cloud/ref-arch.md#infrastructure-requirements" >}}), especially the infrastructure requirements.
-
-{{% alert %}}
-W&B strongly recommends to deploy W&B Server into a Kubernetes cluster using the W&B Kubernetes Operator. Deploying to a Kubernetes cluster with the operator ensures that you can use all the existing and latest W&B features.
-{{% /alert %}}
-
-{{% alert color="secondary" %}}
-W&B application performance depends on scalable data stores that your operations team must configure and manage. The team must provide a MySQL 8 database cluster and an AWS S3 compatible object store for the application to scale properly.
-{{% /alert %}}
-
-### Application server
-
-W&B recommends deploying W&B Server into its own namespace and a two availability zone node group with the following specifications to provide the best performance, reliability, and availability:
-
-| Specification | Value |
-|----------------------------|-----------------------------------|
-| Bandwidth | Dual 10 Gigabit+ Ethernet Network |
-| Root Disk Bandwidth (Mbps) | 4,750+ |
-| Root Disk Provision (GB) | 100+ |
-| Core Count | 4 |
-| Memory (GiB) | 8 |
-
-This ensures that W&B Server has sufficient disk space to process the application data and store temporary logs before they are externalized.
-
-
-
-It also ensures fast and reliable data transfer, the necessary processing power and memory for smooth operation, and that W&B will not be affected by any noisy neighbors.
-
-It is important to keep in mind that these specifications are minimum requirements, and actual resource needs may vary depending on the specific usage and workload of the W&B application. Monitoring the resource usage and performance of the application is critical to ensure that it operates optimally and to make adjustments as necessary.
-
-### Database server
-
-W&B recommends a [MySQL 8]({{< relref "#mysql-database" >}}) database as a metadata store. The shape of the model parameters and related metadata impact the performance of the database. The database size grows as the ML practitioners track more training runs, and incurs read heavy load when queries are executed in run tables, users workspaces, and reports.
-
-To ensure optimal performance W&B recommends deploying the W&B database on to a server with the following starting specs:
-
-| Specification | Value |
-|--------------------------- |-----------------------------------|
-| Bandwidth | Dual 10 Gigabit+ Ethernet Network |
-| Root Disk Bandwidth (Mbps) | 4,750+ |
-| Root Disk Provision (GB) | 1000+ |
-| Core Count | 4 |
-| Memory (GiB) | 32 |
-
-Again, W&B recommends monitoring the resource usage and performance of the database to ensure that it operates optimally and to make adjustments as necessary.
-
-Additionally, W&B recommends the following [parameter overrides]({{< relref "#mysql-database" >}}) to tune the DB for MySQL 8.
-
-### Object storage
-
-W&B is compatible with an object storage that supports S3 API interface, Signed URLs and CORS. W&B recommends specifying the storage array to the current needs of your practitioners and to capacity plan on a regular cadence.
-
-More details on object store configuration can be found in the [how-to section]({{< relref "/guides/hosting/hosting-options/self-managed/bare-metal.md#object-store" >}}).
-
-Some tested and working providers:
-- [MinIO](https://min.io/)
-- [Ceph](https://ceph.io/)
-- [NetApp](https://www.netapp.com/)
-- [Pure Storage](https://www.purestorage.com/)
-
-#### Secure Storage Connector
-
-The [Secure Storage Connector]({{< relref "/guides/hosting/data-security/secure-storage-connector.md" >}}) is not available for teams at this time for bare metal deployments.
+Before you start deploying W&B, refer to the [reference architecture]({{< relref "ref-arch.md#infrastructure-requirements" >}}), especially the infrastructure requirements.
## MySQL database
@@ -115,6 +54,11 @@ CREATE DATABASE wandb_local CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;
GRANT ALL ON wandb_local.* TO 'wandb_local'@'%' WITH GRANT OPTION;
```
+{{% alert %}}
+This works only if the SSL certificate is trusted. W&B does not support self-signed certificates.
+{{% /alert %}}
+
+
### Parameter group configuration
Ensure that the following parameter groups are set to tune the database performance:
@@ -159,7 +103,7 @@ s3://$ACCESS_KEY:$SECRET_KEY@$HOST/$BUCKET_NAME?tls=true
```
{{% alert color="secondary" %}}
-This will only work if the SSL certificate is trusted. W&B does not support self-signed certificates.
+This works only if the SSL certificate is trusted. W&B does not support self-signed certificates.
{{% /alert %}}
Set `BUCKET_QUEUE` to `internal://` if you use third-party object stores. This tells the W&B server to manage all object notifications internally instead of depending on an external SQS queue or equivalent.
@@ -188,7 +132,6 @@ mc mb --region=us-east1 local/local-files
The recommended installation method is with the official W&B Helm chart. Follow [this section]({{< relref "./kubernetes-operator/#deploy-wb-with-helm-cli" >}}) to deploy the W&B Server application.
-
### OpenShift
W&B supports operating from within an [OpenShift Kubernetes cluster](https://www.redhat.com/en/technologies/cloud-computing/openshift).
@@ -310,7 +253,7 @@ wandb login --host=https://YOUR_DNS_DOMAIN
wandb verify
```
-Check log files to view any errors the W&B Server hits at startup. Run the following commands:
+Check log files to view any errors the W&B Server hits at startup. Run the following commands:
{{< tabpane text=true >}}
{{% tab header="Docker" value="docker" %}}
diff --git a/content/guides/hosting/hosting-options/self-managed/basic-setup.md b/content/guides/hosting/hosting-options/self-managed/basic-setup.md
deleted file mode 100644
index 0370b95ab..000000000
--- a/content/guides/hosting/hosting-options/self-managed/basic-setup.md
+++ /dev/null
@@ -1,136 +0,0 @@
----
-description: Run Weights and Biases on your own machines using Docker
-menu:
- default:
- identifier: basic-setup
- parent: self-managed
-title: 'Tutorial: Run a W&B Server using Docker'
-weight: 1
----
-
-Follow this "Hello, world!" example to learn the general workflow to install W&B Server for Dedicated Cloud and Self Managed hosting options. By the end of this demo, you will know how to host W&B Server on your local machine using a Trial Mode W&B license.
-
-For demonstration purposes, this demo uses a local development server on port `8080` (`localhost:8080`).
-
-{{% alert %}}
-**Trial Mode vs. Production Setup**
-
-In Trial Mode, you run the Docker container on a single machine. This setup is ideal for testing the product, but it is not scalable.
-
-For production work, set up a scalable file system to avoid data loss. W&B strongly recommends that you:
-* Allocate extra space in advance,
-* Resize the file system proactively as you log more data
-* Configure external metadata and object stores for backup.
-{{% /alert %}}
-
-## Prerequisites
-Before you get started, ensure your local machine satisfies the following requirements:
-
-1. Install [Python](https://www.python.org)
-2. Install [Docker](https://www.docker.com) and ensure it is running
-3. Install or upgrade the latest version of W&B:
- ```bash
- pip install --upgrade wandb
- ```
-## 1. Pull the W&B Docker image
-
-Run the following in your terminal:
-
-```bash
-wandb server start
-```
-
-This command pulls the latest W&B Docker image [`wandb/local`](https://hub.docker.com/r/wandb/local).
-
-
-## 2. Create a W&B account
-Navigate to `http://localhost:8080/signup` and create an initial user account. Provide a name, email address, a username, and a password:
-
-{{< img src="/images/hosting/signup_localhost.png" alt="" >}}
-
-Click the **Sign Up** button to create a W&B account.
-
-{{% alert %}}
-For this demo, create a new W&B account even if you already have a W&B account.
-{{% /alert %}}
-
-
-### Copy your API key
-After you create an account, navigate to `http://localhost:8080/authorize`.
-
-Copy the W&B API key that appears on the screen. At a later step, you will need this key at a later step to verify your login credentials.
-
-{{< img src="/images/hosting/copy_api_key.png" alt="" >}}
-
-## 3. Generate a license
-Navigate to the W&B Deploy Manager at [https://deploy.wandb.ai/deploy](https://deploy.wandb.ai/deploy) to generate a Trial Mode W&B license.
-
-1. Select Docker as your provider
-{{< img src="/images/hosting/deploy_manager_platform.png" alt="" >}}
-2. Click **Next**.
-3. Select a license owner from the **Owner of license** dropdown.
-{{< img src="/images/hosting/deploy_manager_info.png" alt="" >}}
-4. Click **Next**.
-5. Provide a name for your license in the **Name of Instance** field.
-6. (Optional) Provide a description about your license in the **Description** field.
-7. Click the **Generate License Key** button.
-{{< img src="/images/hosting/deploy_manager_generate.png" alt="" >}}
-
-After you click **Generate License Key**, W&B redirects you to a Deployment License page. Within the Deployment License page you can view information about your license instance such as the Deployment ID, the organization the license belongs to, and more.
-
-{{% alert %}}
-View a specific license instance in one of two ways:
-1. Navigate to the Deploy Manager UI and then click the name of the license instance.
-2. Directly navigate to a specific license instance at `https://deploy.wandb.ai/DeploymentID` where `DeploymentID` is the unique ID assigned to your license instance.
-{{% /alert %}}
-
-## 4. Add trial license to your local host
-1. Within the Deployment License page of your license instance, click the **Copy License** button.
-{{< img src="/images/hosting/deploy_manager_get_license.png" alt="" >}}
-2. Navigate to `http://localhost:8080/system-admin/`
-3. Paste your license into to **License field**.
-{{< img src="/images/hosting/License.gif" alt="" >}}
-4. Click the **Update settings** button.
-
-## 5. Check your browser is running the W&B App UI
-Check that W&B is running on your local machine. Navigate to `http://localhost:8080/home`. You should see the W&B App UI in your browser.
-
-{{< img src="/images/hosting/check_local_host.png" alt="" >}}
-
-## 6. Add programmatic access to your local W&B instance
-
-1. Navigate to `http://localhost:8080/authorize` to obtain your API key.
-2. Within your terminal, execute the following:
- ```bash
- wandb login --host=http://localhost:8080/
- ```
- If you are already logged into W&B with a different count, add the `relogin` flag:
- ```bash
- wandb login --relogin --host=http://localhost:8080
- ```
-3. Paste your API key when prompted.
-
-W&B appends a `localhost` profile and your API key to your .netrc profile at `/Users/username/.netrc` for future automatic logins.
-
-## Add a volume to retain data
-
-All metadata and files you log to W&B are temporarily stored in the `https://deploy.wandb.ai/vol` directory.
-
-Mount a volume, or external storage, to your Docker container to retain files and metadata you store in your local W&B instance. W&B recommends that you store metadata in an external MySQL database and files in an external storage bucket such as Amazon S3.
-
-{{% alert %}}
-Recall that your local W&B instance (created using a Trial W&B License), uses Docker to run W&B in your local browser. By default, data is not retained if a Docker container no longer exists. Data is lost when a Docker process dies if you do not mount a volume at `https://deploy.wandb.ai/vol`.
-{{% /alert %}}
-
-For more information on how to mount a volume and for information on how Docker manages data, see [Manage data in Docker](https://docs.docker.com/storage/) page in the Docker documentation.
-
-### Volume considerations
-The underlying file store should be resizable.
-W&B recommends that you set up alerts to inform you when you are close to reaching minimum storage thresholds so you can resize the underlying file system.
-
-
-{{% alert %}}
-For enterprise trials, W&B recommends at least 100 GB free space in the volume for non-image/video/audio heavy workloads.
-{{% /alert %}}
-
-
\ No newline at end of file
diff --git a/content/guides/hosting/hosting-options/self-managed/kubernetes-operator/_index.md b/content/guides/hosting/hosting-options/self-managed/kubernetes-operator/_index.md
index 7ef30fc46..c1b969c5e 100644
--- a/content/guides/hosting/hosting-options/self-managed/kubernetes-operator/_index.md
+++ b/content/guides/hosting/hosting-options/self-managed/kubernetes-operator/_index.md
@@ -60,7 +60,7 @@ This hierarchical model ensures that configurations are flexible and customizabl
### Requirements to use the W&B Kubernetes Operator
Satisfy the following requirements to deploy W&B with the W&B Kubernetes operator:
-Refer to the [reference architecture]({{< relref "../install-on-public-cloud/ref-arch.md#infrastructure-requirements" >}}). In addition, [obtain a valid W&B Server license]({{< relref "../#obtain-your-wb-server-license" >}}).
+Refer to the [reference architecture]({{< relref "../ref-arch.md#infrastructure-requirements" >}}). In addition, [obtain a valid W&B Server license]({{< relref "../#obtain-your-wb-server-license" >}}).
See [this]({{< relref "../bare-metal.md" >}}) guide for a detailed explanation on how to set up and configure a self-managed installation.
diff --git a/content/guides/hosting/hosting-options/self-managed/install-on-public-cloud/ref-arch.md b/content/guides/hosting/hosting-options/self-managed/ref-arch.md
similarity index 98%
rename from content/guides/hosting/hosting-options/self-managed/install-on-public-cloud/ref-arch.md
rename to content/guides/hosting/hosting-options/self-managed/ref-arch.md
index 3332a2971..2542b5dca 100644
--- a/content/guides/hosting/hosting-options/self-managed/install-on-public-cloud/ref-arch.md
+++ b/content/guides/hosting/hosting-options/self-managed/ref-arch.md
@@ -1,7 +1,11 @@
---
title: Reference Architecture
description: W&B Reference Architecture
-displayed_sidebar: default
+menu:
+ default:
+ identifier: ref-arch
+ parent: self-managed
+weight: 1
---
@@ -38,7 +42,7 @@ The storage layer consists of a MySQL database and object storage. The MySQL dat
## Infrastructure requirements
### Kubernetes
-The W&B Server application is deployed as a [Kubernetes Operator]({{< relref "../kubernetes-operator/" >}}) that deploys multiple Pods. For this reason, W&B requires a Kubernetes cluster with:
+The W&B Server application is deployed as a [Kubernetes Operator]({{< relref "kubernetes-operator/" >}}) that deploys multiple Pods. For this reason, W&B requires a Kubernetes cluster with:
- A fully configured and functioning Ingress controller
- The capability to provision Persistent Volumes.
diff --git a/content/guides/hosting/hosting-options/self-managed/server-upgrade-process.md b/content/guides/hosting/hosting-options/self-managed/server-upgrade-process.md
index 336e41128..6e4f551e3 100644
--- a/content/guides/hosting/hosting-options/self-managed/server-upgrade-process.md
+++ b/content/guides/hosting/hosting-options/self-managed/server-upgrade-process.md
@@ -7,6 +7,7 @@ menu:
parent: self-managed
title: Update W&B license and version
url: guides/hosting/server-upgrade-process
+weight: 6
---
Update your W&B Server Version and License with the same method you installed W&B Server with. The following table lists how to update your license and version based on different deployment methods:
From de7cee572dec70df405751fed2f27503b6ec664f Mon Sep 17 00:00:00 2001
From: John Mulhausen
Date: Wed, 15 Jan 2025 22:55:29 -0500
Subject: [PATCH 11/13] Fix image in weave_models_registry.md (#996)
Raw image calls don't pull images out of `assets` and into the build
output; we must use the `{{< img >}}` tag for all image references that
aren't pointing at files that live in `static`
## Description
What does the pull request do?
## Ticket
Does this PR fix an existing issue? If yes, provide a link here.
---
content/tutorials/weave_models_registry.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/content/tutorials/weave_models_registry.md b/content/tutorials/weave_models_registry.md
index 19d37e61c..33df1f732 100644
--- a/content/tutorials/weave_models_registry.md
+++ b/content/tutorials/weave_models_registry.md
@@ -15,7 +15,7 @@ This notebook shows how to use W&B Weave together with W&B Models. Specifically,
Find the public workspace for both W&B Models and W&B Weave [here](https://wandb.ai/wandb-smle/weave-cookboook-demo/weave/evaluations).
-
+{{< img src="/images/tutorials/weave_models_workflow.jpg" alt="Weights & Biases" >}}
The workflow covers the following steps:
@@ -224,4 +224,4 @@ with wandb.init(project=PROJECT, entity=ENTITY) as run:
run.link_artifact(
artifact_model, target_path="wandb32/wandb-registry-RAG Models/RAG Model"
)
-```
\ No newline at end of file
+```
From 23a88bd147b638837718bfc507080cb2debdaa6e Mon Sep 17 00:00:00 2001
From: johndmulhausen
Date: Thu, 16 Jan 2025 11:11:14 -0500
Subject: [PATCH 12/13] "View PDF of section" UI text
---
i18n/en.toml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/i18n/en.toml b/i18n/en.toml
index 0cdd612ae..df6255372 100644
--- a/i18n/en.toml
+++ b/i18n/en.toml
@@ -59,7 +59,7 @@ other = "Click here to print"
[print_show_regular]
other = "Return to the regular view of this page"
[print_entire_section]
-other = "Print entire section"
+other = "View PDF of section"
# Community
[community_join]
From 9992ae6ee308bdca7244368a2eefa9930ecbac56 Mon Sep 17 00:00:00 2001
From: johndmulhausen
Date: Thu, 16 Jan 2025 11:20:43 -0500
Subject: [PATCH 13/13] "View PDF" UI text
---
i18n/en.toml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/i18n/en.toml b/i18n/en.toml
index df6255372..a9fdcb7e3 100644
--- a/i18n/en.toml
+++ b/i18n/en.toml
@@ -59,7 +59,7 @@ other = "Click here to print"
[print_show_regular]
other = "Return to the regular view of this page"
[print_entire_section]
-other = "View PDF of section"
+other = "View PDF"
# Community
[community_join]
+
The workflow covers the following steps:
@@ -224,4 +224,4 @@ with wandb.init(project=PROJECT, entity=ENTITY) as run:
run.link_artifact(
artifact_model, target_path="wandb32/wandb-registry-RAG Models/RAG Model"
)
-```
\ No newline at end of file
+```
From 9d779557ad6a788c0ca5e811b47fefa989b8c774 Mon Sep 17 00:00:00 2001
From: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Date: Wed, 15 Jan 2025 12:10:54 -0800
Subject: [PATCH 07/13] Revert "Fix broken image in weave_models_registry.md"
(#994)
Reverts wandb/docs#990
---
content/tutorials/weave_models_registry.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/content/tutorials/weave_models_registry.md b/content/tutorials/weave_models_registry.md
index 0543bb41f..19d37e61c 100644
--- a/content/tutorials/weave_models_registry.md
+++ b/content/tutorials/weave_models_registry.md
@@ -15,7 +15,7 @@ This notebook shows how to use W&B Weave together with W&B Models. Specifically,
Find the public workspace for both W&B Models and W&B Weave [here](https://wandb.ai/wandb-smle/weave-cookboook-demo/weave/evaluations).
-
+
The workflow covers the following steps:
@@ -224,4 +224,4 @@ with wandb.init(project=PROJECT, entity=ENTITY) as run:
run.link_artifact(
artifact_model, target_path="wandb32/wandb-registry-RAG Models/RAG Model"
)
-```
+```
\ No newline at end of file
From 6afff1c7b729c117d472813eb3805b6be3d6dc60 Mon Sep 17 00:00:00 2001
From: Audrey <16946477+AudreyBeard@users.noreply.github.com>
Date: Wed, 15 Jan 2025 16:03:11 -0500
Subject: [PATCH 08/13] Fix mixed-up CLI / Python labels for Sweep
configuration examples (#993)
Follow-on from #991, adjusted per @johndmulhausen 's request
Sweep configuration options (CLI / Python) examples were mixed up, such
that the Python dictionary specification was labeled "CLI" and the YAML
specification was labeled "Python script or Jupyter notebook".
## Description
This change fixes the mislabeled Sweep configuration by correctly
labeling each of the two examples.
Co-authored-by: Matt Linville
+{{< img src="/images/tutorials/weave_models_workflow.jpg" alt="Weights & Biases" >}}
The workflow covers the following steps:
@@ -224,4 +224,4 @@ with wandb.init(project=PROJECT, entity=ENTITY) as run:
run.link_artifact(
artifact_model, target_path="wandb32/wandb-registry-RAG Models/RAG Model"
)
-```
\ No newline at end of file
+```
From 23a88bd147b638837718bfc507080cb2debdaa6e Mon Sep 17 00:00:00 2001
From: johndmulhausen