Skip to content

Commit

Permalink
Migrating the rest of the markdown links
Browse files Browse the repository at this point in the history
  • Loading branch information
johndmulhausen committed Jan 15, 2025
1 parent c7ce95f commit 7dc4f22
Show file tree
Hide file tree
Showing 170 changed files with 789 additions and 788 deletions.
13 changes: 7 additions & 6 deletions content/guides/models/app/features/panels/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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. |
| {{<img src="/images/app_ui/manual_workspace.svg" alt="manual workspace icon" width="32px" >}} | **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).
Expand All @@ -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.
![](/images/app_ui/add_single_panel.gif)

{{< img src="/images/app_ui/add_single_panel.gif" >}}

### Quick add

Expand All @@ -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/intro.md" >}}) or [Bar plots]({{< relref "bar-plot.md" >}}).

## Manage panels

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion content/guides/models/app/features/panels/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/track/config.md" >}}) and metrics from [`wandb.log`]({{< relref "../../../../guides/track/log/intro.md" >}}).
* **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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion content/guides/models/app/features/panels/scatter-plot.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ Use the scatter plot to compare multiple runs and visualize how your experiments
5. Switch axes to log scale

Here’s an example of validation accuracy of different models over a couple of weeks of experimentation. The tooltip is customized to include the batch size and dropout as well as the values on the axes. There’s also a line plotting the running average of validation accuracy.
[See a live example →](https://app.wandb.ai/l2k2/l2k/reports?view=carey%2FScatter%20Plot)
[See a live example →]({{< relref "https://app.wandb.ai/l2k2/l2k/reports?view=carey%2FScatter%20Plot" >}})

{{< img src="/images/general/scatter-plots-1.png" alt="" >}}
4 changes: 2 additions & 2 deletions content/guides/models/app/settings-page/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
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" >}}).
6 changes: 3 additions & 3 deletions content/guides/models/app/settings-page/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 "../../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 "../features/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.
- [Set a TTL policy]({{< relref "../../artifacts/ttl.md" >}}) on Artifacts so they are automatically deleted.
4 changes: 2 additions & 2 deletions content/guides/models/app/settings-page/system-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions content/guides/models/app/settings-page/team-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 "../../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.

## Avatar

Expand All @@ -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 "../../runs/alert.md" >}}).

## Privacy

Expand All @@ -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.
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 "../features/teams.md#secure-storage-connector" >}}) or check out our [W&B Server]({{< relref "../../hosting/data-security/secure-storage-connector.md" >}}) docs if you are self-hosting.
Loading

0 comments on commit 7dc4f22

Please sign in to comment.