From 30f2d3da67aa410c2ded4ac555a50c008dd513a7 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 9 Apr 2026 21:46:07 +0000 Subject: [PATCH 1/2] Fix writing style and tone consistency across docs Standardize voice, terminology, and heading capitalization: - Replace third-person reader references with second-person 'you' - Convert passive voice to active voice in procedural content - Fix title case headings to sentence case - Standardize 'choose' -> 'select' for UI instructions - Standardize 'go to' -> 'navigate to' for navigation - Standardize 'check out' -> 'see' for cross-references - Standardize 'sign in' -> 'log in' for authentication - Fix 'setup' -> 'set up' when used as a verb - Fix typo 'posses' -> 'possess' Generated-By: mintlify-agent --- inference/lora.mdx | 4 ++-- models/app/features/cascade-settings.mdx | 2 +- models/app/features/custom-charts.mdx | 2 +- .../features/custom-charts/walkthrough.mdx | 2 +- models/app/features/panels.mdx | 6 +++--- models/app/features/panels/line-plot.mdx | 4 ++-- .../features/panels/line-plot/reference.mdx | 8 ++++---- .../features/panels/line-plot/sampling.mdx | 4 ++-- .../features/panels/parameter-importance.mdx | 4 ++-- models/artifacts/delete-artifacts.mdx | 2 +- .../automations/create-automations/slack.mdx | 12 +++++------ .../create-automations/webhook.mdx | 10 +++++----- models/integrations/catalyst.mdx | 2 +- models/integrations/databricks.mdx | 2 +- models/integrations/deepchem.mdx | 2 +- models/integrations/farama-gymnasium.mdx | 2 +- models/integrations/fastai.mdx | 2 +- models/integrations/huggingface.mdx | 2 +- .../integrations/huggingface_transformers.mdx | 4 ++-- models/integrations/keras.mdx | 2 +- models/integrations/lightgbm.mdx | 4 ++-- models/integrations/openai-fine-tuning.mdx | 2 +- models/integrations/pytorch.mdx | 6 +++--- models/integrations/scikit.mdx | 2 +- models/integrations/spacy.mdx | 2 +- models/integrations/ultralytics.mdx | 6 +++--- models/integrations/xgboost.mdx | 2 +- models/integrations/yolov5.mdx | 2 +- models/registry.mdx | 2 +- models/reports.mdx | 2 +- models/reports/clone-and-export-reports.mdx | 4 ++-- models/reports/edit-a-report.mdx | 10 +++++----- models/runs.mdx | 2 +- models/runs/alert.mdx | 2 +- models/runs/delete-runs.mdx | 4 ++-- models/runs/manage-runs.mdx | 2 +- models/runs/run-identifiers.mdx | 2 +- models/runs/run-states.mdx | 2 +- models/runs/stop-runs.mdx | 2 +- models/sweeps/visualize-sweep-results.mdx | 2 +- models/tables/tables-download.mdx | 4 ++-- models/tables/tables-gallery.mdx | 2 +- models/tables/visualize-tables.mdx | 2 +- models/track/jupyter.mdx | 2 +- models/track/limits.mdx | 2 +- models/track/log/media.mdx | 6 +++--- models/track/project-page.mdx | 2 +- models/track/public-api-guide.mdx | 4 ++-- models/track/workspaces.mdx | 6 +++--- .../app/settings-page/billing-settings.mdx | 2 +- platform/app/settings-page/emails.mdx | 2 +- platform/app/settings-page/team-settings.mdx | 4 ++-- platform/app/settings-page/teams.mdx | 2 +- platform/app/settings-page/user-settings.mdx | 6 +++--- .../secure-storage-connector.mdx | 2 +- platform/hosting/enterprise-licenses.mdx | 2 +- .../dedicated-cloud/regions.mdx | 4 ++-- .../hosting-options/dedicated_regions.mdx | 4 ++-- .../access-management/manage-organization.mdx | 20 +++++++++---------- platform/hosting/iam/advanced_env_vars.mdx | 2 +- platform/hosting/iam/identity_federation.mdx | 2 +- platform/hosting/iam/scim.mdx | 6 +++--- platform/hosting/iam/sso.mdx | 8 ++++---- .../monitoring-usage/org_dashboard.mdx | 2 +- .../hosting/monitoring-usage/slack-alerts.mdx | 2 +- platform/hosting/self-managed/operator.mdx | 12 +++++------ platform/launch/create-launch-job.mdx | 2 +- platform/launch/job-inputs.mdx | 2 +- platform/launch/launch-terminology.mdx | 8 ++++---- platform/launch/set-up-launch.mdx | 6 +++--- platform/launch/setup-launch-docker.mdx | 2 +- platform/launch/setup-launch-sagemaker.mdx | 2 +- platform/launch/setup-queue-advanced.mdx | 2 +- platform/launch/sweeps-on-launch.mdx | 2 +- platform/launch/walkthrough.mdx | 2 +- platform/secrets.mdx | 2 +- .../how-do-we-update-our-payment-method.mdx | 2 +- .../models/articles/is-there-a-dark-mode.mdx | 2 +- support/models/tags/billing.mdx | 2 +- support/models/tags/workspaces.mdx | 2 +- .../cookbooks/Intro_to_Weave_Hello_Trace.mdx | 2 +- weave/cookbooks/audio_with_weave.mdx | 4 ++-- weave/cookbooks/codegen.mdx | 2 +- weave/cookbooks/dspy_prompt_optimization.mdx | 2 +- weave/cookbooks/import_from_csv.mdx | 4 ++-- weave/cookbooks/notdiamond_custom_routing.mdx | 4 ++-- weave/cookbooks/online_monitoring.mdx | 6 +++--- weave/guides/core-types/datasets.mdx | 2 +- weave/guides/core-types/env-vars.mdx | 2 +- weave/guides/core-types/evaluations.mdx | 2 +- weave/guides/core-types/leaderboards.mdx | 10 +++++----- weave/guides/core-types/prompts-version.mdx | 2 +- weave/guides/evaluation/evaluation_logger.mdx | 4 ++-- weave/guides/evaluation/monitors.mdx | 2 +- weave/guides/evaluation/scorers.mdx | 2 +- weave/guides/integrations/crewai.mdx | 4 ++-- weave/guides/integrations/google_adk.mdx | 2 +- weave/guides/integrations/llamaindex.mdx | 2 +- weave/guides/integrations/local_models.mdx | 2 +- weave/guides/integrations/openai.mdx | 4 ++-- weave/guides/integrations/pydantic_ai.mdx | 2 +- weave/guides/integrations/verdict.mdx | 2 +- weave/guides/platform/weave-projects.mdx | 2 +- weave/guides/platform/weave-self-managed.mdx | 8 ++++---- weave/guides/tracking/annotation-queues.mdx | 10 +++++----- weave/guides/tracking/querying-calls.mdx | 2 +- weave/guides/tracking/redact-pii.mdx | 2 +- weave/tutorial-eval.mdx | 2 +- weave/tutorial-rag.mdx | 2 +- 109 files changed, 193 insertions(+), 193 deletions(-) diff --git a/inference/lora.mdx b/inference/lora.mdx index d10ea429ab..963315b146 100644 --- a/inference/lora.mdx +++ b/inference/lora.mdx @@ -41,7 +41,7 @@ resp = client.chat.completions.create( print(resp.choices[0].message.content) ``` -Check out this [getting started notebook](https://wandb.me/lora_nb) for an interactive demonstration of how to create a LoRA and upload it to W&B as an artifact. +See this [getting started notebook](https://wandb.me/lora_nb) for an interactive demonstration of how to create a LoRA and upload it to W&B as an artifact. ## Prerequisites @@ -104,7 +104,7 @@ Once your LoRA has been added to your project as an artifact, use the artifact's model_name = f"wandb-artifact:///{WB_TEAM}/{WB_PROJECT}/your_trained_lora:latest" ``` -## Supported Base Models +## Supported base models Inference currently supports the following LLMs (use the exact strings in `wandb.base_model`). More models coming soon: diff --git a/models/app/features/cascade-settings.mdx b/models/app/features/cascade-settings.mdx index 904ba9ee35..8e7e2cfc8d 100644 --- a/models/app/features/cascade-settings.mdx +++ b/models/app/features/cascade-settings.mdx @@ -13,7 +13,7 @@ To edit settings that apply to the overall structure of this workspace: 1. Navigate to your project workspace. 2. Click the gear icon next to the **New report** button to view the workspace settings. -3. Choose **Workspace layout** to change the workspace's layout, or choose **Line plots** to configure default settings for line plots in the workspace. +3. Select **Workspace layout** to change the workspace's layout, or select **Line plots** to configure default settings for line plots in the workspace. Workspace settings gear icon diff --git a/models/app/features/custom-charts.mdx b/models/app/features/custom-charts.mdx index 9115bef608..0ebfaaf474 100644 --- a/models/app/features/custom-charts.mdx +++ b/models/app/features/custom-charts.mdx @@ -261,7 +261,7 @@ Click **Edit** at the top of the panel to go into [Vega](https://vega.github.io/ **Field references** -To pull data into your chart from W&B, add template strings of the form `"${field:}"` anywhere in your Vega spec. This will create a dropdown in the **Chart Fields** area on the right side, which users can use to select a query result column to map into Vega. +To pull data into your chart from W&B, add template strings of the form `"${field:}"` anywhere in your Vega spec. This creates a dropdown in the **Chart Fields** area on the right side, which you can use to select a query result column to map into Vega. To set a default value for a field, use this syntax: `"${field::}"` diff --git a/models/app/features/custom-charts/walkthrough.mdx b/models/app/features/custom-charts/walkthrough.mdx index 3a62428424..d836f3eeb4 100644 --- a/models/app/features/custom-charts/walkthrough.mdx +++ b/models/app/features/custom-charts/walkthrough.mdx @@ -24,7 +24,7 @@ with wandb.init() as run: ## 2. Create a query -Once you've logged data to visualize, go to your project page and click the **`+`** button to add a new panel, then select **Custom Chart**. You can follow along in the [custom charts demo workspace](https://app.wandb.ai/demo-team/custom-charts). +Once you've logged data to visualize, navigate to your project page and click the **`+`** button to add a new panel, then select **Custom Chart**. You can follow along in the [custom charts demo workspace](https://app.wandb.ai/demo-team/custom-charts). Blank custom chart diff --git a/models/app/features/panels.mdx b/models/app/features/panels.mdx index 53027e1a8c..76059c2e16 100644 --- a/models/app/features/panels.mdx +++ b/models/app/features/panels.mdx @@ -38,7 +38,7 @@ To configure the workspace layout, click **Settings** near the top of the worksp - **Sort panels alphabetically** (turned off by default) - **Section organization** (grouped by first prefix by default). To modify this setting: 1. Click the padlock icon. - 1. Choose how to group panels within a section. + 1. Select how to group panels within a section. To configure defaults for the workspace's line plots, refer to [Line plots](/models/app/features/panels/line-plot/). @@ -133,7 +133,7 @@ To get the code to embed or share a panel on social media: 1. From the workspace, hover over the panel, then click its action menu `...`. 1. Click the **Share** tab. 1. Change **Only those who are invited have access** to **Anyone with the link can view**. Otherwise, the choices in the next step are not available. -1. Choose **Share on Twitter**, **Share on Reddit**, **Share on LinkedIn**, or **Copy embed link**. +1. Select **Share on Twitter**, **Share on Reddit**, **Share on LinkedIn**, or **Copy embed link**. ### Email a panel report To email a single panel as a stand-alone report: @@ -208,7 +208,7 @@ Sections with a large number of panels are paginated by default. The default num 1. To resize a panel, hover over it, click the drag handle, and drag it to adjust the panel's size. Resizing one panel resizes all panels in the section. 1. If a section is paginated, you can customize the number of panels to show on a page: 1. At the top of the section, click **1 to `` of ``**, where `` is the number of visible panels and `` is the total number of panels. - 1. Choose how many panels to show per page, up to 100. + 1. Select how many panels to show per page, up to 100. 1. To delete a panel from a section: 1. Hover over the panel, then click its action `...` menu. 1. Click **Delete**. diff --git a/models/app/features/panels/line-plot.mdx b/models/app/features/panels/line-plot.mdx index 919705e828..36686f7e24 100644 --- a/models/app/features/panels/line-plot.mdx +++ b/models/app/features/panels/line-plot.mdx @@ -172,7 +172,7 @@ with wandb.init() as run: ## Change the colors of the lines -Sometimes the default color of runs is not helpful for comparison. To help overcome this, wandb provides two instances with which one can manually change the colors. +Sometimes the default color of runs is not helpful for comparison. To help overcome this, W&B provides two ways to manually change the colors. @@ -192,7 +192,7 @@ Each run is given a random color by default upon initialization. 1. Navigate to your workspace. 1. Hover your mouse over the panel you want to edit its settings for. 1. Select the pencil icon that appears. -1. Choose the **Legend** tab. +1. Select the **Legend** tab. Line plot legend settings diff --git a/models/app/features/panels/line-plot/reference.mdx b/models/app/features/panels/line-plot/reference.mdx index 56ecdb44d3..66373613cc 100644 --- a/models/app/features/panels/line-plot/reference.mdx +++ b/models/app/features/panels/line-plot/reference.mdx @@ -36,7 +36,7 @@ Available y-axis options: ### Point aggregation method -Choose the sampling mode for displaying data points: +Select the sampling mode for displaying data points: * **Random sampling** (default): See [Random sampling](/models/app/features/panels/line-plot/sampling/#random-sampling). * **Full fidelity**: See [Full fidelity](/models/app/features/panels/line-plot/sampling/#full-fidelity). @@ -69,7 +69,7 @@ A workspace is limited to displaying a maximum of 1000 runs, regardless of its c ### Chart type -Choose the plot style: +Select the plot style: - **Line plot** Line plot style @@ -110,7 +110,7 @@ Customize the legend to show any config value logged and metadata from the runs, Define a template for the legend name. 1. Click the gear icon to open the plot settings. -1. Go to the **Display preferences** tab. +1. Navigate to the **Display preferences** tab. 1. Expand **Advanced legend**, then specify the legend template. 1. Click **Apply**. @@ -123,7 +123,7 @@ Example: Set values inside `[[ ]]` to display point-specific values in the crosshair when hovering over a chart. 1. Click the gear icon to open the plot settings. -1. Go to the **Display preferences** tab. +1. Navigate to the **Display preferences** tab. 1. At the bottom of the tab, configure point-specific values for one or more of the plot's metrics. 1. Click **Apply**. diff --git a/models/app/features/panels/line-plot/sampling.mdx b/models/app/features/panels/line-plot/sampling.mdx index 2d31175b03..f4045037dc 100644 --- a/models/app/features/panels/line-plot/sampling.mdx +++ b/models/app/features/panels/line-plot/sampling.mdx @@ -24,7 +24,7 @@ W&B uses full fidelity mode by default. To configure it manually, follow these s 1. Navigate to your workspace. 3. Select the gear icon on the top right corner of the screen next to the left of the **Add panels** button. 4. From the UI slider that appears, select **Line plots** -5. Choose **Full fidelity** from the **Point aggregation** section. +5. Select **Full fidelity** from the **Point aggregation** section. 6. Configure the **Smoothing** algorithm and settings. 7. Set **Aggregation** to **Mean**, **Min**, or **Max**. 8. Click **Apply**. @@ -128,7 +128,7 @@ By default, W&B uses full fidelity mode. To enable random sampling, follow these 2. Select on the **Workspace** icon on the left tab 3. Select the gear icon on the top right corner of the screen next to the left of the **Add panels** button. 4. From the UI slider that appears, select **Line plots** -5. Choose **Random sampling** from the **Point aggregation** section +5. Select **Random sampling** from the **Point aggregation** section 1. Navigate to your W&B project diff --git a/models/app/features/panels/parameter-importance.mdx b/models/app/features/panels/parameter-importance.mdx index afad2b8776..96d5c94f82 100644 --- a/models/app/features/panels/parameter-importance.mdx +++ b/models/app/features/panels/parameter-importance.mdx @@ -15,7 +15,7 @@ Discover which of your hyperparameters were the best predictors of, and highly c Therefore W&B also calculates an **importance** metric. W&B trains a random forest with the hyperparameters as inputs and the metric as the target output and report the feature importance values for the random forest. -The idea for this technique was inspired by a conversation with [Jeremy Howard](https://twitter.com/jeremyphoward) who has pioneered the use of random forest feature importances to explore hyperparameter spaces at [Fast.ai](https://fast.ai). W&B highly recommends you check out this [lecture](https://course18.fast.ai/lessonsml1/lesson4.html) (and these [notes](https://forums.fast.ai/t/wiki-lesson-thread-lesson-4/7540)) to learn more about the motivation behind this analysis. +The idea for this technique was inspired by a conversation with [Jeremy Howard](https://twitter.com/jeremyphoward) who has pioneered the use of random forest feature importances to explore hyperparameter spaces at [Fast.ai](https://fast.ai). W&B highly recommends you see this [lecture](https://course18.fast.ai/lessonsml1/lesson4.html) (and these [notes](https://forums.fast.ai/t/wiki-lesson-thread-lesson-4/7540)) to learn more about the motivation behind this analysis. Hyperparameter importance panel untangles the complicated interactions between highly correlated hyperparameters. In doing so, it helps you fine tune your hyperparameter searches by showing you which of your hyperparameters matter the most in terms of predicting model performance. @@ -23,7 +23,7 @@ Hyperparameter importance panel untangles the complicated interactions between h 1. Navigate to your W&B project. 2. Select **Add panels** button. -3. Expand the **CHARTS** dropdown, choose **Parallel coordinates** from the dropdown. +3. Expand the **CHARTS** dropdown, select **Parallel coordinates** from the dropdown. diff --git a/models/artifacts/delete-artifacts.mdx b/models/artifacts/delete-artifacts.mdx index 2d0f8288ed..1241748bf6 100644 --- a/models/artifacts/delete-artifacts.mdx +++ b/models/artifacts/delete-artifacts.mdx @@ -70,7 +70,7 @@ To delete an artifact version: 2. Select the **Artifacts** tab. 3. From the list of artifact types, select the type of artifact that contains the version you want to delete. 4. Click the three horizontal dots (`...`) next to the artifact version you want to delete. -5. From the dropdown, choose **Delete Version**. +5. From the dropdown, select **Delete Version**. diff --git a/models/automations/create-automations/slack.mdx b/models/automations/create-automations/slack.mdx index 2eeaaccf57..57c26a8ca0 100644 --- a/models/automations/create-automations/slack.mdx +++ b/models/automations/create-automations/slack.mdx @@ -12,19 +12,19 @@ At a high level, to create a Slack automation, you take these steps: ## Add a Slack integration A team admin can add a Slack integration to the team. -1. Log in to W&B and go to **Team Settings**. +1. Log in to W&B and navigate to **Team Settings**. 1. In the **Slack channel integrations** section, click **Connect Slack** to add a new Slack instance. To add a channel for an existing Slack instance, click **New integration**. ![Screenshot showing two Slack integrations in a Team](/images/automations/slack_integrations.png) -1. If necessary, sign in to Slack in your browser. When prompted, grant W&B permission to post to the Slack channel you select. Read the page, then click **Search for a channel** and begin typing the channel name. Select the channel from the list, then click **Allow**. -1. In Slack, go to the channel you selected. If you see a post like `[Your Slack handle] added an integration to this channel: Weights & Biases`, the integration is configured correctly. +1. If necessary, log in to Slack in your browser. When prompted, grant W&B permission to post to the Slack channel you select. Read the page, then click **Search for a channel** and begin typing the channel name. Select the channel from the list, then click **Allow**. +1. In Slack, navigate to the channel you selected. If you see a post like `[Your Slack handle] added an integration to this channel: Weights & Biases`, the integration is configured correctly. Now you can [create an automation](#create-an-automation) that notifies the Slack channel you configured. ## View and manage Slack integrations A team admin can view and manage the team's Slack instances and channels. -1. Log in to W&B and go to **Team Settings**. +1. Log in to W&B and navigate to **Team Settings**. 1. View each Slack destination in the **Slack channel integrations** section. 1. Delete a destination by clicking its trash icon. @@ -38,7 +38,7 @@ A Registry admin can create automations in that registry. 1. Log in to W&B. 1. Click the name of a registry to view its details, 1. To create an automation scoped to the registry, click the **Automations** tab, then click **Create automation**. An automation that is scoped to a registry is automatically applied to all of its collections (including those created in the future). -1. Choose the [event](/models/automations/automation-events/#registry-events) to watch for. +1. Select the [event](/models/automations/automation-events/#registry-events) to watch for. Fill in any additional fields that appear, which depend upon the event. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**. @@ -58,7 +58,7 @@ A W&B admin can create automations in a project. Automation bell icon location -1. Choose the [event](/models/automations/automation-events/#project) to watch for. +1. Select the [event](/models/automations/automation-events/#project) to watch for. 1. Fill in any additional fields that appear. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**. diff --git a/models/automations/create-automations/webhook.mdx b/models/automations/create-automations/webhook.mdx index de59ec3eec..9877bc1c60 100644 --- a/models/automations/create-automations/webhook.mdx +++ b/models/automations/create-automations/webhook.mdx @@ -17,7 +17,7 @@ A team admin can add a webhook for the team. If the webhook requires a Bearer token or its payload requires a sensitive string, [create a secret that contains it](/platform/secrets/#add-a-secret) before creating the webhook. You can configure at most one access token and one other secret for a webhook. Your webhook's authentication and authorization requirements are determined by the webhook's service. -1. Log in to W&B and go to **Team Settings** page. +1. Log in to W&B and navigate to the **Team Settings** page. 1. In the **Webhooks** section, click **New webhook**. 1. Provide a name for the webhook. 1. Provide the endpoint URL for the webhook. @@ -48,7 +48,7 @@ A Registry admin can create automations in that registry. Registry automations a 1. Click the name of a registry to view its details, 1. To create an automation scoped to the registry, click the **Automations** tab, then click **Create automation**. -1. Choose the [event](/models/automations/automation-events/#registry-events) to watch for. +1. Select the [event](/models/automations/automation-events/#registry-events) to watch for. Fill in any additional fields that appear. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**. @@ -62,14 +62,14 @@ A Registry admin can create automations in that registry. Registry automations a A W&B admin can create automations in a project. -1. Log in to W&B and go to the project page. +1. Log in to W&B and navigate to the project page. 1. In the project sidebar, click **Automations**, then click **Create automation**. Or, from a line plot in the workspace, you can quickly create a [run metric automation](/models/automations/automation-events/#run-events) for the metric it shows. Hover over the panel, then click the bell icon at the top of the panel. Automation bell icon location -1. Choose the [event](/models/automations/automation-events/#project) to watch for, such as when an artifact alias is added or when a run metric meets a given threshold. +1. Select the [event](/models/automations/automation-events/#project) to watch for, such as when an artifact alias is added or when a run metric meets a given threshold. 1. Fill in any additional fields that appear, which depend upon the event. For example, if you select **An artifact alias is added**, you must specify the **Alias regex**. @@ -183,7 +183,7 @@ Use template strings to dynamically pass context from W&B to GitHub Actions and - Watch the videos [Webhook Automations for Model Evaluation](https://www.youtube.com/watch?v=7j-Mtbo-E74&ab_channel=Weights%26Biases) and [Webhook Automations for Model Deployment](https://www.youtube.com/watch?v=g5UiAFjM2nA&ab_channel=Weights%26Biases), which guide you to create automations for model evaluation and deployment. -- Review a W&B [report](https://wandb.ai/wandb/wandb-model-cicd/reports/Model-CI-CD-with-W-B--Vmlldzo0OTcwNDQw), which illustrates how to use a Github Actions webhook automation for Model CI. Check out this [GitHub repository](https://github.com/hamelsmu/wandb-modal-webhook) to learn how to create model CI with a Modal Labs webhook. +- Review a W&B [report](https://wandb.ai/wandb/wandb-model-cicd/reports/Model-CI-CD-with-W-B--Vmlldzo0OTcwNDQw), which illustrates how to use a Github Actions webhook automation for Model CI. See this [GitHub repository](https://github.com/hamelsmu/wandb-modal-webhook) to learn how to create model CI with a Modal Labs webhook. This example payload shows how to notify your Teams channel using a webhook: diff --git a/models/integrations/catalyst.mdx b/models/integrations/catalyst.mdx index fde72d6a96..2a768e55f2 100644 --- a/models/integrations/catalyst.mdx +++ b/models/integrations/catalyst.mdx @@ -7,7 +7,7 @@ title: Catalyst Catalyst includes a W&B integration for logging parameters, metrics, images, and other artifacts. -Check out their [documentation of the integration](https://catalyst-team.github.io/catalyst/api/loggers.html#catalyst.loggers.wandb.WandbLogger), which includes examples using Python and Hydra. +See their [documentation of the integration](https://catalyst-team.github.io/catalyst/api/loggers.html#catalyst.loggers.wandb.WandbLogger), which includes examples using Python and Hydra. ## Interactive example diff --git a/models/integrations/databricks.mdx b/models/integrations/databricks.mdx index 63f2950e9c..d0d69ddaad 100644 --- a/models/integrations/databricks.mdx +++ b/models/integrations/databricks.mdx @@ -9,7 +9,7 @@ W&B integrates with [Databricks](https://www.databricks.com/) by customizing the 1. Install wandb in the cluster - Navigate to your cluster configuration, choose your cluster, click **Libraries**. Click **Install New**, choose **PyPI**, and add the package `wandb`. + Navigate to your cluster configuration, select your cluster, click **Libraries**. Click **Install New**, select **PyPI**, and add the package `wandb`. 2. Set up authentication diff --git a/models/integrations/deepchem.mdx b/models/integrations/deepchem.mdx index 035425b88a..5186d91237 100644 --- a/models/integrations/deepchem.mdx +++ b/models/integrations/deepchem.mdx @@ -23,7 +23,7 @@ model.fit(…) Explore the Using [W&B with DeepChem: Molecular Graph Convolutional Networks](https://wandb.ai/kshen/deepchem_graphconv/reports/Using-W-B-with-DeepChem-Molecular-Graph-Convolutional-Networks--Vmlldzo4MzU5MDc?galleryTag=) article for an example charts generated using the W&B DeepChem integration. -To dive straight into working code, check out this [Google Colab](https://colab.research.google.com/github/wandb/examples/blob/master/colabs/deepchem/W%26B_x_DeepChem.ipynb). +To dive straight into working code, see this [Google Colab](https://colab.research.google.com/github/wandb/examples/blob/master/colabs/deepchem/W%26B_x_DeepChem.ipynb). ## Track experiments diff --git a/models/integrations/farama-gymnasium.mdx b/models/integrations/farama-gymnasium.mdx index 16a6336691..ba557d9197 100644 --- a/models/integrations/farama-gymnasium.mdx +++ b/models/integrations/farama-gymnasium.mdx @@ -7,7 +7,7 @@ If you're using [Farama Gymnasium](https://gymnasium.farama.org/#) we will autom Our gymnasium integration is very light. We simply [look at the name of the video file](https://github.com/wandb/wandb/blob/c5fe3d56b155655980611d32ef09df35cd336872/wandb/integration/gym/__init__.py#LL69C67-L69C67) being logged from `gymnasium` and name it after that or fall back to `"videos"` if we don't find a match. If you want more control, you can always just manually [log a video](/models/track/log/media/). -Check out this [report](https://wandb.ai/raph-test/cleanrltest/reports/Mario-Bros-but-with-AI-Gymnasium-and-CleanRL---Vmlldzo0NTcxNTcw) to learn more on how to use Gymnasium with the CleanRL library. +See this [report](https://wandb.ai/raph-test/cleanrltest/reports/Mario-Bros-but-with-AI-Gymnasium-and-CleanRL---Vmlldzo0NTcxNTcw) to learn more on how to use Gymnasium with the CleanRL library. Gymnasium RL environment diff --git a/models/integrations/fastai.mdx b/models/integrations/fastai.mdx index 5515932d38..e5151cf491 100644 --- a/models/integrations/fastai.mdx +++ b/models/integrations/fastai.mdx @@ -5,7 +5,7 @@ description: "Integrate W&B with fastai using the WandbCallback to track experim import ApiKeyCreateStreamlined from "/snippets/en/_includes/api-key-create-streamlined.mdx"; -You can integrate **fastai** with W&B using the `WandbCallback` class. Check out these [interactive docs with examples](https://app.wandb.ai/borisd13/demo_config/reports/Visualize-track-compare-Fastai-models--Vmlldzo4MzAyNA) for more details. +You can integrate **fastai** with W&B using the `WandbCallback` class. See these [interactive docs with examples](https://app.wandb.ai/borisd13/demo_config/reports/Visualize-track-compare-Fastai-models--Vmlldzo4MzAyNA) for more details. ## Sign up and create an API key diff --git a/models/integrations/huggingface.mdx b/models/integrations/huggingface.mdx index 7f73029b28..128a65451e 100644 --- a/models/integrations/huggingface.mdx +++ b/models/integrations/huggingface.mdx @@ -94,7 +94,7 @@ Next, call the downloaded training script [run_glue.py](https://huggingface.co/t ``` ## Visualize results in dashboard -Click the link printed out above, or go to [wandb.ai](https://app.wandb.ai) to see your results stream in live. The link to see your run in the browser will appear after all the dependencies are loaded. Look for the following output: "**wandb**: View run at [URL to your unique run]" +Click the link printed out above, or navigate to [wandb.ai](https://app.wandb.ai) to see your results stream in live. The link to see your run in the browser will appear after all the dependencies are loaded. Look for the following output: "**wandb**: View run at [URL to your unique run]" **Visualize Model Performance** It's easy to look across dozens of experiments, zoom in on interesting findings, and visualize highly dimensional data. diff --git a/models/integrations/huggingface_transformers.mdx b/models/integrations/huggingface_transformers.mdx index 2d723aa47f..d1b34952b0 100644 --- a/models/integrations/huggingface_transformers.mdx +++ b/models/integrations/huggingface_transformers.mdx @@ -26,7 +26,7 @@ trainer = Trainer(..., args=args) -If you'd rather dive straight into working code, check out this [Google Colab](https://wandb.me/hf). +If you'd rather dive straight into working code, see this [Google Colab](https://wandb.me/hf). ## Get started: track experiments @@ -81,7 +81,7 @@ wandb.login() -If you are using W&B for the first time you might want to check out our [quickstart](/models/quickstart/) +If you are using W&B for the first time you might want to see our [quickstart](/models/quickstart/) ### Name the project diff --git a/models/integrations/keras.mdx b/models/integrations/keras.mdx index 4ae298589e..6b8ee06503 100644 --- a/models/integrations/keras.mdx +++ b/models/integrations/keras.mdx @@ -266,7 +266,7 @@ See our [example repo](https://github.com/wandb/examples) for scripts, including The `WandbCallback` class supports a wide variety of logging configuration options: specifying a metric to monitor, tracking of weights and gradients, logging of predictions on training_data and validation_data, and more. -Check out the reference documentation for the `keras.WandbCallback` for full details. +See the reference documentation for the `keras.WandbCallback` for full details. The `WandbCallback` diff --git a/models/integrations/lightgbm.mdx b/models/integrations/lightgbm.mdx index 24bb4b70ef..057461f345 100644 --- a/models/integrations/lightgbm.mdx +++ b/models/integrations/lightgbm.mdx @@ -20,14 +20,14 @@ log_summary(gbm, save_model_checkpoint=True) ``` -Looking for working code examples? Check out [our repository of examples on GitHub](https://github.com/wandb/examples/tree/master/examples/boosting-algorithms). +Looking for working code examples? See [our repository of examples on GitHub](https://github.com/wandb/examples/tree/master/examples/boosting-algorithms). ## Tuning your hyperparameters with Sweeps Attaining the maximum performance out of models requires tuning hyperparameters, like tree depth and learning rate. W&B [Sweeps](/models/sweeps/) is a powerful toolkit for configuring, orchestrating, and analyzing large hyperparameter testing experiments. -To learn more about these tools and see an example of how to use Sweeps with XGBoost, check out this interactive Colab notebook. +To learn more about these tools and see an example of how to use Sweeps with XGBoost, see this interactive Colab notebook. diff --git a/models/integrations/openai-fine-tuning.mdx b/models/integrations/openai-fine-tuning.mdx index 1eda1c17a2..813de45088 100644 --- a/models/integrations/openai-fine-tuning.mdx +++ b/models/integrations/openai-fine-tuning.mdx @@ -99,7 +99,7 @@ The training and validation data that you upload to OpenAI for fine-tuning are a ### Visualization -The datasets are visualized as W&B Tables, which allows you to explore, search, and interact with the dataset. Check out the training samples visualized using W&B Tables below. +The datasets are visualized as W&B Tables, which allows you to explore, search, and interact with the dataset. See the training samples visualized using W&B Tables below. OpenAI data diff --git a/models/integrations/pytorch.mdx b/models/integrations/pytorch.mdx index ef78bfcb34..1acb797d62 100644 --- a/models/integrations/pytorch.mdx +++ b/models/integrations/pytorch.mdx @@ -377,7 +377,7 @@ are saved to W&B's servers: no more losing track of which `.h5` or `.pb` corresponds to which training runs. For more advanced `wandb` features for storing, versioning, and distributing -models, check out our [Artifacts tools](https://www.wandb.com/artifacts). +models, see our [Artifacts tools](https://www.wandb.com/artifacts). ```python @@ -416,7 +416,7 @@ our documentation, the Project page, which organizes all the runs in a project, and the Run page, where this run's results will be stored. -Navigate to the Run page and check out these tabs: +Navigate to the Run page and see these tabs: 1. **Charts**, where the model gradients, parameter values, and loss are logged throughout training 2. **System**, which contains a variety of system metrics, including Disk I/O utilization, CPU and GPU metrics (watch that temperature soar), and more @@ -440,7 +440,7 @@ a number of hyperparameters. You can use W&B Sweeps to automate hyperparameter testing and explore the space of possible models and optimization strategies. -Check out a [Colab notebook demonstrating hyperparameter optimization using W&B Sweeps](https://wandb.me/sweeps-colab). +See a [Colab notebook demonstrating hyperparameter optimization using W&B Sweeps](https://wandb.me/sweeps-colab). Running a hyperparameter sweep with W&B is very easy. There are just 3 simple steps: diff --git a/models/integrations/scikit.mdx b/models/integrations/scikit.mdx index e36b8fe872..35b2bc0123 100644 --- a/models/integrations/scikit.mdx +++ b/models/integrations/scikit.mdx @@ -233,7 +233,7 @@ Plots how well calibrated the predicted probabilities of a classifier are and ho The closer the calibration curves are to a diagonal the better. A transposed sigmoid like curve represents an overfitted classifier, while a sigmoid like curve represents an underfitted classifier. By training isotonic and sigmoid calibrations of the model and comparing their curves we can figure out whether the model is over or underfitting and if so which calibration (sigmoid or isotonic) might help fix this. -For more details, check out [sklearn's docs](https://scikit-learn.org/stable/auto_examples/calibration/plot_calibration_curve.html). +For more details, see [sklearn's docs](https://scikit-learn.org/stable/auto_examples/calibration/plot_calibration_curve.html). `wandb.sklearn.plot_calibration_curve(clf, X, y, 'RandomForestClassifier')` diff --git a/models/integrations/spacy.mdx b/models/integrations/spacy.mdx index 31ebeb64e1..d9227fdbba 100644 --- a/models/integrations/spacy.mdx +++ b/models/integrations/spacy.mdx @@ -62,7 +62,7 @@ wandb.login() spaCy config files are used to specify all aspects of training, not just logging -- GPU allocation, optimizer choice, dataset paths, and more. Minimally, under `[training.logger]` you need to provide the key `@loggers` with the value `"spacy.WandbLogger.v3"`, plus a `project_name`. -For more on how spaCy training config files work and on other options you can pass in to customize training, check out [spaCy's documentation](https://spacy.io/usage/training). +For more on how spaCy training config files work and on other options you can pass in to customize training, see [spaCy's documentation](https://spacy.io/usage/training). ```python diff --git a/models/integrations/ultralytics.mdx b/models/integrations/ultralytics.mdx index 4c3ccee1e3..fbcc10a3a7 100644 --- a/models/integrations/ultralytics.mdx +++ b/models/integrations/ultralytics.mdx @@ -36,7 +36,7 @@ import { ColabLink } from '/snippets/en/_includes/colab-link.mdx'; This section demonstrates a typical workflow of using an [Ultralytics](https://docs.ultralytics.com/modes/predict/) model for training, fine-tuning, and validation and performing experiment tracking, model-checkpointing, and visualization of the model's performance using [W&B](https://wandb.ai/site). -You can also check out about the integration in this report: [Supercharging Ultralytics with W&B](https://wandb.ai/geekyrakshit/ultralytics/reports/Supercharging-Ultralytics-with-Weights-Biases--Vmlldzo0OTMyMDI4) +You can also see the integration in this report: [Supercharging Ultralytics with W&B](https://wandb.ai/geekyrakshit/ultralytics/reports/Supercharging-Ultralytics-with-Weights-Biases--Vmlldzo0OTMyMDI4) To use the W&B integration with Ultralytics, import the `wandb.integration.ultralytics.add_wandb_callback` function. @@ -83,7 +83,7 @@ This section demonstrates a typical workflow of using an [Ultralytics](https://d You can try out the code in Google Colab: [Open in Colab](https://wandb.me/ultralytics-inference). -You can also check out about the integration in this report: [Supercharging Ultralytics with W&B](https://wandb.ai/geekyrakshit/ultralytics/reports/Supercharging-Ultralytics-with-Weights-Biases--Vmlldzo0OTMyMDI4) +You can also see the integration in this report: [Supercharging Ultralytics with W&B](https://wandb.ai/geekyrakshit/ultralytics/reports/Supercharging-Ultralytics-with-Weights-Biases--Vmlldzo0OTMyMDI4) In order to use the W&B integration with Ultralytics, we need to import the `wandb.integration.ultralytics.add_wandb_callback` function. @@ -94,7 +94,7 @@ from wandb.integration.ultralytics import add_wandb_callback from ultralytics.engine.model import YOLO ``` -Download a few images to test the integration on. You can use still images, videos, or camera sources. For more information on inference sources, check out the [Ultralytics docs](https://docs.ultralytics.com/modes/predict/). +Download a few images to test the integration on. You can use still images, videos, or camera sources. For more information on inference sources, see the [Ultralytics docs](https://docs.ultralytics.com/modes/predict/). ```bash !wget https://raw.githubusercontent.com/wandb/examples/ultralytics/colabs/ultralytics/assets/img1.png diff --git a/models/integrations/xgboost.mdx b/models/integrations/xgboost.mdx index a306050a31..e971cb10bf 100644 --- a/models/integrations/xgboost.mdx +++ b/models/integrations/xgboost.mdx @@ -54,7 +54,7 @@ Passing `WandbCallback` to a XGBoost model will: You can review the [source code for WandbCallback](https://github.com/wandb/wandb/blob/main/wandb/integration/xgboost/xgboost.py). -For additional examples, check out the [repository of examples on GitHub](https://github.com/wandb/examples/tree/master/examples/boosting-algorithms). +For additional examples, see the [repository of examples on GitHub](https://github.com/wandb/examples/tree/master/examples/boosting-algorithms). ## Tune your hyperparameters with Sweeps diff --git a/models/integrations/yolov5.mdx b/models/integrations/yolov5.mdx index 53b994cbfa..fd15bdbaaf 100644 --- a/models/integrations/yolov5.mdx +++ b/models/integrations/yolov5.mdx @@ -66,5 +66,5 @@ Here's what that looks like. -With data and model versioning, you can resume paused or crashed experiments from any device, no setup necessary. Check out [the Colab ](https://wandb.me/yolo-colab) for details. +With data and model versioning, you can resume paused or crashed experiments from any device, no setup necessary. See [the Colab ](https://wandb.me/yolo-colab) for details. \ No newline at end of file diff --git a/models/registry.mdx b/models/registry.mdx index 717a08180c..bf0102e0bc 100644 --- a/models/registry.mdx +++ b/models/registry.mdx @@ -106,7 +106,7 @@ Based on your deployment type, satisfy the following conditions to enable W&B Re Depending on your use case, explore the following resources to get started with the W&B Registry: -* Check out the tutorial video: +* See the tutorial video: * [Getting started with Registry from W&B](https://www.youtube.com/watch?v=p4XkVOsjIeM) * Take the W&B [Model CI/CD](https://www.wandb.courses/courses/enterprise-model-management) course and learn how to: * Use W&B Registry to manage and version your artifacts, track lineage, and promote models through different lifecycle stages. diff --git a/models/reports.mdx b/models/reports.mdx index a4954ce936..fb9410ffc9 100644 --- a/models/reports.mdx +++ b/models/reports.mdx @@ -47,7 +47,7 @@ See the [Create a report](/models/reports/create-a-report/) page for more inform ## How to get started Depending on your use case, explore the following resources to get started with W&B Reports: -* Check out our [video demonstration](https://www.youtube.com/watch?v=2xeJIv_K_eI) to get an overview of W&B Reports. +* See our [video demonstration](https://www.youtube.com/watch?v=2xeJIv_K_eI) to get an overview of W&B Reports. * Explore the [Reports gallery](/models/reports/reports-gallery/) for examples of live reports. * Try the [Programmatic Workspaces](https://colab.research.google.com/github/wandb/wandb-workspaces/blob/Update-wandb-workspaces-tuturial/Workspace_tutorial.ipynb) notebook to learn how to create and customize your workspace. * Read curated Reports in [W&B Fully Connected](https://wandb.me/fc). diff --git a/models/reports/clone-and-export-reports.mdx b/models/reports/clone-and-export-reports.mdx index 1f30e4e91b..950c24c9d3 100644 --- a/models/reports/clone-and-export-reports.mdx +++ b/models/reports/clone-and-export-reports.mdx @@ -9,13 +9,13 @@ W&B Report and Workspace API is in Public Preview. ## Export reports -Export a report as a PDF or LaTeX. Within your report, select the kebab icon to expand the dropdown menu. Choose **Download and** select either PDF or LaTeX output format. +Export a report as a PDF or LaTeX. Within your report, select the kebab icon to expand the dropdown menu. Select **Download and** select either PDF or LaTeX output format. ## Cloning reports -Within your report, select the kebab icon to expand the dropdown menu. Choose the **Clone this report** button. Pick a destination for your cloned report in the modal. Choose **Clone report**. +Within your report, select the kebab icon to expand the dropdown menu. Select the **Clone this report** button. Pick a destination for your cloned report in the modal. Select **Clone report**. Cloning reports diff --git a/models/reports/edit-a-report.mdx b/models/reports/edit-a-report.mdx index c9e7d6e54a..8ebfd3c52d 100644 --- a/models/reports/edit-a-report.mdx +++ b/models/reports/edit-a-report.mdx @@ -16,7 +16,7 @@ _Panel grids_ are a specific type of block that hold panels and _run sets_. Run -Check out the [Programmatic workspaces notebook](https://colab.research.google.com/github/wandb/wandb-workspaces/blob/Update-wandb-workspaces-tuturial/Workspace_tutorial.ipynb) for a step by step example on how create and customize a saved workspace view. +See the [Programmatic workspaces notebook](https://colab.research.google.com/github/wandb/wandb-workspaces/blob/Update-wandb-workspaces-tuturial/Workspace_tutorial.ipynb) for a step by step example on how create and customize a saved workspace view. @@ -79,7 +79,7 @@ Add run sets from projects interactively with the App UI or the W&B SDK. -Enter a forward slash (`/`) in the report to display a dropdown menu. From the dropdown, choose **Panel Grid**. This will automatically import the run set from the project the report was created from. +Enter a forward slash (`/`) in the report to display a dropdown menu. From the dropdown, select **Panel Grid**. This will automatically import the run set from the project the report was created from. If you import a panel into a report, run names are inherited from the project. In the report, you can optionally [rename a run](/models/runs/#rename-a-run) to give the reader more context. The run is renamed only in the individual panel. If you clone the panel in the same report, the run is also renamed in the cloned panel. @@ -500,7 +500,7 @@ Add code blocks to your report interactively with the App UI or with the W&B SDK -Enter a forward slash (`/`) in the report to display a dropdown menu. From the dropdown choose **Code**. +Enter a forward slash (`/`) in the report to display a dropdown menu. From the dropdown select **Code**. Select the name of the programming language on the right hand of the code block. This will expand a dropdown. From the dropdown, select your programming language syntax. You can choose from Javascript, Python, CSS, JSON, HTML, Markdown, and YAML. @@ -560,7 +560,7 @@ Add markdown to your report interactively with the App UI or with the W&B SDK. -Enter a forward slash (`/`) in the report to display a dropdown menu. From the dropdown choose **Markdown**. +Enter a forward slash (`/`) in the report to display a dropdown menu. From the dropdown select **Markdown**. Use the `wandb.apis.reports.MarkdownBlock` Class to create a markdown block programmatically. Pass a string to the `text` parameter: @@ -700,6 +700,6 @@ Collapse headers in a Report to hide content within a text block. When the repor To effectively visualize relationships across multiple dimensions, use a color gradient to represent one of the variables. This enhances clarity and makes patterns easier to interpret. -1. Choose a variable to represent with a color gradient (e.g., penalty scores, learning rates, etc.). This allows for a clearer understanding of how penalty (color) interacts with reward/side effects (y-axis) over training time (x-axis). +1. Select a variable to represent with a color gradient (e.g., penalty scores, learning rates, etc.). This allows for a clearer understanding of how penalty (color) interacts with reward/side effects (y-axis) over training time (x-axis). 2. Highlight key trends. Hovering over a specific group of runs highlights them in the visualization. diff --git a/models/runs.mdx b/models/runs.mdx index 73833fc386..c5a9dcb2d7 100644 --- a/models/runs.mdx +++ b/models/runs.mdx @@ -137,5 +137,5 @@ Notes that you add to a specific run appear on the run page in the **Overview** 1. Navigate to your W&B project 2. Select the **Workspace** tab from the project sidebar 3. Select the run you want to add a note to from the run selector -4. Choose the **Overview** tab +4. Select the **Overview** tab 5. Select the pencil icon next to the **Description** field and add your notes */} diff --git a/models/runs/alert.mdx b/models/runs/alert.mdx index b733b63902..eaf3a42a0f 100644 --- a/models/runs/alert.mdx +++ b/models/runs/alert.mdx @@ -33,7 +33,7 @@ To set up an alert, take these steps, which are detailed in the following sectio 2. Add `run.alert()` to your code. 3. Test the configuration. -### 1. Turn on alerts in your W&B User Settings +### 1. Turn on alerts in your W&B user settings In your [User Settings](https://wandb.ai/settings): diff --git a/models/runs/delete-runs.mdx b/models/runs/delete-runs.mdx index b0c6ccd7aa..5be15512c6 100644 --- a/models/runs/delete-runs.mdx +++ b/models/runs/delete-runs.mdx @@ -11,8 +11,8 @@ Delete runs from a project with the W&B App or the Python API. 1. Navigate to the project that contains the runs you want to delete. 2. Select the **Runs** tab. 3. Select the checkbox next to the runs you want to delete. -4. Choose the **Delete** button (trash can icon) above the table. -5. From the drawer that appears, choose **Delete**. +4. Select the **Delete** button (trash can icon) above the table. +5. From the drawer that appears, select **Delete**. For projects that contain a large number of runs, you can use either the search bar to filter runs you want to delete using Regex or the filter button to filter runs based on their status, tags, or other properties. diff --git a/models/runs/manage-runs.mdx b/models/runs/manage-runs.mdx index e01c4fb2eb..a7f79c2377 100644 --- a/models/runs/manage-runs.mdx +++ b/models/runs/manage-runs.mdx @@ -26,7 +26,7 @@ You can group runs by moving them into an existing group or creating a new group 1. Navigate to the project that contains the runs you want to move. 2. Select the **Runs** tab from the project sidebar. 3. Select the checkbox next to the runs you want to move. -4. Choose the **Move to group** button above the table. +4. Select the **Move to group** button above the table. 5. In the modal, select the target group or create a new group. 6. Click **Move**. */} diff --git a/models/runs/run-identifiers.mdx b/models/runs/run-identifiers.mdx index 996a30432e..b7161c99a1 100644 --- a/models/runs/run-identifiers.mdx +++ b/models/runs/run-identifiers.mdx @@ -43,7 +43,7 @@ You can also find a run's unique ID in the W&B App: 2. Navigate to the W&B project you specified when you initialized the run. 3. Within your project's workspace, select either the **Workspace** or **Runs** tab. 4. Select the run you want to view. -5. Choose the **Overview** tab. +5. Select the **Overview** tab. W&B displays the run ID in the **Run path** field. The run path consists of the name of your team, the name of the project, and the run ID. The unique ID is the last part of the run path. diff --git a/models/runs/run-states.mdx b/models/runs/run-states.mdx index 5a2fe46946..ed12f70a16 100644 --- a/models/runs/run-states.mdx +++ b/models/runs/run-states.mdx @@ -65,7 +65,7 @@ View the state of a run from the W&B App: 1. Select the **Workspace** or **Runs** tab from the project sidebar. 1. Search or scroll to the run you want to view. 1. Select the run to open the run overview page. -1. Choose the **Overview** tab. +1. Select the **Overview** tab. Next to the **State** field, view the current state of the run. diff --git a/models/runs/stop-runs.mdx b/models/runs/stop-runs.mdx index 55c9ee6ebf..5ee19ab9c8 100644 --- a/models/runs/stop-runs.mdx +++ b/models/runs/stop-runs.mdx @@ -14,7 +14,7 @@ Stop a run programmatically with the W&B Python SDK or interactively in the W&B 1. Navigate to the project that your run is logging to. 2. Select the run you want to stop within the run selector. -3. Choose the **Overview** tab. +3. Select the **Overview** tab. 4. Select the stop button next to the **State** field. Next to the **State** field, the run's state changes from `running` to `Killed`. diff --git a/models/sweeps/visualize-sweep-results.mdx b/models/sweeps/visualize-sweep-results.mdx index 531ade653a..04a3d3bfa2 100644 --- a/models/sweeps/visualize-sweep-results.mdx +++ b/models/sweeps/visualize-sweep-results.mdx @@ -28,6 +28,6 @@ The parameter importance plot(right) lists the hyperparameters that were the bes -You can alter the dependent and independent values (x and y axis) that are automatically used. Within each panel there is a pencil icon called **Edit panel**. Choose **Edit panel**. A model will appear. Within the modal, you can alter the behavior of the graph. +You can alter the dependent and independent values (x and y axis) that are automatically used. Within each panel there is a pencil icon called **Edit panel**. Select **Edit panel**. A model will appear. Within the modal, you can alter the behavior of the graph. For more information on all default W&B visualization options, see [Panels](/models/app/features/panels/). See the [Data Visualization docs](/models/tables/) for information on how to create plots from W&B Runs that are not part of a W&B Sweep. \ No newline at end of file diff --git a/models/tables/tables-download.mdx b/models/tables/tables-download.mdx index 6900e9eabe..f8a513386c 100644 --- a/models/tables/tables-download.mdx +++ b/models/tables/tables-download.mdx @@ -41,6 +41,6 @@ df.to_csv("example.csv", encoding="utf-8") ``` # Next Steps -- Check out the [reference documentation](/models/artifacts/construct-an-artifact/) on `artifacts`. +- See the [reference documentation](/models/artifacts/construct-an-artifact/) on `artifacts`. - Go through our [Tables Walkthrough](/models/tables/tables-walkthrough/) guide. -- Check out the [Dataframe](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) reference docs. \ No newline at end of file +- See the [Dataframe](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) reference docs. \ No newline at end of file diff --git a/models/tables/tables-gallery.mdx b/models/tables/tables-gallery.mdx index 4dbd8867d3..9f45d1d7d6 100644 --- a/models/tables/tables-gallery.mdx +++ b/models/tables/tables-gallery.mdx @@ -13,7 +13,7 @@ Log metrics and rich media during model training or evaluation, then visualize r Data browsing table -For example, check out this table that shows a [balanced split of a photos dataset](https://wandb.ai/stacey/mendeleev/artifacts/balanced_data/inat_80-10-10_5K/ab79f01e007113280018/files/data_split.table.json). +For example, see this table that shows a [balanced split of a photos dataset](https://wandb.ai/stacey/mendeleev/artifacts/balanced_data/inat_80-10-10_5K/ab79f01e007113280018/files/data_split.table.json). ### Interactively explore your data diff --git a/models/tables/visualize-tables.mdx b/models/tables/visualize-tables.mdx index 66d5aee7d1..32e7cf5b2c 100644 --- a/models/tables/visualize-tables.mdx +++ b/models/tables/visualize-tables.mdx @@ -31,7 +31,7 @@ Compare two tables with a [merged view](#merged-view) or a [side-by-side view](# Follow these steps to compare two tables: -1. Go to your project in the W&B App. +1. Navigate to your project in the W&B App. 2. Select the artifacts icon in the project sidebar. 2. Select an artifact version. diff --git a/models/track/jupyter.mdx b/models/track/jupyter.mdx index 33ac4da996..3d310f07b7 100644 --- a/models/track/jupyter.mdx +++ b/models/track/jupyter.mdx @@ -79,7 +79,7 @@ run.finish() ``` -Want to know more about what you can do with W&B? Check out our [guide to logging data and media](/models/track/log/), learn [how to integrate us with your favorite ML toolkits](/models/integrations), or just dive straight into the [reference docs](/models/ref/python/) or our [repo of examples](https://github.com/wandb/examples). +Want to know more about what you can do with W&B? See our [guide to logging data and media](/models/track/log/), learn [how to integrate us with your favorite ML toolkits](/models/integrations), or just dive straight into the [reference docs](/models/ref/python/) or our [repo of examples](https://github.com/wandb/examples). ## Additional Jupyter features in W&B diff --git a/models/track/limits.mdx b/models/track/limits.mdx index c0f66cf276..bd61b1ec48 100644 --- a/models/track/limits.mdx +++ b/models/track/limits.mdx @@ -225,7 +225,7 @@ There are a few ways that the performance of your python script is reduced: 3. If you call `wandb.Run.log()` more than a few times per second. This is due to a small latency added to the training loop every time `wandb.Run.log()` is called. -Is frequent logging slowing your training runs down? Check out [this Colab](https://wandb.me/log-hf-colab) for methods to get better performance by changing your logging strategy. +Is frequent logging slowing your training runs down? See [this Colab](https://wandb.me/log-hf-colab) for methods to get better performance by changing your logging strategy. W&B does not assert any limits beyond rate limiting. The W&B Python SDK automatically completes an exponential "backoff" and "retry" requests that exceed limits. W&B Python SDK responds with a “Network failure” on the command line. For unpaid accounts, W&B may reach out in extreme cases where usage exceeds reasonable thresholds. diff --git a/models/track/log/media.mdx b/models/track/log/media.mdx index 2f5d07b53b..c03df5ab15 100644 --- a/models/track/log/media.mdx +++ b/models/track/log/media.mdx @@ -13,7 +13,7 @@ For details, see the [Data types reference](/models/ref/python/data-types/). -For more details, check out a [demo report about visualize model predictions](https://wandb.ai/lavanyashukla/visualize-predictions/reports/Visualize-Model-Predictions--Vmlldzo1NjM4OA) or watch a [video walkthrough](https://www.youtube.com/watch?v=96MxRvx15Ts). +For more details, see the [demo report about visualize model predictions](https://wandb.ai/lavanyashukla/visualize-predictions/reports/Visualize-Model-Predictions--Vmlldzo1NjM4OA) or watch a [video walkthrough](https://www.youtube.com/watch?v=96MxRvx15Ts). ## Pre-requisites @@ -163,7 +163,7 @@ To log a bounding box, you'll need to provide a dictionary with the following ke * `box_caption`: (optional) a string to be displayed as the label text on this box * `class_labels`: (optional) A dictionary mapping `class_id`s to strings. By default we will generate class labels `class_0`, `class_1`, etc. -Check out this example: +See this example: ```python import wandb @@ -585,7 +585,7 @@ Videos are logged using the [`wandb.Video`](/models/ref/python/) data type: run.log({"example": wandb.Video("myvideo.mp4")}) ``` -Now you can view videos in the media browser. Go to your project workspace, run workspace, or report and click **Add visualization** to add a rich media panel. +Now you can view videos in the media browser. Navigate to your project workspace, run workspace, or report and click **Add visualization** to add a rich media panel. ## 2D view of a molecule diff --git a/models/track/project-page.mdx b/models/track/project-page.mdx index f445966030..753322f3a9 100644 --- a/models/track/project-page.mdx +++ b/models/track/project-page.mdx @@ -143,7 +143,7 @@ When you customize the Runs tab, the customization is also reflected in the **Ru - To view all visible columns, scroll the page horizontally. - To change the order of the columns, drag a column to the left or right. -- To pin a column, hover over the column name, click the action menu `...`. that appears, then click **Pin column**. Pinned columns appear near the left of the page, after the **Name** column. To unpin a pinned column, choose **Unpin column**. +- To pin a column, hover over the column name, click the action menu `...`. that appears, then click **Pin column**. Pinned columns appear near the left of the page, after the **Name** column. To unpin a pinned column, select **Unpin column**. - To hide a column, hover over the column name, click the action menu `...`. that appears, then click **Hide column**. To view all columns that are currently hidden, click **Columns**. - To show, hide, pin, and unpin multiple columns at once, click **Columns**. - Click the name of a hidden column to unhide it. diff --git a/models/track/public-api-guide.mdx b/models/track/public-api-guide.mdx index 59bc4d6a1e..2316b3be1f 100644 --- a/models/track/public-api-guide.mdx +++ b/models/track/public-api-guide.mdx @@ -313,11 +313,11 @@ If you're thinking about ways to set useful identifiers for your runs, here's wh - **Run notes**: This is a great place to put a quick description of what you're doing in your run. You can set this with `wandb.init(notes="your notes here")` - **Run tags**: Track things dynamically in run tags, and use filters in the UI to filter your table down to just the runs you care about. You can set tags from your script and then edit them in the UI, both in the runs table and the overview tab of the run page. See the detailed instructions [here](/models/runs/tags/). -## Public API Examples +## Public API examples ### Export data to visualize in matplotlib or seaborn -Check out our [API examples](/models/ref/python/public-api/) for some common export patterns. You can also click the download button on a custom plot or on the expanded runs table to download a CSV from your browser. +See our [API examples](/models/ref/python/public-api/) for some common export patterns. You can also click the download button on a custom plot or on the expanded runs table to download a CSV from your browser. ### Read metrics from a run diff --git a/models/track/workspaces.mdx b/models/track/workspaces.mdx index 02c423c774..ed95de9e8e 100644 --- a/models/track/workspaces.mdx +++ b/models/track/workspaces.mdx @@ -54,7 +54,7 @@ Remove saved views that are no longer needed. 1. Navigate to the saved view you want to remove. 2. Select the three horizontal lines (**...**) at the top right of the view. -3. Choose **Delete view**. +3. Select **Delete view**. 4. Confirm the deletion to remove the view from your workspace menu. ### Share a workspace view @@ -143,7 +143,7 @@ New workspaces will use these settings instead of the defaults. ### View your workspace template To view your workspace template's current configuration: -1. From any page, select your user icon on the top right corner. From the dropdown, choose **User Settings**. +1. From any page, select your user icon on the top right corner. From the dropdown, select **User Settings**. 1. Navigate to the **Personal workspace template** section. If you are using a workspace template, its configuration displays. Otherwise, the section includes no details. ### Update your workspace template @@ -157,7 +157,7 @@ To update your workspace template: ### Delete your workspace template To delete your workspace template and go back to the default settings: -1. From any page, select your user icon on the top right corner. From the dropdown, choose **User Settings**. +1. From any page, select your user icon on the top right corner. From the dropdown, select **User Settings**. 1. Navigate to the **Personal workspace template** section. Your workspace template's configuration displays. 1. Click the trash icon next to **Settings**. diff --git a/platform/app/settings-page/billing-settings.mdx b/platform/app/settings-page/billing-settings.mdx index 745c3ff87f..6e640802c8 100644 --- a/platform/app/settings-page/billing-settings.mdx +++ b/platform/app/settings-page/billing-settings.mdx @@ -3,7 +3,7 @@ description: "View plan details, monitor usage, and configure usage and spending title: Manage billing settings --- -Navigate to your user profile page and select your user icon on the top right corner. From the dropdown, choose **Billing**, or choose **Settings** and then select the **Billing** tab. +Navigate to your user profile page and select your user icon on the top right corner. From the dropdown, select **Billing**, or select **Settings** and then select the **Billing** tab. ## Plan details diff --git a/platform/app/settings-page/emails.mdx b/platform/app/settings-page/emails.mdx index 3c31891c11..7419002e24 100644 --- a/platform/app/settings-page/emails.mdx +++ b/platform/app/settings-page/emails.mdx @@ -30,7 +30,7 @@ Select **+ Add Email** to add an email. This will take you to an Auth0 page. You ## Delete emails -Select the kebab dropdown and choose **Delete Emails** to delete an email that is registered to your W&B account +Select the kebab dropdown and select **Delete Emails** to delete an email that is registered to your W&B account Primary emails cannot be deleted. You need to set a different email as a primary email before deleting. diff --git a/platform/app/settings-page/team-settings.mdx b/platform/app/settings-page/team-settings.mdx index 022f69d29b..d6e0881bd2 100644 --- a/platform/app/settings-page/team-settings.mdx +++ b/platform/app/settings-page/team-settings.mdx @@ -25,7 +25,7 @@ See [Add and Manage teams](/platform/hosting/iam/access-management/manage-organi Set an avatar by navigating to the **Avatar** section and uploading an image. 1. Select the **Update Avatar** to prompt a file dialog to appear. -2. From the file dialog, choose the image you want to use. +2. From the file dialog, select the image you want to use. ## Alerts @@ -66,4 +66,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](/platform/app/settings-page/teams/#secure-storage-connector) or check out our [W&B Server](/platform/hosting/data-security/secure-storage-connector) 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](/platform/app/settings-page/teams/#secure-storage-connector) or see our [W&B Server](/platform/hosting/data-security/secure-storage-connector) docs if you are self-hosting. diff --git a/platform/app/settings-page/teams.mdx b/platform/app/settings-page/teams.mdx index 3f8f902172..90cd0ae27b 100644 --- a/platform/app/settings-page/teams.mdx +++ b/platform/app/settings-page/teams.mdx @@ -100,7 +100,7 @@ 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](#secure-storage-connector) or check out our [W&B Server](/platform/hosting/data-security/secure-storage-connector) 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](#secure-storage-connector) or see our [W&B Server](/platform/hosting/data-security/secure-storage-connector) docs if you are self-hosting. ## Create a team profile diff --git a/platform/app/settings-page/user-settings.mdx b/platform/app/settings-page/user-settings.mdx index 8445dd8fa9..afadf5b900 100644 --- a/platform/app/settings-page/user-settings.mdx +++ b/platform/app/settings-page/user-settings.mdx @@ -8,7 +8,7 @@ title: Manage user settings import ApiKeyCreate from "/snippets/en/_includes/api-key-create.mdx"; import ApiKeySecurity from "/snippets/en/_includes/api-key-security.mdx"; -Navigate to your user profile page and select your user icon on the top right corner. From the dropdown, choose **Settings**. +Navigate to your user profile page and select your user icon on the top right corner. From the dropdown, select **Settings**. ## Profile @@ -17,7 +17,7 @@ Within the **Profile** section you can manage and modify your account name and i ## Edit your intro To edit your intro, click **Edit** at the top of your profile. The WYSIWYG editor that opens supports Markdown. -1. To edit a line, click it. To save time, you can type `/` and choose Markdown from the list. +1. To edit a line, click it. To save time, you can type `/` and select Markdown from the list. 1. Use an item's drag handles to move it. 1. To delete a block, click the drag handle, then click **Delete**. 1. To save your changes, click **Save**. @@ -54,7 +54,7 @@ To specify the default team when you’re running a script in an automated envir ## Teams The **Teams** section lists all of your teams. -1. Click a team name to go to the team page. +1. Click a team name to navigate to the team page. 1. If you have permission to join additional teams, click **View teams** next to **We found teams for you to join**. 1. Optionally, turn on **Hide teams in public profile**. diff --git a/platform/hosting/data-security/secure-storage-connector.mdx b/platform/hosting/data-security/secure-storage-connector.mdx index 2876438959..8c90b28414 100644 --- a/platform/hosting/data-security/secure-storage-connector.mdx +++ b/platform/hosting/data-security/secure-storage-connector.mdx @@ -362,7 +362,7 @@ For details, see [Create a blob storage container](https://learn.microsoft.com/e 1. Create a container with a name of your choice. Optionally create a folder which you can configure as sub-path to store all W&B files. 1. Configure the CORS policy on the container. - To set the CORS policy through the UI go to the blob storage, scroll down to `Settings/Resource Sharing (CORS)` and then set the following: + To set the CORS policy through the UI navigate to the blob storage, scroll down to `Settings/Resource Sharing (CORS)` and then set the following: | Parameter | Value | | --- | --- | diff --git a/platform/hosting/enterprise-licenses.mdx b/platform/hosting/enterprise-licenses.mdx index f4633f9470..bdc479f39b 100644 --- a/platform/hosting/enterprise-licenses.mdx +++ b/platform/hosting/enterprise-licenses.mdx @@ -97,7 +97,7 @@ Next, [verify your Enterprise license](#verify-or-update-an-enterprise-license). As an instance or organization admin, follow these steps to verify and manage your Enterprise license: 1. In the W&B App, click your user profile icon in the top right, then click **System Console**. -1. Go to the **License** tab. A dashboard summarizes the license's entitlements, expiration, and usage over time. If you see an error, see [Common issues](#common-issues). +1. Navigate to the **License** tab. A dashboard summarizes the license's entitlements, expiration, and usage over time. If you see an error, see [Common issues](#common-issues). 1. For detailed information about the license and its entitlements, click **View license online**. From this page, you can also order a new trial or production license. At the top of the page, click **New license order** and submit the form. diff --git a/platform/hosting/hosting-options/dedicated-cloud/regions.mdx b/platform/hosting/hosting-options/dedicated-cloud/regions.mdx index 18b05d8786..e06b2a1f1f 100644 --- a/platform/hosting/hosting-options/dedicated-cloud/regions.mdx +++ b/platform/hosting/hosting-options/dedicated-cloud/regions.mdx @@ -9,7 +9,7 @@ AWS, Google Cloud, and Azure support cloud computing services in multiple locati Reach out to W&B Support if your preferred AWS, Google Cloud, or Azure Region is not listed. W&B can validate if the relevant region has all the services that Dedicated Cloud needs and prioritize support depending on the outcome of the evaluation. -## Supported AWS Regions +## Supported AWS regions The following table lists [AWS Regions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) that W&B currently supports for Dedicated Cloud instances. @@ -57,7 +57,7 @@ The following table lists [Google Cloud Regions](https://cloud.google.com/comput For more information about Google Cloud Regions, see [Regions and zones](https://cloud.google.com/compute/docs/regions-zones) in the Google Cloud Documentation. -## Supported Azure Region +## Supported Azure region The following table lists [Azure regions](https://azure.microsoft.com/explore/global-infrastructure/geographies/#geographies) that W&B currently supports for Dedicated Cloud instances. | Region location | Region name | diff --git a/platform/hosting/hosting-options/dedicated_regions.mdx b/platform/hosting/hosting-options/dedicated_regions.mdx index 065f7a8bda..473f8ab676 100644 --- a/platform/hosting/hosting-options/dedicated_regions.mdx +++ b/platform/hosting/hosting-options/dedicated_regions.mdx @@ -9,7 +9,7 @@ AWS, Google Cloud, and Azure support cloud computing services in multiple locati Reach out to W&B Support if your preferred AWS, Google Cloud, or Azure Region is not listed. W&B can validate if the relevant region has all the services that Dedicated Cloud needs and prioritize support depending on the outcome of the evaluation. -## Supported AWS Regions +## Supported AWS regions The following table lists [AWS Regions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) that W&B currently supports for Dedicated Cloud instances. @@ -57,7 +57,7 @@ The following table lists [Google Cloud Regions](https://cloud.google.com/comput For more information about Google Cloud Regions, see [Regions and zones](https://cloud.google.com/compute/docs/regions-zones) in the Google Cloud Documentation. -## Supported Azure Region +## Supported Azure region The following table lists [Azure regions](https://azure.microsoft.com/explore/global-infrastructure/geographies/#geographies) that W&B currently supports for Dedicated Cloud instances. | Region location | Region name | diff --git a/platform/hosting/iam/access-management/manage-organization.mdx b/platform/hosting/iam/access-management/manage-organization.mdx index 5345fa6867..92031d674b 100644 --- a/platform/hosting/iam/access-management/manage-organization.mdx +++ b/platform/hosting/iam/access-management/manage-organization.mdx @@ -137,7 +137,7 @@ This table summarizes the behavior of new and existing users with and without do To automatically assign non-invited new users to a default team when they join your organization: 1. Navigate to https://wandb.ai/home. -2. In the upper right corner of the page, select the **User menu** dropdown. From the dropdown, choose **Settings**. +2. In the upper right corner of the page, select the **User menu** dropdown. From the dropdown, select **Settings**. 3. Within the **Settings** tab, select **General**. 4. Click the **Claim domain** button within **Domain capture**. 5. Select the team that you want new users to automatically join from the **Default team** dropdown. If no teams are available, you'll need to update team settings. See the instructions in [Add and manage teams](#add-and-manage-teams). @@ -178,7 +178,7 @@ A user within an organization can have one of the proceeding roles: To change a user's role: 1. Navigate to https://wandb.ai/home. -2. In the upper right corner of the page, select the **User menu** dropdown. From the dropdown, choose **Users**. +2. In the upper right corner of the page, select the **User menu** dropdown. From the dropdown, select **Users**. 4. Provide the name or email of the user in the search bar. 4. Select a role from the **TEAM ROLE** dropdown next to the name of the user. @@ -205,16 +205,16 @@ The organization role and subscription type determines which seat types are avai ### Remove a user 1. Navigate to https://wandb.ai/home. -2. In the upper right corner of the page, select the **User menu** dropdown. From the dropdown, choose **Users**. +2. In the upper right corner of the page, select the **User menu** dropdown. From the dropdown, select **Users**. 4. Provide the name or email of the user in the search bar. 5. Select the ellipses or three dots icon (**...**) when it appears. -6. From the dropdown, choose **Remove member**. +6. From the dropdown, select **Remove member**. ### Assign the billing admin 1. Navigate to https://wandb.ai/home. -2. In the upper right corner of the page, select the **User menu** dropdown. From the dropdown, choose **Users**. +2. In the upper right corner of the page, select the **User menu** dropdown. From the dropdown, select **Users**. 4. Provide the name or email of the user in the search bar. -5. Under the **Billing admin** column, choose the user you want to assign as the billing admin. +5. Under the **Billing admin** column, select the user you want to assign as the billing admin. ## Add and manage teams @@ -234,7 +234,7 @@ Use your organization's dashboard to create a team: Create new team 3. Provide a name for your team in the **Team name** field in the modal that appears. -4. Choose a storage type. +4. Select a storage type. 5. Select the **Create team** button. After you select **Create team** button, W&B redirects you to a new team page at `https://wandb.ai/`. Where `` consists of the name you provide when you create a team. @@ -270,7 +270,7 @@ An organization admin must enable domain claiming. To enable domain capture, see 1. Select the account type icon next to the name of the team member. -2. From the drop-down, choose the account type you want that team member to posses. +2. From the drop-down, select the account type you want that team member to possess. This table lists the roles you can assign to a member of a team: @@ -314,7 +314,7 @@ To create a custom role: 1. Click **Roles**. 1. In the **Custom roles** section, click **Create a role**. 1. Provide a name for the role. Optionally provide a description. -1. Choose the role to base the custom role on, either **Viewer** or **Member**. +1. Select the role to base the custom role on, either **Viewer** or **Member**. 1. To add permissions, click the **Search permissions** field, then select one or more permissions to add. 1. Review the **Custom role permissions** section, which summarizes the permissions the role has. 1. Click **Create Role**. @@ -324,7 +324,7 @@ To create a custom role: 1. Navigate to `https://.wandb.io/org/settings/`. Replace `` with your organization name. 1. In the **Custom roles** section, click **Create a role**. 1. Provide a name for the role. Optionally provide a description. -1. Choose the role to base the custom role on, either **Viewer** or **Member**. +1. Select the role to base the custom role on, either **Viewer** or **Member**. 1. To add permissions, click the **Search permissions** field, then select one or more permissions to add. 1. Review the **Custom role permissions** section, which summarizes the permissions the role has. 1. Click **Create Role**. diff --git a/platform/hosting/iam/advanced_env_vars.mdx b/platform/hosting/iam/advanced_env_vars.mdx index 8f91e26701..7cb6746dea 100644 --- a/platform/hosting/iam/advanced_env_vars.mdx +++ b/platform/hosting/iam/advanced_env_vars.mdx @@ -5,7 +5,7 @@ description: "Configure advanced IAM options for W&B with environment variables In addition to basic [environment variables](../env-vars), you can use environment variables to configure IAM options for your [Dedicated Cloud](/platform/hosting/hosting-options/dedicated-cloud) or [Self-Managed](/platform/hosting/hosting-options/self-managed) instance. -Choose any of the following environment variables for your instance depending on your IAM needs. +Select any of the following environment variables for your instance depending on your IAM needs. | Environment variable | Description | |----------------------|-------------| diff --git a/platform/hosting/iam/identity_federation.mdx b/platform/hosting/iam/identity_federation.mdx index 10adc61357..f1cbf4b36a 100644 --- a/platform/hosting/iam/identity_federation.mdx +++ b/platform/hosting/iam/identity_federation.mdx @@ -3,7 +3,7 @@ title: Use federated identities with SDK description: "Use identity federation with JSON Web Tokens (JWTs) to authenticate with the W&B SDK and CLI without API keys." --- -Use identity federation to sign in using your organizational credentials through W&B SDK. If your W&B organization admin has configured SSO for your organization, then you already use your organizational credentials to sign-in to the W&B app UI. In that sense, identity federation is like SSO for W&B SDK, but by using JSON Web Tokens (JWTs) directly. You can use identity federation as an alternative to API keys. +Use identity federation to log in using your organizational credentials through W&B SDK. If your W&B organization admin has configured SSO for your organization, then you already use your organizational credentials to log in to the W&B app UI. In that sense, identity federation is like SSO for W&B SDK, but by using JSON Web Tokens (JWTs) directly. You can use identity federation as an alternative to API keys. [RFC 7523](https://datatracker.ietf.org/doc/html/rfc7523) forms the underlying basis for identity federation with SDK. diff --git a/platform/hosting/iam/scim.mdx b/platform/hosting/iam/scim.mdx index 62b2493a86..6c1898c059 100644 --- a/platform/hosting/iam/scim.mdx +++ b/platform/hosting/iam/scim.mdx @@ -31,7 +31,7 @@ In addition, examples use user IDs such as `abc` and `def`. Real requests and re ## Authentication -Choose to authenticate using a user identity or a service account, after reviewing the key differences. +Select whether to authenticate using a user identity or a service account, after reviewing the key differences. ### Key differences - Who should use it: Users are best for interactive, one-off admin actions; service accounts are best for automation and integrations (CI/CD, provisioning tools). @@ -120,7 +120,7 @@ The response includes details about the user's activity in the organization: - **`lastActiveAt`**: ISO 8601 timestamp of the user's most recent activity. Returns `null` if the user has never been active. The definition of "active" differs by deployment type: -- **Dedicated Cloud / Self-Managed**: A user is active if they sign in, open any page in the W&B App, log runs, use the SDK, or interact with the W&B server in any way. +- **Dedicated Cloud / Self-Managed**: A user is active if they log in, open any page in the W&B App, log runs, use the SDK, or interact with the W&B server in any way. - **Multi-tenant Cloud**: A user is active if they perform any auditable action scoped to the organization after May 8, 2025. See [Audit logging actions](/platform/hosting/monitoring-usage/audit-logging#actions) for the full list. @@ -204,7 +204,7 @@ The response includes details about each user's activity in the organization: - **`lastActiveAt`**: ISO 8601 timestamp of the user's most recent activity. Returns `null` if the user has never been active. The definition of "active" differs by deployment type: -- **Dedicated Cloud / Self-Managed**: A user is active if they sign in, open any page in the W&B App, log runs, use the SDK, or interact with the W&B server in any way. +- **Dedicated Cloud / Self-Managed**: A user is active if they log in, open any page in the W&B App, log runs, use the SDK, or interact with the W&B server in any way. - **Multi-tenant Cloud**: A user is active if they perform any auditable action scoped to the organization after May 8, 2025. See [Audit logging actions](/platform/hosting/monitoring-usage/audit-logging#actions) for the full list. diff --git a/platform/hosting/iam/sso.mdx b/platform/hosting/iam/sso.mdx index 35cc7fb97a..896d07f875 100644 --- a/platform/hosting/iam/sso.mdx +++ b/platform/hosting/iam/sso.mdx @@ -27,7 +27,7 @@ This section shows how to configure your identity provider (IdP) for OIDC. Selec Follow the procedure below to set up AWS Cognito for authorization: -1. First, sign in to your AWS account and navigate to the [AWS Cognito](https://aws.amazon.com/cognito/) App. +1. First, log in to your AWS account and navigate to the [AWS Cognito](https://aws.amazon.com/cognito/) App. AWS Cognito setup @@ -125,7 +125,7 @@ The OIDC issuer URL has the following format: `https://COMPANY.okta.com`. Replac Next, [Set up SSO in W&B](#set-up-sso-in-w%26b). -Azure AD (Entra ID) supports two OIDC configuration modes for W&B. Choose the configuration that matches your security requirements: +Azure AD (Entra ID) supports two OIDC configuration modes for W&B. Select the configuration that matches your security requirements: - [Public Client](#public-client): Uses PKCE without a client secret. Simpler to configure, suitable for most deployments. - [Confidential Client](#confidential-client): Uses PKCE with a client secret for enhanced security. Required if you need to set the `GORILLA_OIDC_SECRET` environment variable. @@ -192,7 +192,7 @@ Use this configuration if you need to authenticate using a client secret. - Select **Certificates & secrets** from the left sidebar. - Click **New client secret**. - Add a description for the secret. - - Choose an expiration period. + - Select an expiration period. - Click **Add**. Copy and save the secret **Value** immediately (not the Secret ID). Client secret value @@ -226,7 +226,7 @@ To set up SSO, you need administrator privileges and the following information: - OIDC Client Secret (optional; depends on how you have setup your IdP) If your IdP requires a OIDC Client Secret, specify it by passing the [environment variables](/platform/hosting/env-vars) `GORILLA_OIDC_SECRET`. -- In the W&B App, go to **System Console** > **Settings** > **Advanced** > **User Spec** and add `GORILLA_OIDC_SECRET` to the `extraENV` section as shown below. +- In the W&B App, navigate to **System Console** > **Settings** > **Advanced** > **User Spec** and add `GORILLA_OIDC_SECRET` to the `extraENV` section as shown below. - In Helm, configure `values.global.extraEnv` as shown below. ```yaml values: diff --git a/platform/hosting/monitoring-usage/org_dashboard.mdx b/platform/hosting/monitoring-usage/org_dashboard.mdx index 8a43b248ef..c426ad93a8 100644 --- a/platform/hosting/monitoring-usage/org_dashboard.mdx +++ b/platform/hosting/monitoring-usage/org_dashboard.mdx @@ -61,7 +61,7 @@ Use the **Activity Dashboard** to view aggregate activity. * **Active user count**: unique active users during the selected period (defaults to 3 months). * **Weekly active users**: users active per week. * **Most active user**: top-10 users ranked by active days and last-active date. -4. To change the date range, click the date picker in the upper-right corner and choose a new value: 7 days, 30 days (the default), 90 days, 6 months, or 12 months. All plots update automatically. +4. To change the date range, click the date picker in the upper-right corner and select a new value: 7 days, 30 days (the default), 90 days, 6 months, or 12 months. All plots update automatically. diff --git a/platform/hosting/monitoring-usage/slack-alerts.mdx b/platform/hosting/monitoring-usage/slack-alerts.mdx index 6a76967548..19c1cefa5f 100644 --- a/platform/hosting/monitoring-usage/slack-alerts.mdx +++ b/platform/hosting/monitoring-usage/slack-alerts.mdx @@ -56,7 +56,7 @@ Follow the procedure below to create a Slack application. 2. Depending on the System page you are on follow one of the below options: - - If you are in the **System Console**: go to **Settings** then to **Notifications** + - If you are in the **System Console**: navigate to **Settings** then to **Notifications** System Console notifications diff --git a/platform/hosting/self-managed/operator.mdx b/platform/hosting/self-managed/operator.mdx index 096ac69457..bc8baa9093 100644 --- a/platform/hosting/self-managed/operator.mdx +++ b/platform/hosting/self-managed/operator.mdx @@ -95,7 +95,7 @@ If needed, configure a custom security context for other components like `app` o **The W&B Kubernetes Operator with Helm is the recommended installation method** for all W&B Self-Managed deployments, including cloud, on-premises, and air-gapped environments. -Choose your deployment method: +Select your deployment method: @@ -1051,7 +1051,7 @@ Refer to the module documentation for your cloud provider for the full list of a - [Google Cloud Module documentation](https://registry.terraform.io/modules/wandb/wandb/google/latest) - [Azure Module documentation](https://registry.terraform.io/modules/wandb/wandb/azurerm/latest) -## Access the W&B Management Console +## Access the W&B management console The W&B Kubernetes operator comes with a management console. It is located at `${HOST_URI}/console`, for example `https://wandb.company-name.com/console`. There are two ways to log in to the management console: @@ -1125,16 +1125,16 @@ The W&B Operator is the default and recommended installation method for W&B Serv - If you created the Kubernetes resources with manifests, continue [here](#migrate-to-operator-based-helm-chart). -### Migrate to Operator-based AWS Terraform Modules +### Migrate to Operator-based AWS Terraform modules For a detailed description of the migration process, continue [here](https://github.com/wandb/helm-charts/tree/main/charts/operator-wandb). -### Migrate to Operator-based Google Cloud Terraform Modules +### Migrate to Operator-based Google Cloud Terraform modules Reach out to [Customer Support](mailto:support@wandb.com) or your W&B team if you have any questions or need assistance. -### Migrate to Operator-based Azure Terraform Modules +### Migrate to Operator-based Azure Terraform modules Reach out to [Customer Support](mailto:support@wandb.com) or your W&B team if you have any questions or need assistance. @@ -1188,7 +1188,7 @@ Follow these steps to migrate to the Operator-based Helm chart: -## Configuration Reference for W&B Server +## Configuration reference for W&B Server This section describes the configuration options for W&B Server application. The application receives its configuration as custom resource definition named [WeightsAndBiases](#how-it-works). Some configuration options are exposed with the below configuration, some need to be set as environment variables. diff --git a/platform/launch/create-launch-job.mdx b/platform/launch/create-launch-job.mdx index 0fd6ed6d06..0fdc418fe8 100644 --- a/platform/launch/create-launch-job.mdx +++ b/platform/launch/create-launch-job.mdx @@ -151,7 +151,7 @@ See the [example above](#git-jobs) for a demonstration of how to use the `--buil The Dockerfile is a text file that contains instructions for building a Docker image. By default, Launch uses a default Dockerfile that installs the `requirements.txt` file. To use a custom Dockerfile, specify the path to the file with the `--dockerfile` argument of `wandb launch`. -The Dockerfile path is specified relative to the build context. For example, if the build context is `jobs/hello_world`, and the Dockerfile is located in the `jobs/hello_world` directory, the `--dockerfile` argument should be set to `Dockerfile.wandb`. See the [example above](#git-jobs) for a demonstration of how to use the `--dockerfile` argument with the official W&B Launch jobs repository. +Specify the Dockerfile path relative to the build context. For example, if the build context is `jobs/hello_world`, and the Dockerfile is located in the `jobs/hello_world` directory, set the `--dockerfile` argument to `Dockerfile.wandb`. See the [example above](#git-jobs) for a demonstration of how to use the `--dockerfile` argument with the official W&B Launch jobs repository. ### Requirements file diff --git a/platform/launch/job-inputs.mdx b/platform/launch/job-inputs.mdx index 93ad9d88e2..69f6a43088 100644 --- a/platform/launch/job-inputs.mdx +++ b/platform/launch/job-inputs.mdx @@ -74,7 +74,7 @@ If the code above is packaged and run as a job, the input types of the job will } ``` -When launching the job from the W&B CLI or UI, the user will be able to override only the four `trainer` parameters. +When you launch the job from the W&B CLI or UI, you can override only the four `trainer` parameters. ### Access run config inputs diff --git a/platform/launch/launch-terminology.mdx b/platform/launch/launch-terminology.mdx index 198e4cab01..42e09d3bdb 100644 --- a/platform/launch/launch-terminology.mdx +++ b/platform/launch/launch-terminology.mdx @@ -16,15 +16,15 @@ There are three main kinds of job definitions: | Job types | Definition | How to run this job type | | ---------- | --------- | -------------- | -|Artifact-based (or code-based) jobs| Code and other assets are saved as a W&B artifact.| To run artifact-based jobs, Launch agent must be configured with a builder. | -|Git-based jobs| Code and other assets are cloned from a certain commit, branch, or tag in a git repository. | To run git-based jobs, Launch agent must be configured with a builder and git repository credentials. | +|Artifact-based (or code-based) jobs| Code and other assets are saved as a W&B artifact.| To run artifact-based jobs, configure the Launch agent with a builder. | +|Git-based jobs| Code and other assets are cloned from a certain commit, branch, or tag in a git repository. | To run git-based jobs, configure the Launch agent with a builder and git repository credentials. | |Image-based jobs|Code and other assets are baked into a Docker image. | To run image-based jobs, Launch agent might need to be configured with image repository credentials. | While Launch jobs can perform activities not related to model training--for example, deploy a model to a Triton inference server--all jobs must call `wandb.init` to complete successfully. This creates a run for tracking purposes in a W&B workspace. -Find jobs you created in the W&B App under the `Jobs` tab of your project workspace. From there, jobs can be configured and sent to a [launch queue](#launch-queue) to be executed on a variety of [target resources](#target-resources). +Find jobs you created in the W&B App under the `Jobs` tab of your project workspace. From there, you can configure and send jobs to a [launch queue](#launch-queue) for execution on a variety of [target resources](#target-resources). ### Launch queue Launch *queues* are ordered lists of jobs to execute on a specific target resource. Launch queues are first-in, first-out. (FIFO). There is no practical limit to the number of queues you can have, but a good guideline is one queue per target resource. Jobs can be enqueued with the W&B App UI, W&B CLI or Python SDK. You can then configure one or more Launch agents to pull items from the queue and execute them on the queue's target resource. @@ -44,7 +44,7 @@ Each target resource accepts a different set of configuration parameters called ### Launch agent Launch agents are lightweight, persistent programs that periodically check Launch queues for jobs to execute. When a launch agent receives a job, it first builds or pulls the image from the job definition then runs it on the target resource. -One agent may poll multiple queues, however the agent must be configured properly to support all of the backing target resources for each queue it is polling. +One agent may poll multiple queues, however you must configure the agent properly to support all of the backing target resources for each queue it polls. ### Launch agent environment The agent environment is the environment where a launch agent is running, polling for jobs. diff --git a/platform/launch/set-up-launch.mdx b/platform/launch/set-up-launch.mdx index ea4e178005..e570a7c2a2 100644 --- a/platform/launch/set-up-launch.mdx +++ b/platform/launch/set-up-launch.mdx @@ -9,7 +9,7 @@ This page describes the high-level steps required to set up W&B Launch: ## Set up a queue -Launch queues must be configured to point to a specific target resource along with any additional configuration specific to that resource. For example, a launch queue that points to a Kubernetes cluster might include environment variables or set a custom namespace its launch queue configuration. When you create a queue, you will specify both the target resource you want to use and the configuration for that resource to use. +Configure launch queues to point to a specific target resource along with any additional configuration specific to that resource. For example, a launch queue that points to a Kubernetes cluster might include environment variables or set a custom namespace its launch queue configuration. When you create a queue, you will specify both the target resource you want to use and the configuration for that resource to use. When an agent receives a job from a queue, it also receives the queue configuration. When the agent submits the job to the target resource, it includes the queue configuration along with any overrides from the job itself. For example, you can use a job configuration to specify the Amazon SageMaker instance type for that job instance only. In this case, it is common to use [queue config templates](/platform/launch/setup-queue-advanced/#configure-queue-template) as the end user interface. @@ -31,7 +31,7 @@ When an agent receives a job from a queue, it also receives the queue configurat Launch agents are long running processes that poll one or more launch queues for jobs. Launch agents dequeue jobs in first in, first out (FIFO) order or in priority order depending on the queues they pull from. When an agent dequeues a job from a queue, it optionally builds an image for that job. The agent then submits the job to the target resource along with configuration options specified in the queue configuration. -Agents are highly flexible and can be configured to support a wide variety of use cases. The required configuration for your agent will depend on your specific use case. See the dedicated page for [Docker](/platform/launch/setup-launch-docker/), [Amazon SageMaker](/platform/launch/setup-launch-sagemaker/), [Kubernetes](/platform/launch/setup-launch-kubernetes/), or [Vertex AI](/platform/launch/setup-vertex/). +Agents are highly flexible. You can configure them to support a wide variety of use cases. The required configuration for your agent will depend on your specific use case. See the dedicated page for [Docker](/platform/launch/setup-launch-docker/), [Amazon SageMaker](/platform/launch/setup-launch-sagemaker/), [Kubernetes](/platform/launch/setup-launch-kubernetes/), or [Vertex AI](/platform/launch/setup-vertex/). @@ -69,7 +69,7 @@ queues: ``` ### Configure a container builder -The launch agent can be configured to build images. You must configure the agent to use a container builder if you intend to use launch jobs created from git repositories or code artifacts. See the [Create a launch job](/platform/launch/create-launch-job/) for more information on how to create a launch job. +You can configure the launch agent to build images. You must configure the agent to use a container builder if you intend to use launch jobs created from git repositories or code artifacts. See the [Create a launch job](/platform/launch/create-launch-job/) for more information on how to create a launch job. W&B Launch supports three builder options: diff --git a/platform/launch/setup-launch-docker.mdx b/platform/launch/setup-launch-docker.mdx index cbea6bd40f..ceacd9ecad 100644 --- a/platform/launch/setup-launch-docker.mdx +++ b/platform/launch/setup-launch-docker.mdx @@ -118,7 +118,7 @@ queues: ## Docker image builders -The launch agent on your machine can be configured to build Docker images. By default, these images are stored on your machine’s local image repository. To enable your launch agent to build Docker images, set the `builder` key in the launch agent config to `docker`: +You can configure the launch agent on your machine to build Docker images. By default, these images are stored on your machine’s local image repository. To enable your launch agent to build Docker images, set the `builder` key in the launch agent config to `docker`: ```yaml title="launch-config.yaml" builder: diff --git a/platform/launch/setup-launch-sagemaker.mdx b/platform/launch/setup-launch-sagemaker.mdx index 0a5ddba35f..b2be3582e5 100644 --- a/platform/launch/setup-launch-sagemaker.mdx +++ b/platform/launch/setup-launch-sagemaker.mdx @@ -314,4 +314,4 @@ wandb job create image --p ... {/* ## Launch jobs from W&B -If you go to the W&B GUI, your SageMaker Launch queue will now be active. You can push jobs to it from the UI or CLI. */} \ No newline at end of file +If you navigate to the W&B GUI, your SageMaker Launch queue will now be active. You can push jobs to it from the UI or CLI. */} \ No newline at end of file diff --git a/platform/launch/setup-queue-advanced.mdx b/platform/launch/setup-queue-advanced.mdx index 28c456332a..c4da809806 100644 --- a/platform/launch/setup-queue-advanced.mdx +++ b/platform/launch/setup-queue-advanced.mdx @@ -93,7 +93,7 @@ This accelerator base image must satisfy the following requirements: Ensure TensorFlow properly utilizes your GPU. To accomplish this, specify a Docker image and its image tag for the `builder.accelerator.base_image` key in the queue resource configuration. -For example, the `tensorflow/tensorflow:latest-gpu` base image ensures TensorFlow properly uses your GPU. This can be configured using the resource configuration in the queue. +For example, the `tensorflow/tensorflow:latest-gpu` base image ensures TensorFlow properly uses your GPU. Configure this in the queue's resource configuration. The following JSON snippet demonstrates how to specify the TensorFlow base image in your queue config: diff --git a/platform/launch/sweeps-on-launch.mdx b/platform/launch/sweeps-on-launch.mdx index 2a7f8da547..9359aa84c3 100644 --- a/platform/launch/sweeps-on-launch.mdx +++ b/platform/launch/sweeps-on-launch.mdx @@ -207,7 +207,7 @@ Create a launch sweep using Optuna's scheduling logic with a job. ``` - For the exact implementation of the Optuna sweep scheduler job, see [wandb/launch-jobs](https://github.com/wandb/launch-jobs/blob/main/jobs/sweep_schedulers/optuna_scheduler/optuna_scheduler.py). For more examples of what is possible with the Optuna scheduler, check out [wandb/examples](https://github.com/wandb/examples/tree/master/examples/launch/launch-sweeps/optuna-scheduler). + For the exact implementation of the Optuna sweep scheduler job, see [wandb/launch-jobs](https://github.com/wandb/launch-jobs/blob/main/jobs/sweep_schedulers/optuna_scheduler/optuna_scheduler.py). For more examples of what is possible with the Optuna scheduler, see [wandb/examples](https://github.com/wandb/examples/tree/master/examples/launch/launch-sweeps/optuna-scheduler). diff --git a/platform/launch/walkthrough.mdx b/platform/launch/walkthrough.mdx index 18a2101ca1..8f6ddcd65d 100644 --- a/platform/launch/walkthrough.mdx +++ b/platform/launch/walkthrough.mdx @@ -31,7 +31,7 @@ Depending on your use case, explore the following resources to get started with * If this is your first time using W&B Launch, we recommend you go through the [Launch walkthrough](#walkthrough) guide. * Learn how to set up [W&B Launch](/platform/launch/set-up-launch/). * Create a [launch job](/platform/launch/launch-terminology/#launch-job). -* Check out the W&B Launch [public jobs GitHub repository](https://github.com/wandb/launch-jobs) for templates of common tasks like [deploying to Triton](https://github.com/wandb/launch-jobs/tree/main/jobs/deploy_to_nvidia_triton), [evaluating an LLM](https://github.com/wandb/launch-jobs/tree/main/jobs/openai_evals), or more. +* See the W&B Launch [public jobs GitHub repository](https://github.com/wandb/launch-jobs) for templates of common tasks like [deploying to Triton](https://github.com/wandb/launch-jobs/tree/main/jobs/deploy_to_nvidia_triton), [evaluating an LLM](https://github.com/wandb/launch-jobs/tree/main/jobs/openai_evals), or more. * View launch jobs created from this repository in this public [`wandb/jobs` project](https://wandb.ai/wandb/jobs/jobs) W&B project. ## Walkthrough diff --git a/platform/secrets.mdx b/platform/secrets.mdx index bad5bed432..6b8e0c63bd 100644 --- a/platform/secrets.mdx +++ b/platform/secrets.mdx @@ -21,7 +21,7 @@ Secrets are stored and managed in each team's Secret Manager, in the **Team secr To add a secret: 1. If the receiving service requires it to authenticate incoming webhooks, generate the required token or API key. If necessary, save the sensitive string securely, such as in a password manager. -1. Log in to W&B and go to the team's **Settings** page. +1. Log in to W&B and navigate to the team's **Settings** page. 1. In the **Team Secrets** section, click **New secret**. 1. Using letters, numbers, and underscores (`_`), provide a name for the secret. 1. Paste the sensitive string into the **Secret** field. diff --git a/support/models/articles/how-do-we-update-our-payment-method.mdx b/support/models/articles/how-do-we-update-our-payment-method.mdx index d56d3e7f0d..2ab3296613 100644 --- a/support/models/articles/how-do-we-update-our-payment-method.mdx +++ b/support/models/articles/how-do-we-update-our-payment-method.mdx @@ -5,7 +5,7 @@ keywords: ["Billing"] To update your payment method, follow these steps: -1. **Go to your profile page**: First, navigate to your user profile page. +1. **Navigate to your profile page**: First, navigate to your user profile page. 2. **Select your Organization**: Choose the relevant organization from the Account selector. 3. **Access Billing settings**: Under **Account**, select **Billing**. 4. **Add a new payment method**: diff --git a/support/models/articles/is-there-a-dark-mode.mdx b/support/models/articles/is-there-a-dark-mode.mdx index 7196860f06..b4cde938e9 100644 --- a/support/models/articles/is-there-a-dark-mode.mdx +++ b/support/models/articles/is-there-a-dark-mode.mdx @@ -5,7 +5,7 @@ keywords: ["Workspaces"] Dark mode is in beta and not optimized for accessibility. To enable dark mode: -1. Go to your [W&B account settings](https://wandb.ai/settings). +1. Navigate to your [W&B account settings](https://wandb.ai/settings). 2. Scroll to the **Public preview features** section. 3. In **UI Display**, select **Dark mode** from the dropdown. diff --git a/support/models/tags/billing.mdx b/support/models/tags/billing.mdx index 6b6fdb766d..d7f83b2d66 100644 --- a/support/models/tags/billing.mdx +++ b/support/models/tags/billing.mdx @@ -12,7 +12,7 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" To downgrade a subscription plan, contact the support team at support@wandb.com with your current plan details and the d ... - To update your payment method, follow these steps: 1. Go to your profile page: First, navigate to your user profile page ... + To update your payment method, follow these steps: 1. Navigate to your profile page: First, navigate to your user profile page ... The Teams plan does not offer a monthly subscription option. This subscription is billed annually. diff --git a/support/models/tags/workspaces.mdx b/support/models/tags/workspaces.mdx index be98527cfe..df1167d1b7 100644 --- a/support/models/tags/workspaces.mdx +++ b/support/models/tags/workspaces.mdx @@ -15,7 +15,7 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" To resolve this error, add ?workspace=clear to the end of the URL and press Enter. This action directs you to a cleared ... - Dark mode is in beta and not optimized for accessibility. To enable dark mode: 1. Go to your W&B account settings. 2. Sc ... + Dark mode is in beta and not optimized for accessibility. To enable dark mode: 1. Navigate to your W&B account settings. 2. Sc ... Workspaces automatically load updated data. Auto-refresh does not apply to reports. Reload the page to refresh report da ... diff --git a/weave/cookbooks/Intro_to_Weave_Hello_Trace.mdx b/weave/cookbooks/Intro_to_Weave_Hello_Trace.mdx index 902a83e0c3..eb3583dd8d 100644 --- a/weave/cookbooks/Intro_to_Weave_Hello_Trace.mdx +++ b/weave/cookbooks/Intro_to_Weave_Hello_Trace.mdx @@ -75,6 +75,6 @@ extract_fruit(sentence) ``` ## 🚀 Looking for more examples? -- Check out the [Quickstart guide](/weave/quickstart). +- See the [Quickstart guide](/weave/quickstart). - Learn more about [advanced tracing topics](/weave/tutorial-tracing_2). - Learn more about [tracing in Weave](/weave/guides/tracking/tracing) diff --git a/weave/cookbooks/audio_with_weave.mdx b/weave/cookbooks/audio_with_weave.mdx index 15f6784203..ffac8b5acc 100644 --- a/weave/cookbooks/audio_with_weave.mdx +++ b/weave/cookbooks/audio_with_weave.mdx @@ -65,7 +65,7 @@ import weave ## Audio streaming and storage example -Now we will setup a call to OpenAI's completions endpoint with audio modality enabled. First create the OpenAI client and initiate a Weave project. +Now we will set up a call to OpenAI's completions endpoint with audio modality enabled. First create the OpenAI client and initiate a Weave project. ```python lines client = OpenAI(api_key=os.environ.get("OPENAI_API_KEY")) @@ -814,7 +814,7 @@ class StreamingWavWriter: return self.buffer ``` -## Realtime Audio Model +## Realtime audio model The realtime (RT) audio model uses a websocket to send events to OpenAI's Realtime audio API. This works as follows: diff --git a/weave/cookbooks/codegen.mdx b/weave/cookbooks/codegen.mdx index 4fe7467664..2138921980 100644 --- a/weave/cookbooks/codegen.mdx +++ b/weave/cookbooks/codegen.mdx @@ -392,4 +392,4 @@ In this example, we've demonstrated how to implement a code generation pipeline Weave's seamless integration allows us to track inputs, outputs, and intermediate steps throughout the code generation process, making it easier to debug, optimize, and evaluate our LLM application. -For more information on Weave and its capabilities, check out the [Weave documentation](/weave). You can extend this example to handle larger datasets, implement more sophisticated evaluation metrics, or integrate with other LLM workflows. +For more information on Weave and its capabilities, see the [Weave documentation](/weave). You can extend this example to handle larger datasets, implement more sophisticated evaluation metrics, or integrate with other LLM workflows. diff --git a/weave/cookbooks/dspy_prompt_optimization.mdx b/weave/cookbooks/dspy_prompt_optimization.mdx index 74bccb1bf3..d338842869 100644 --- a/weave/cookbooks/dspy_prompt_optimization.mdx +++ b/weave/cookbooks/dspy_prompt_optimization.mdx @@ -39,7 +39,7 @@ os.environ["OPENAI_API_KEY"] = api_key ## Enable Tracking using Weave -Weave is currently integrated with DSPy, and including [`weave.init`](/weave/reference/python-sdk/trace/weave_client#method-init) at the start of our code lets us automatically trace our DSPy functions which can be explored in the Weave UI. Check out the [Weave integration docs for DSPy](/weave/guides/integrations/dspy) to learn more. +Weave is currently integrated with DSPy, and including [`weave.init`](/weave/reference/python-sdk/trace/weave_client#method-init) at the start of our code lets us automatically trace our DSPy functions which can be explored in the Weave UI. See the [Weave integration docs for DSPy](/weave/guides/integrations/dspy) to learn more. ```python lines import weave diff --git a/weave/cookbooks/import_from_csv.mdx b/weave/cookbooks/import_from_csv.mdx index 91b84b9452..547d17039a 100644 --- a/weave/cookbooks/import_from_csv.mdx +++ b/weave/cookbooks/import_from_csv.mdx @@ -28,7 +28,7 @@ conversation_id,turn_index,start_time,user_input,ground_truth,answer_text ``` -To understand the decisions for import in this cookbook, one should know that Weave traces have parent-child relationships that are 1:Many and continuous. Meaning a single parent may have multiple children, but that parent may itself be a children of another parent. +To understand the decisions for import in this cookbook, you should know that Weave traces have parent-child relationships that are 1:Many and continuous. Meaning a single parent may have multiple children, but that parent may itself be a children of another parent. We therefore use `conversation_id` as the parent identifier, and the `turn_index` as the child identifier to provide us complete conversation logging. @@ -278,4 +278,4 @@ weave.publish(dset) ![image.png](/images/screenshots/csv-4.png) -To learn more about evaluations, check out our [Quickstart](/weave/tutorial-rag) on using your newly created dataset to evaluate your RAG application! +To learn more about evaluations, see our [Quickstart](/weave/tutorial-rag) on using your newly created dataset to evaluate your RAG application! diff --git a/weave/cookbooks/notdiamond_custom_routing.mdx b/weave/cookbooks/notdiamond_custom_routing.mdx index b756d83d80..3b3cae6519 100644 --- a/weave/cookbooks/notdiamond_custom_routing.mdx +++ b/weave/cookbooks/notdiamond_custom_routing.mdx @@ -15,8 +15,8 @@ This notebook demonstrates how to use Weave with [Not Diamond's custom routing]( ## Routing prompts -When building complex LLM workflows users may need to prompt different models according to accuracy, cost, or call latency. -Users can use [Not Diamond](https://www.notdiamond.ai/) to route prompts in these workflows to the right model for their needs, helping maximize accuracy while saving on model costs. +When building complex LLM workflows, you may need to prompt different models according to accuracy, cost, or call latency. +You can use [Not Diamond](https://www.notdiamond.ai/) to route prompts in these workflows to the right model for your needs, helping maximize accuracy while saving on model costs. For any given distribution of data, rarely will one single model outperform every other model on every single query. By combining together multiple models into a "meta-model" that learns when to call each LLM, you can beat every individual model's performance and even drive down costs and latency in the process. diff --git a/weave/cookbooks/online_monitoring.mdx b/weave/cookbooks/online_monitoring.mdx index 36605a970a..e29c9e6607 100644 --- a/weave/cookbooks/online_monitoring.mdx +++ b/weave/cookbooks/online_monitoring.mdx @@ -11,7 +11,7 @@ This is an interactive notebook. You can run it locally or use the links below: # Integrating with Weave: Production Dashboard -The GenAI tooling landscape is rapidly evolving - new frameworks, tools, and applications are emerging all the time. Weave aims to be a one-stop-shop for all your GenAI monitoring and evaluation needs. This also means that sometimes it is necessary to integrate with existing platforms or extend Weave to fit the specific needs of your project or organization. +The GenAI tooling landscape is rapidly evolving - new frameworks, tools, and applications are emerging all the time. Weave aims to be a one-stop-shop for all your GenAI monitoring and evaluation needs. This also means that sometimes you need to integrate with existing platforms or extend Weave to fit the specific needs of your project or organization. In this cookbook, we'll demonstrate how to leverage Weave's powerful APIs and functions to create a custom dashboard for production monitoring as an extension to the Traces view in Weave. We'll focus on: @@ -187,7 +187,7 @@ df_costs ## 2.4 Gathering inputs and generating visualizations -Next, we can generate the visualizations using plotly. This is the most basic dashboard, but you can customize it as you like! For a more complex example, check out a Streamlit example [here](https://github.com/NiWaRe/knowledge-worker-weave/blob/master/prod_dashboard.py). +Next, we can generate the visualizations using plotly. This is the most basic dashboard, but you can customize it as you like! For a more complex example, see a Streamlit example [here](https://github.com/NiWaRe/knowledge-worker-weave/blob/master/prod_dashboard.py). ```python lines import plotly.express as px @@ -237,5 +237,5 @@ In this cookbook, we demonstrated how to create a custom production monitoring d - Easy download of the data in CSV, TSV, JSONL, JSON formats - see [here](/weave/reference/service-api) for more details. - Easy export using programmatic access to the data - see "Use Python" section in the export panel as described in this cookbook. See [here](/weave/guides/tracking/tracing#querying-and-exporting-calls) for more details. -This custom dashboard extends Weave's native Traces view, allowing for tailored monitoring of LLM applications in production. If you're interested in viewing a more complex dashboard, check out a Streamlit example where you can add your own Weave project URL [in this repo](https://github.com/NiWaRe/agent-dev-collection). +This custom dashboard extends Weave's native Traces view, allowing for tailored monitoring of LLM applications in production. If you're interested in viewing a more complex dashboard, see a Streamlit example where you can add your own Weave project URL [in this repo](https://github.com/NiWaRe/agent-dev-collection). diff --git a/weave/guides/core-types/datasets.mdx b/weave/guides/core-types/datasets.mdx index a62bb185b9..746b8bce8e 100644 --- a/weave/guides/core-types/datasets.mdx +++ b/weave/guides/core-types/datasets.mdx @@ -207,7 +207,7 @@ You can create, edit, and delete `Dataset`s in the UI. Creating datasets in the 10. Click **Create dataset**. Your new dataset is created. -11. In the confirmation popup, click **View the dataset** to view the new `Dataset`. Alternatively, go to the **Datasets** tab. +11. In the confirmation popup, click **View the dataset** to view the new `Dataset`. Alternatively, navigate to the **Datasets** tab. ### Edit a `Dataset` diff --git a/weave/guides/core-types/env-vars.mdx b/weave/guides/core-types/env-vars.mdx index 7d8c5ad913..16e9cd891f 100644 --- a/weave/guides/core-types/env-vars.mdx +++ b/weave/guides/core-types/env-vars.mdx @@ -23,7 +23,7 @@ os.environ["WEAVE_PRINT_CALL_LINK"] = "false" | Variable | Type | Default | Description | |----------|------|---------|-------------| -| `WANDB_API_KEY` | `string` | `None` | If set, automatically log into W&B Weave without being prompted for your API key. To generate an API key, log in to your W&B account and go to [User Settings](https://wandb.ai/settings). | +| `WANDB_API_KEY` | `string` | `None` | If set, automatically log into W&B Weave without being prompted for your API key. To generate an API key, log in to your W&B account and navigate to [User Settings](https://wandb.ai/settings). | | `WEAVE_DISABLED` | `bool` | `false` | When set to `true`, disables all Weave tracing. Weave ops will behave like regular functions. | | `WEAVE_PRINT_CALL_LINK` | `bool` | `true` | Controls whether to print a link to the Weave UI when calling a Weave op. You can also set this directly in your code by configuring the `settings` argument for `weave.init()` like this: `weave.init("your-project-name", settings={"print_call_link": False})` | | `WEAVE_LOG_LEVEL` | `str` | `INFO` | Controls the log level of the weave logger. diff --git a/weave/guides/core-types/evaluations.mdx b/weave/guides/core-types/evaluations.mdx index 7a6eb6e56a..ef1dd4556c 100644 --- a/weave/guides/core-types/evaluations.mdx +++ b/weave/guides/core-types/evaluations.mdx @@ -531,4 +531,4 @@ You can save your Evals table configurations, filters, and sorts as _saved views ### Imperative evaluations (`EvaluationLogger`) -If you prefer a more flexible evaluation framework, check out Weave's [`EvaluationLogger`](../evaluation/evaluation_logger). The `EvaluationLogger` is available in both Python and TypeScript and offers more flexibility for complex workflows, while the standard evaluation framework provides more structure and guidance. \ No newline at end of file +If you prefer a more flexible evaluation framework, see Weave's [`EvaluationLogger`](../evaluation/evaluation_logger). The `EvaluationLogger` is available in both Python and TypeScript and offers more flexibility for complex workflows, while the standard evaluation framework provides more structure and guidance. \ No newline at end of file diff --git a/weave/guides/core-types/leaderboards.mdx b/weave/guides/core-types/leaderboards.mdx index ec8eca36a5..fbcc91c23f 100644 --- a/weave/guides/core-types/leaderboards.mdx +++ b/weave/guides/core-types/leaderboards.mdx @@ -11,10 +11,10 @@ Leaderboards are ideal for: - Coordinating shared evaluation workflows -Leaderboard creation is only available for the Weave UI and Weave Python SDK. TypeScript users can create and manage leaderboards using the [Weave UI](#using-the-ui). +Leaderboard creation is only available for the Weave UI and Weave Python SDK. If you use TypeScript, you can create and manage leaderboards using the [Weave UI](#using-the-ui). -## Create a Leaderboard +## Create a leaderboard You can create a leaderboard via the [Weave UI](#ui) or [programmatically](#python). @@ -34,8 +34,8 @@ To create and customize leaderboards directly in the Weave UI: Each column in a leaderboard represents a metric from a specific evaluation. To configure a column, you specify: - **Evaluation**: Select an evaluation run from the dropdown (must be previously created). -- **Scorer**: Choose a scoring function (e.g., `jaccard_similarity`, `simple_accuracy`) used in that evaluation. -- **Metric**: Choose a summary metric to display (e.g., `mean`, `true_fraction`, etc.). +- **Scorer**: Select a scoring function (e.g., `jaccard_similarity`, `simple_accuracy`) used in that evaluation. +- **Metric**: Select a summary metric to display (e.g., `mean`, `true_fraction`, etc.). To add more columns, click **Add Column**. @@ -216,7 +216,7 @@ print(results) After the script finishes running, view the leaderboard: -1. In the **Weave UI**, go to the **Leaders** tab. If it's not visible, click **More**, then select **Leaders**. +1. In the **Weave UI**, navigate to the **Leaders** tab. If it's not visible, click **More**, then select **Leaders**. 2. Click on the name of your leaderboard—e.g. `Summarization Model Comparison`. In the leaderboard table, each row represents a given model (`model_humanlike`, `model_vanilla`, `model_messy`). The `mean` column shows the average Jaccard similarity between the model's output and the reference summaries. diff --git a/weave/guides/core-types/prompts-version.mdx b/weave/guides/core-types/prompts-version.mdx index 800d69d5db..baefe40586 100644 --- a/weave/guides/core-types/prompts-version.mdx +++ b/weave/guides/core-types/prompts-version.mdx @@ -104,7 +104,7 @@ To set aliases and tags for your prompts in the UI: 1. In the Weave project sidebar, click **Assets**. This opens the Assets page. 1. In the Assets page, click **Prompts**. Note that you can view assigned `Aliases` and `Tags` in the table. 1. In the Prompts table, click the link of the prompt you want to change. -1. In the prompt detail panel for your selected prompt, the title bar displays the name of the prompt and a specific version. Choose the version of the prompt you want to update. +1. In the prompt detail panel for your selected prompt, the title bar displays the name of the prompt and a specific version. Select the version of the prompt you want to update. 1. In the panel toolbar, use the controls to add and remove assigned aliases and tags to this specific version. ![A selected prompt version in the prompt detail panel on the Prompts page, showing controls for Aliases and Tags.](/weave/guides/core-types/imgs/prompt-alias-tags.png) diff --git a/weave/guides/evaluation/evaluation_logger.mdx b/weave/guides/evaluation/evaluation_logger.mdx index 905a9eac9f..37bb0ea353 100644 --- a/weave/guides/evaluation/evaluation_logger.mdx +++ b/weave/guides/evaluation/evaluation_logger.mdx @@ -573,8 +573,8 @@ With `EvaluationLogger`, you can log and compare multiple evaluations. 2. In the Weave UI, navigate to the `Evals` tab. 3. Select the evals that you want to compare. 4. Click the **Compare** button. In the Compare view, you can: - - Choose which Evals to add or remove - - Choose which metrics to show or hide + - Select which Evals to add or remove + - Select which metrics to show or hide - Page through specific examples to see how different models performed for the same input on a given dataset For more information on comparisons, see [Comparisons](../tools/comparison) diff --git a/weave/guides/evaluation/monitors.mdx b/weave/guides/evaluation/monitors.mdx index 4746129500..7d1ddd93f4 100644 --- a/weave/guides/evaluation/monitors.mdx +++ b/weave/guides/evaluation/monitors.mdx @@ -22,7 +22,7 @@ To create a monitor in Weave: - **Description** (Optional): Explain what the monitor does. - **Active monitor** toggle: Turn the monitor on or off. - **Calls to monitor**: - - **Operations**: Choose one or more `@weave.op`s to monitor. You must log at least one trace that uses the op before it appears in the list of available ops. + - **Operations**: Select one or more `@weave.op`s to monitor. You must log at least one trace that uses the op before it appears in the list of available ops. - **Filter** (Optional): Narrow down which calls are eligible (for example, by `max_tokens` or `top_p`). - **Sampling rate**: The percentage of calls to score (0% to 100%). diff --git a/weave/guides/evaluation/scorers.mdx b/weave/guides/evaluation/scorers.mdx index ac979356af..dd8939a83a 100644 --- a/weave/guides/evaluation/scorers.mdx +++ b/weave/guides/evaluation/scorers.mdx @@ -142,7 +142,7 @@ While this guide shows you how to create custom scorers, Weave comes with a vari -## How Scorers Work +## How scorers work ### Scorer keyword arguments diff --git a/weave/guides/integrations/crewai.mdx b/weave/guides/integrations/crewai.mdx index 2706664039..3acc4911ba 100644 --- a/weave/guides/integrations/crewai.mdx +++ b/weave/guides/integrations/crewai.mdx @@ -14,7 +14,7 @@ When working with AI agents, debugging and monitoring their interactions is cruc The integration supports both Crews and Flows. -## Getting Started with Crew +## Get started with Crew You need to install CrewAI ([more details](https://docs.crewai.com/installation)) and weave to run this example: @@ -127,7 +127,7 @@ Running this Crew with an agent with access to internet produces better and more The integration automatically patches all the tools available in the [`crewAI-tools`](https://github.com/crewAIInc/crewAI-tools) repository. -## Getting Started with Flow +## Get started with Flow ```python lines {3} import weave diff --git a/weave/guides/integrations/google_adk.mdx b/weave/guides/integrations/google_adk.mdx index f65118c068..d0cf09dd36 100644 --- a/weave/guides/integrations/google_adk.mdx +++ b/weave/guides/integrations/google_adk.mdx @@ -32,7 +32,7 @@ For more information on OTEL tracing in Weave, see [Send OTEL Traces to Weave](. To send traces from ADK to Weave, configure OTEL with a `TracerProvider` and an `OTLPSpanExporter`. Set the exporter to the [correct endpoint and HTTP headers for authentication and project identification](#required-configuration). -It is recommended that you store sensitive environment variables like your API key and project info in an environment file (e.g., `.env`), and load them using `os.environ`. This keeps your credentials secure and out of your codebase. +Store sensitive environment variables like your API key and project info in an environment file (for example, `.env`), and load them using `os.environ`. This keeps your credentials secure and out of your codebase. ### Required configuration diff --git a/weave/guides/integrations/llamaindex.mdx b/weave/guides/integrations/llamaindex.mdx index d65b216b8e..58bac1cfee 100644 --- a/weave/guides/integrations/llamaindex.mdx +++ b/weave/guides/integrations/llamaindex.mdx @@ -27,7 +27,7 @@ response = chat_engine.chat( print(response) ``` -In the example above, we are creating a simple LlamaIndex chat engine which under the hood is making an OpenAI call. Check out the trace below: +In the example above, we are creating a simple LlamaIndex chat engine which under the hood is making an OpenAI call. See the trace below: [![simple_llamaindex.png](/weave/guides/integrations/imgs/simple_llamaindex.png)](https://wandb.ai/wandbot/test-llamaindex-weave/weave/calls/b6b5d898-2df8-4e14-b553-66ce84661e74) diff --git a/weave/guides/integrations/local_models.mdx b/weave/guides/integrations/local_models.mdx index e853f29bfd..4c8d68d15d 100644 --- a/weave/guides/integrations/local_models.mdx +++ b/weave/guides/integrations/local_models.mdx @@ -25,7 +25,7 @@ client = openai.OpenAI( In the case of local models, the `api_key` can be any string but it should be overridden, as otherwise OpenAI will try to use it from environment variables and show you an error. -## OpenAI SDK supported Local Model runners +## OpenAI SDK supported local model runners Here's a list of apps that allows you to download and run models from Hugging Face on your computer, that support OpenAI SDK compatibility. diff --git a/weave/guides/integrations/openai.mdx b/weave/guides/integrations/openai.mdx index ac34712ba4..617309a6de 100644 --- a/weave/guides/integrations/openai.mdx +++ b/weave/guides/integrations/openai.mdx @@ -375,9 +375,9 @@ result = generate_response("Hello, how are you?") Now that you've set up tracing for OpenAI, you can: -1. **View traces in the Weave UI**: Go to your Weave project to see traces of your OpenAI calls +1. **View traces in the Weave UI**: Navigate to your Weave project to see traces of your OpenAI calls 2. **Create evaluations**: Use your traces to build evaluation datasets 3. **Monitor performance**: Track latency, costs, and other metrics 4. **Debug issues**: Use traces to understand what's happening in your LLM application -For more information on these topics, check out our [evaluation guide](../evaluation/scorers) and [monitoring guide](../tracking). +For more information on these topics, see our [evaluation guide](../evaluation/scorers) and [monitoring guide](../tracking). diff --git a/weave/guides/integrations/pydantic_ai.mdx b/weave/guides/integrations/pydantic_ai.mdx index dd5a6b3241..2b3b81f58b 100644 --- a/weave/guides/integrations/pydantic_ai.mdx +++ b/weave/guides/integrations/pydantic_ai.mdx @@ -25,7 +25,7 @@ Then, [configure OTEL tracing in Weave](#configure-otel-tracing-in-weave). To send traces from PydanticAI to Weave, configure OTEL with a `TracerProvider` and an `OTLPSpanExporter`. Set the exporter to the [correct endpoint and HTTP headers for authentication and project identification](#required-configuration). -It is recommended that you store sensitive environment variables like your API key and project info in an environment file (e.g., `.env`), and load them using `os.environ`. This keeps your credentials secure and out of your codebase. +Store sensitive environment variables like your API key and project info in an environment file (for example, `.env`), and load them using `os.environ`. This keeps your credentials secure and out of your codebase. ### Required configuration diff --git a/weave/guides/integrations/verdict.mdx b/weave/guides/integrations/verdict.mdx index 59dae4fb08..4d44da6412 100644 --- a/weave/guides/integrations/verdict.mdx +++ b/weave/guides/integrations/verdict.mdx @@ -39,7 +39,7 @@ output = pipeline.run(data) print(output) ``` -## Tracking Call Metadata +## Tracking call metadata To track metadata from your Verdict pipeline calls, you can use the [`weave.attributes`](/weave/reference/python-sdk#function-attributes) context manager. This context manager allows you to set custom metadata for a specific block of code, such as a pipeline run or evaluation batch. diff --git a/weave/guides/platform/weave-projects.mdx b/weave/guides/platform/weave-projects.mdx index 65fb89348a..171a1c02d2 100644 --- a/weave/guides/platform/weave-projects.mdx +++ b/weave/guides/platform/weave-projects.mdx @@ -106,5 +106,5 @@ To delete a project from your W&B account: 1. Navigate to [wandb.ai](https://wandb.ai). 2. Select your project from the **Projects** sidebar. This opens the project's overview page, or **Traces** page if you have already logged traces to the project. 3. Select the **Project** () button in the sidenav to open the project's overview page if it is not already open. -4. Select the three-dots menu () and choose **Delete Project** from the list. This opens the **Delete project** modal dialog. +4. Select the three-dots menu () and select **Delete Project** from the list. This opens the **Delete project** modal dialog. 5. In the modal, enter the project name in the confirmation field and click **Delete**. The project is permanently deleted from your W&B account. \ No newline at end of file diff --git a/weave/guides/platform/weave-self-managed.mdx b/weave/guides/platform/weave-self-managed.mdx index 3f24335449..def80d4d3e 100644 --- a/weave/guides/platform/weave-self-managed.mdx +++ b/weave/guides/platform/weave-self-managed.mdx @@ -825,7 +825,7 @@ Navigate to your W&B instance URL in a web browser. In the W&B Console: -1. Go to **Top Right Menu** → **Organization Dashboard** +1. Navigate to **Top Right Menu** → **Organization Dashboard** 2. Verify that **Weave access** is enabled #### 7.3 Test Weave functionality @@ -855,7 +855,7 @@ After running this, check your W&B UI for traces at the traces page in your orga ## Troubleshooting -### ClickHouse Keeper Issues +### ClickHouse Keeper issues **Problem**: Keeper pods stuck in `Pending` state @@ -911,7 +911,7 @@ Common issues: - Port conflicts - Configuration errors in ch-keeper.yaml -### ClickHouse Server Issues +### ClickHouse server issues **Problem**: ClickHouse cannot connect to S3 @@ -950,7 +950,7 @@ kubectl logs -n clickhouse chi-wandb-weavecluster-0-0-0 | grep -i keeper If the connection fails, the Keeper hostnames in ch-server.yaml likely don't match your actual Keeper deployment. See "Understanding Keeper Naming" in Step 4 for the naming pattern. -### Weave Trace Issues +### Weave trace issues **Problem**: `weave-trace` pod fails to start diff --git a/weave/guides/tracking/annotation-queues.mdx b/weave/guides/tracking/annotation-queues.mdx index 08850d2279..3a92667083 100644 --- a/weave/guides/tracking/annotation-queues.mdx +++ b/weave/guides/tracking/annotation-queues.mdx @@ -69,7 +69,7 @@ To create an annotation queue: - **Queue name**: This is the queue name the annotator selects to complete their work. - **Guidelines** (Optional): Any additional instructions for the annotator. 5. Click **Next**. -6. Click **Manage fields** and choose what Annotation Fields to include in this review work. All existing Annotation Fields for the Project are available for selection. +6. Click **Manage fields** and select the Annotation Fields to include in this review work. All existing Annotation Fields for the Project are available for selection. 7. After you have selected all the Fields for the queue, click **Create Queue** to save the queue. All annotation queues for the project are listed in the Annotation Queues page. @@ -141,11 +141,11 @@ To view only traces with annotations: 2. In the Traces table toolbar, click **Filter**. 3. Add three values to a filter row: - For **Column**, type "Queue", then press **Enter**. - - For the second list, choose **Text: "is"**. - - For **Select a queue**, choose your annotation queue name. + - For the second list, select **Text: "is"**. + - For **Select a queue**, select your annotation queue name. 4. To also filter on 'completed' queue items only, click **+ Add Filter**: - - For **Column**, type "feedback". A dialog will populate with Annotations and includes your Annotation Field names. Choose a required Field from your queue. - - For the second list, choose **Other: "is not empty"**. + - For **Column**, type "feedback". A dialog will populate with Annotations and includes your Annotation Field names. Select a required Field from your queue. + - For the second list, select **Other: "is not empty"**. ![Traces table configuring a filter to select traces belonging to specific annotation queue.](./imgs/AnnotationTracesFilter.png) diff --git a/weave/guides/tracking/querying-calls.mdx b/weave/guides/tracking/querying-calls.mdx index cb5582500d..ab3244cc08 100644 --- a/weave/guides/tracking/querying-calls.mdx +++ b/weave/guides/tracking/querying-calls.mdx @@ -9,7 +9,7 @@ To export Calls: 1. In the Weave project sidebar, click **Traces**. 1. Select multiple Calls that you want to export by checking the row. 1. In the **Traces** table toolbar, click the export/download button. -1. In the **Export** modal, choose **Selected rows** or **All rows**. Click Export. +1. In the **Export** modal, select **Selected rows** or **All rows**. Click Export. ![Traces page showing selected Calls ready for export in the Export modal.](/weave/guides/tracking/imgs/trace_export_modal.png) diff --git a/weave/guides/tracking/redact-pii.mdx b/weave/guides/tracking/redact-pii.mdx index f8accd5c63..565c7dd7bd 100644 --- a/weave/guides/tracking/redact-pii.mdx +++ b/weave/guides/tracking/redact-pii.mdx @@ -75,7 +75,7 @@ The following entities are automatically redacted when PII redaction is enabled: ## Redacting sensitive keys with `REDACT_KEYS` -In addition to PII redaction, the Weave SDK also supports redaction of custom keys using `REDACT_KEYS`. This is useful when you want to protect additional sensitive data that might not fall under the PII category but needs to be kept private. Examples include: +In addition to PII redaction, the Weave SDK also supports redaction of custom keys using `REDACT_KEYS`. This is useful when you want to protect additional sensitive data that might not fall under the PII category but that you want to keep private. Examples include: - API keys - Authentication headers diff --git a/weave/tutorial-eval.mdx b/weave/tutorial-eval.mdx index 976a4db365..c234138d10 100644 --- a/weave/tutorial-eval.mdx +++ b/weave/tutorial-eval.mdx @@ -439,7 +439,7 @@ Weave automatically captures traces of each prediction and score. Click on the l ## Learn more about Weave evaluations * Learn more about how to [build and use scorers](/weave/guides/evaluation/scorers). -* Check out Weave's [built-in scoring functions](/weave/guides/evaluation/builtin_scorers). +* See Weave's [built-in scoring functions](/weave/guides/evaluation/builtin_scorers). * Learn about [Model-Based Evaluation](/weave/guides/evaluation/scorers#model-based-evaluation) for using LLMs as judges. ## Next Steps diff --git a/weave/tutorial-rag.mdx b/weave/tutorial-rag.mdx index 81e6e2fc45..9aa57bbdb5 100644 --- a/weave/tutorial-rag.mdx +++ b/weave/tutorial-rag.mdx @@ -767,4 +767,4 @@ This tutorial showed how to build observability into different steps of your app ## Next Steps -Check out the [RAG++ course](https://www.wandb.courses/courses/rag-in-production?utm_source=wandb_docs&utm_medium=code&utm_campaign=weave_docs) for a more advanced dive into practical RAG techniques for engineers, where you'll learn production-ready solutions from Weights & Biases, Cohere and Weaviate to optimize performance, cut costs, and enhance the accuracy and relevance of your applications. \ No newline at end of file +See the [RAG++ course](https://www.wandb.courses/courses/rag-in-production?utm_source=wandb_docs&utm_medium=code&utm_campaign=weave_docs) for a more advanced dive into practical RAG techniques for engineers, where you'll learn production-ready solutions from Weights & Biases, Cohere and Weaviate to optimize performance, cut costs, and enhance the accuracy and relevance of your applications. \ No newline at end of file From 19edec487c979bb251b4f2c3b102fcaae4fe180c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 9 Apr 2026 21:48:03 +0000 Subject: [PATCH 2/2] chore: regenerate support tag pages and docs.json navigation --- support/models/tags/billing.mdx | 2 +- support/models/tags/workspaces.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/support/models/tags/billing.mdx b/support/models/tags/billing.mdx index d7f83b2d66..d8f43cb0c6 100644 --- a/support/models/tags/billing.mdx +++ b/support/models/tags/billing.mdx @@ -12,7 +12,7 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" To downgrade a subscription plan, contact the support team at support@wandb.com with your current plan details and the d ... - To update your payment method, follow these steps: 1. Navigate to your profile page: First, navigate to your user profile page ... + To update your payment method, follow these steps: 1. Navigate to your profile page: First, navigate to your user profil ... The Teams plan does not offer a monthly subscription option. This subscription is billed annually. diff --git a/support/models/tags/workspaces.mdx b/support/models/tags/workspaces.mdx index df1167d1b7..8e6bbc954a 100644 --- a/support/models/tags/workspaces.mdx +++ b/support/models/tags/workspaces.mdx @@ -15,7 +15,7 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" To resolve this error, add ?workspace=clear to the end of the URL and press Enter. This action directs you to a cleared ... - Dark mode is in beta and not optimized for accessibility. To enable dark mode: 1. Navigate to your W&B account settings. 2. Sc ... + Dark mode is in beta and not optimized for accessibility. To enable dark mode: 1. Navigate to your W&B account settings. ... Workspaces automatically load updated data. Auto-refresh does not apply to reports. Reload the page to refresh report da ...