Skip to content

Commit

Permalink
Migrate markdown links to relref (#986)
Browse files Browse the repository at this point in the history
## Description

For local markdown links, start using `relref` native Hugo shortcode.
Among other benefits this will fail the build check if a link is broken.
This is also per the Docsy guidance:
https://www.docsy.dev/docs/best-practices/site-guidance/#linking

## Ticket

Resolves #983
  • Loading branch information
johndmulhausen authored Jan 15, 2025
1 parent 1da0041 commit f24256f
Show file tree
Hide file tree
Showing 272 changed files with 1,232 additions and 1,259 deletions.
2 changes: 1 addition & 1 deletion .hugo-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.136.3
0.140.2
6 changes: 3 additions & 3 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Use [W&B Weave](https://weave-docs.wandb.ai/) to manage all aspects of integrati

##### Build AI models

Use [W&B Models](/guides) to manage all aspects of building your own AI models, including training, fine-tuning, reporting, automating hyperparameter sweeps, and using our model registry to assist with versioning and reproducibility.
Use [W&B Models]({{< relref "/guides/" >}}) to manage all aspects of building your own AI models, including training, fine-tuning, reporting, automating hyperparameter sweeps, and using our model registry to assist with versioning and reproducibility.

- [Introduction](/guides)
- [Quickstart](/quickstart)
- [Introduction]({{< relref "/guides/" >}})
- [Quickstart]({{< relref "/guides/quickstart/" >}})
- [YouTube Tutorial](https://www.youtube.com/watch?v=tHAFujRhZLA)
- [Online Course](https://www.wandb.courses/courses/wandb-101)

Expand Down
38 changes: 19 additions & 19 deletions content/guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,34 @@ Weights & Biases (W&B) is the AI developer platform, with tools for training mod

{{< img src="/images/general/architecture.png" alt="" >}}

W&B consists of three major components: [Models](/guides/models.md), [Weave](https://wandb.github.io/weave/), and [Core](/guides/core.md):
W&B consists of three major components: [Models]({{< relref "/guides/models.md" >}}), [Weave](https://wandb.github.io/weave/), and [Core]({{< relref "/guides/core/" >}}):

**[W&B Models](/guides/models.md)** is a set of lightweight, interoperable tools for machine learning practitioners training and fine-tuning models.
- [Experiments](/guides/track/intro.md): Machine learning experiment tracking
- [Sweeps](/guides/sweeps/intro.md): Hyperparameter tuning and model optimization
- [Registry](/guides/registry/intro.md): Publish and share your ML models and datasets
**[W&B Models]({{< relref "/guides/models/" >}})** is a set of lightweight, interoperable tools for machine learning practitioners training and fine-tuning models.
- [Experiments]({{< relref "/guides/models/track/" >}}): Machine learning experiment tracking
- [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](https://wandb.github.io/weave/)** is a lightweight toolkit for tracking and evaluating LLM applications.
**[W&B Weave](/guides/weave/)** is a lightweight toolkit for tracking and evaluating LLM applications.

**[W&B Core](/guides/core.md)** is set of powerful building blocks for tracking and visualizing data and models, and communicating results.
- [Artifacts](/guides/artifacts/intro.md): Version assets and track lineage
- [Tables](/guides/tables/intro.md): Visualize and query tabular data
- [Reports](/guides/reports/intro.md): Document and collaborate on your discoveries
<!-- - [Weave](/guides/app/features/panels/weave) Query and create visualizations of your data -->
**[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
<!-- - [Weave](/guides/models/app/features/panels/weave) Query and create visualizations of your data -->

## 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](./runs/intro.md), W&B's basic unit of computation.
2. Create and track machine learning experiments with [Experiments](./track/intro.md).
3. Discover W&B's flexible and lightweight building block for dataset and model versioning with [Artifacts](./artifacts/intro.md).
4. Automate hyperparameter search and explore the space of possible models with [Sweeps](./sweeps/intro.md).
5. Manage the model lifecycle from training to production with [Model Registry](./model_registry/intro.md).
6. Visualize predictions across model versions with our [Data Visualization](./tables/intro.md) guide.
7. Organize runs, embed and automate visualizations, describe your findings, and share updates with collaborators with [Reports](./reports/intro.md).
1. Learn about [runs]({{< relref "/guides/models/track/runs/" >}}), W&B's basic unit of computation.
2. Create and track machine learning experiments with [Experiments]({{< relref "/guides/models/track/" >}}).
3. Discover W&B's flexible and lightweight building block for dataset and model versioning with [Artifacts]({{< relref "/guides/core/artifacts/" >}}).
4. Automate hyperparameter search and explore the space of possible models with [Sweeps]({{< relref "/guides/models/sweeps/" >}}).
5. Manage the model lifecycle from training to production with [Registry]({{< relref "/guides/models/registry/" >}}).
6. Visualize predictions across model versions with our [Data Visualization]({{< relref "/guides/core/tables/" >}}) guide.
7. Organize runs, embed and automate visualizations, describe your findings, and share updates with collaborators with [Reports]({{< relref "/guides/core/reports/" >}}).

<iframe width="100%" height="330" src="https://www.youtube.com/embed/tHAFujRhZLA" title="Weights &amp; Biases End-to-End Demo" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

## Are you a first-time user of W&B?

Try the [quickstart](../quickstart.md) to learn how to install W&B and how to add W&B to your code.
Try the [quickstart]({{< relref "/guides/quickstart/" >}}) to learn how to install W&B and how to add W&B to your code.
10 changes: 5 additions & 5 deletions content/guides/core/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ weight: 5
no_list: true
---

W&B Core is the foundational framework supporting [W&B Models](./models.md) and [W&B Weave](./weave_platform.md), and is itself supported by the [W&B Platform](./hosting/_index.md).
W&B Core is the foundational framework supporting [W&B Models]({{< relref "/guides/models/" >}}) and [W&B Weave]({{< relref "/guides/weave/" >}}), and is itself supported by the [W&B Platform]({{< relref "/guides/hosting/" >}}).

{{< img src="/images/general/core.png" alt="" >}}

W&B Core provides capabilities across the entire ML lifecycle. With W&B Core, you can:

- [Version and manage ML](./artifacts/_index.md) pipelines with full lineage tracing for easy auditing and reproducibility.
- Explore and evaluate data and metrics using [interactive, configurable visualizations](./tables/_index.md).
- [Document and share](./reports/_index_.md) insights across the entire organization by generating live reports in digestible, visual formats that are easily understood by non-technical stakeholders.
- [Query and create visualizations of your data](../guides/app/features/panels/query-panel/_index.md) that serve your custom needs.
- [Version and manage ML]({{< relref "./artifacts/" >}}) pipelines with full lineage tracing for easy auditing and reproducibility.
- Explore and evaluate data and metrics using [interactive, configurable visualizations]({{< relref "./tables/" >}}).
- [Document and share]({{< relref "./reports/" >}}) insights across the entire organization by generating live reports in digestible, visual formats that are easily understood by non-technical stakeholders.
- [Query and create visualizations of your data]({{< relref "/guides/models/app/features/panels/query-panels/" >}}) that serve your custom needs.
24 changes: 12 additions & 12 deletions content/guides/core/artifacts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ weight: 1

{{< cta-button productLink="https://wandb.ai/wandb/arttest/artifacts/model/iv3_trained/5334ab69740f9dda4fed/lineage" colabLink="https://colab.research.google.com/github/wandb/examples/blob/master/colabs/wandb-artifacts/Artifact_fundamentals.ipynb" >}}

Use W&B Artifacts to track and version data as the inputs and outputs of your [W&B Runs](../runs/intro.md). For example, a model training run might take in a dataset as input and produce a trained model as output. You can log hyperparameters, metadatra, and metrics to a run, and you can use an artifact to log, track, and version the dataset used to train the model as input and another artifact for the resulting model checkpoints as output.
Use W&B Artifacts to track and version data as the inputs and outputs of your [W&B Runs]({{< relref "/guides/models/track/runs/" >}}). For example, a model training run might take in a dataset as input and produce a trained model as output. You can log hyperparameters, metadatra, and metrics to a run, and you can use an artifact to log, track, and version the dataset used to train the model as input and another artifact for the resulting model checkpoints as output.

## Use cases
You can use artifacts throughout your entire ML workflow as inputs and outputs of [runs](../runs/intro.md). You can use datasets, models, or even other artifacts as inputs for processing.
You can use artifacts throughout your entire ML workflow as inputs and outputs of [runs]({{< relref "/guides/models/track/runs/" >}}). You can use datasets, models, or even other artifacts as inputs for processing.

{{< img src="/images/artifacts/artifacts_landing_page2.png" >}}

| Use Case | Input | Output |
|------------------------|-----------------------------|------------------------------|
| Model Training | Dataset (training and validation data) | Trained Model |
| Dataset Pre-Processing | Dataset (raw data) | Dataset (pre-processed data) |
| Model Evaluation | Model + Dataset (test data) | [W&B Table](../tables/intro.md) |
| Model Evaluation | Model + Dataset (test data) | [W&B Table]({{< relref "/guides/core/tables/" >}}) |
| Model Optimization | Model | Optimized Model |


Expand All @@ -37,8 +37,8 @@ The proceeding code snippets are meant to be run in order.
## Create an artifact

Create an artifact with four lines of code:
1. Create a [W&B run](../runs/intro.md).
2. Create an artifact object with the [`wandb.Artifact`](../../ref/python/artifact.md) API.
1. Create a [W&B run]({{< relref "/guides/models/track/runs/" >}}).
2. Create an artifact object with the [`wandb.Artifact`]({{< relref "/ref/python/artifact.md" >}}) API.
3. Add one or more files, such as a model file or dataset, to your artifact object.
4. Log your artifact to W&B.

Expand All @@ -56,11 +56,11 @@ artifact.save()
```

{{% alert %}}
See the [track external files](./track-external-files.md) page for information on how to add references to files or directories stored in external object storage, like an Amazon S3 bucket.
See the [track external files]({{< relref "./track-external-files.md" >}}) page for information on how to add references to files or directories stored in external object storage, like an Amazon S3 bucket.
{{% /alert %}}

## Download an artifact
Indicate the artifact you want to mark as input to your run with the [`use_artifact`](../../ref/python/run.md#use_artifact) method.
Indicate the artifact you want to mark as input to your run with the [`use_artifact`]({{< relref "/ref/python/run.md#use_artifact" >}}) method.

Following the preceding code snippet, this next code block shows how to use the `training_dataset` artifact:

Expand All @@ -76,12 +76,12 @@ datadir = artifact.download() #downloads the full "my_data" artifact to the defa
```

{{% alert %}}
You can pass a custom path into the `root` [parameter](../../ref/python/artifact.md) to download an artifact to a specific directory. For alternate ways to download artifacts and to see additional parameters, see the guide on [downloading and using artifacts](./download-and-use-an-artifact.md).
You can pass a custom path into the `root` [parameter]({{< relref "/ref/python/artifact.md" >}}) to download an artifact to a specific directory. For alternate ways to download artifacts and to see additional parameters, see the guide on [downloading and using artifacts]({{< relref "./download-and-use-an-artifact.md" >}}).
{{% /alert %}}


## Next steps
* Learn how to [version](./create-a-new-artifact-version.md), [update](./update-an-artifact.md), or [delete](./delete-artifacts.md) artifacts.
* Learn how to trigger downstream workflows in response to changes to your artifacts with [artifact automation](./project-scoped-automations.md).
* Learn about the [model registry](../model_registry/intro.md), a space that houses trained models.
* Explore the [Python SDK](../../ref/python/artifact.md) and [CLI](../../ref/cli/wandb-artifact/README.md) reference guides.
* Learn how to [version]({{< relref "./create-a-new-artifact-version.md" >}}) and [update]({{< relref "./update-an-artifact.md" >}}) artifacts.
* Learn how to trigger downstream workflows in response to changes to your artifacts with [artifact automation]({{< relref "/guides/models/automations/project-scoped-automations/" >}}).
* Learn about the [registry]({{< relref "/guides/models/registry/" >}}), a space that houses trained models.
* Explore the [Python SDK]({{< relref "/ref/python/artifact.md" >}}) and [CLI]({{< relref "/ref/cli/wandb-artifact/" >}}) reference guides.
16 changes: 8 additions & 8 deletions content/guides/core/artifacts/artifacts-walkthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: >-
displayed_sidebar: default
title: "Tutorial: Create, track, and use a dataset artifact"
---
This walkthrough demonstrates how to create, track, and use a dataset artifact from [W&B Runs](../runs/intro.md).
This walkthrough demonstrates how to create, track, and use a dataset artifact from [W&B Runs]({{< relref "/guides/models/track/runs/" >}}).

## 1. Log into W&B

Expand All @@ -19,7 +19,7 @@ wandb.login()

## 2. Initialize a run

Use the [`wandb.init()`](../../ref/python/init.md) API to generate a background process to sync and log data as a W&B Run. Provide a project name and a job type:
Use the [`wandb.init()`]({{< relref "/ref/python/init.md" >}}) API to generate a background process to sync and log data as a W&B Run. Provide a project name and a job type:

```python
# Create a W&B Run. Here we specify 'dataset' as the job type since this example
Expand All @@ -29,15 +29,15 @@ run = wandb.init(project="artifacts-example", job_type="upload-dataset")

## 3. Create an artifact object

Create an artifact object with the [`wandb.Artifact()`](../../ref/python/artifact.md) API. Provide a name for the artifact and a description of the file type for the `name` and `type` parameters, respectively.
Create an artifact object with the [`wandb.Artifact()`]({{< relref "/ref/python/artifact.md" >}}) API. Provide a name for the artifact and a description of the file type for the `name` and `type` parameters, respectively.

For example, the following code snippet demonstrates how to create an artifact called `‘bicycle-dataset’` with a `‘dataset’` label:

```python
artifact = wandb.Artifact(name="bicycle-dataset", type="dataset")
```

For more information about how to construct an artifact, see [Construct artifacts](./construct-an-artifact.md).
For more information about how to construct an artifact, see [Construct artifacts]({{< relref "./construct-an-artifact.md" >}}).

## Add the dataset to the artifact

Expand All @@ -60,15 +60,15 @@ Use the W&B run objects `log_artifact()` method to both save your artifact versi
run.log_artifact(artifact)
```

A `'latest'` alias is created by default when you log an artifact. For more information about artifact aliases and versions, see [Create a custom alias](./create-a-custom-alias.md) and [Create new artifact versions](./create-a-new-artifact-version.md), respectively.
A `'latest'` alias is created by default when you log an artifact. For more information about artifact aliases and versions, see [Create a custom alias]({{< relref "./create-a-custom-alias.md" >}}) and [Create new artifact versions]({{< relref "./create-a-new-artifact-version.md" >}}), respectively.

## 5. Download and use the artifact

The following code example demonstrates the steps you can take to use an artifact you have logged and saved to the W&B servers.

1. First, initialize a new run object with **`wandb.init()`.**
2. Second, use the run objects [`use_artifact()`](../../ref/python/run.md#use_artifact) method to tell W&B what artifact to use. This returns an artifact object.
3. Third, use the artifacts [`download()`](../../ref/python/artifact.md#download) method to download the contents of the artifact.
2. Second, use the run objects [`use_artifact()`]({{< relref "/ref/python/run.md#use_artifact" >}}) method to tell W&B what artifact to use. This returns an artifact object.
3. Third, use the artifacts [`download()`]({{< relref "/ref/python/artifact.md#download" >}}) method to download the contents of the artifact.

```python
# Create a W&B Run. Here we specify 'training' for 'type'
Expand All @@ -82,4 +82,4 @@ artifact = run.use_artifact("bicycle-dataset:latest")
artifact_dir = artifact.download()
```

Alternatively, you can use the Public API (`wandb.Api`) to export (or update data) data already saved in a W&B outside of a Run. See [Track external files](./track-external-files.md) for more information.
Alternatively, you can use the Public API (`wandb.Api`) to export (or update data) data already saved in a W&B outside of a Run. See [Track external files]({{< relref "./track-external-files.md" >}}) for more information.
Loading

0 comments on commit f24256f

Please sign in to comment.