From 1b5471a0f2cb62b4b18255612c5077ff26d753f7 Mon Sep 17 00:00:00 2001 From: John Mulhausen Date: Fri, 5 Jun 2026 16:38:44 -0400 Subject: [PATCH] docs: refer to the web app as "W&B" instead of "W&B App" Sweep the docs to stop calling the web application "the W&B App" and use the umbrella term "W&B" instead. There is no "W&B App" product in the naming guidance (AGENTS.md), so the platform is just "W&B". Scope and rules: - 85 English files, 251 replacements. Excludes translations (ja/fr/ko) and models/integrations/ (handled separately in the integrations PR #2673 to avoid overlapping changes). - "W&B App UI" -> "W&B" (the UI is the app; "UI" was redundant). - Real following nouns kept, "App" dropped: "W&B App URL/workspace/ dashboard/navigation/tab/system" -> "W&B URL/workspace/...". - "the W&B App" (noun head) -> "W&B"; dangling articles before linked "[W&B App](...)" cleaned up. Notes for review: - A few labels now read "W&B" next to siblings like "W&B CLI" or "Environment variable". If you'd prefer "W&B UI" to keep the UI/CLI/SDK distinction in those tab groups, I can switch those. - One heading lost "App" (models/registry/link_version.mdx); no inbound links pointed at the old anchor. Co-Authored-By: Claude Opus 4.8 (1M context) --- models/app/console-logs.mdx | 22 ++++++++--------- models/app/features/cascade-settings.mdx | 2 +- .../features/panels/line-plot/sampling.mdx | 2 +- models/app/keyboard-shortcuts.mdx | 10 ++++---- models/artifacts/construct-an-artifact.mdx | 2 +- models/artifacts/delete-artifacts.mdx | 12 +++++----- ...explore-and-traverse-an-artifact-graph.mdx | 6 ++--- models/artifacts/track-external-files.mdx | 6 ++--- models/artifacts/ttl.mdx | 24 +++++++++---------- models/automations.mdx | 2 +- models/automations/api.mdx | 8 +++---- models/automations/create-automations.mdx | 2 +- .../create-automations/webhook.mdx | 8 +++---- .../project-automation-tutorial.mdx | 4 ++-- .../registry-automation-tutorial.mdx | 6 ++--- models/models_quickstart.mdx | 2 +- models/ref/cli/wandb-agent.mdx | 2 +- models/ref/cli/wandb-sweep.mdx | 2 +- models/ref/python/experiments/artifact.mdx | 8 +++---- models/ref/python/experiments/run.mdx | 2 +- .../ref/python/experiments/system-metrics.mdx | 6 ++--- models/ref/wandb_workspaces/workspaces.mdx | 2 +- models/registry.mdx | 2 +- models/registry/create_collection.mdx | 4 ++-- models/registry/delete_registry.mdx | 4 ++-- models/registry/download_use_artifact.mdx | 2 +- models/registry/link_version.mdx | 6 ++--- models/registry/organize-with-tags.mdx | 24 +++++++++---------- models/registry/search_registry.mdx | 2 +- models/reports.mdx | 2 +- models/reports/clone-and-export-reports.mdx | 4 ++-- models/reports/create-a-report.mdx | 10 ++++---- models/reports/edit-a-report.mdx | 16 ++++++------- models/runs.mdx | 6 ++--- models/runs/compare-runs.mdx | 2 +- models/runs/delete-runs.mdx | 8 +++---- models/runs/forking.mdx | 2 +- models/runs/grouping.mdx | 10 ++++---- models/runs/manage-runs.mdx | 2 +- models/runs/rewind.mdx | 2 +- models/runs/run-identifiers.mdx | 18 +++++++------- models/runs/run-states.mdx | 8 +++---- models/runs/stop-runs.mdx | 6 ++--- models/runs/tags.mdx | 4 ++-- models/runs/view-logged-runs.mdx | 16 ++++++------- models/sweeps/existing-project.mdx | 2 +- models/sweeps/sweep-config-keys.mdx | 4 ++-- models/sweeps/visualize-sweep-results.mdx | 4 ++-- models/sweeps/walkthrough.mdx | 2 +- models/tables/log_tables.mdx | 8 +++---- models/tables/tables-walkthrough.mdx | 2 +- models/tables/visualize-tables.mdx | 4 ++-- models/track/config.mdx | 6 ++--- models/track/create-an-experiment.mdx | 4 ++-- models/track/log/customize-logging-axes.mdx | 2 +- models/track/log/distributed-training.mdx | 14 +++++------ models/track/log/log-models.mdx | 2 +- models/track/log/log-summary.mdx | 4 ++-- models/track/project-page.mdx | 10 ++++---- .../secure-storage-connector.mdx | 8 +++---- platform/hosting/enterprise-licenses.mdx | 6 ++--- .../access-management/manage-organization.mdx | 2 +- platform/hosting/iam/identity_federation.mdx | 2 +- platform/hosting/iam/ldap.mdx | 10 ++++---- platform/hosting/iam/scim.mdx | 12 +++++----- platform/hosting/iam/sso.mdx | 6 ++--- platform/hosting/managing-bucket-storage.mdx | 6 ++--- .../monitoring-usage/org_dashboard.mdx | 4 ++-- .../disable-automatic-app-version-updates.mdx | 2 +- platform/hosting/server-upgrade-process.mdx | 4 ++-- platform/launch/add-job-to-queue.mdx | 6 ++--- ...ockerfile_let_wb_build_docker_image_me.mdx | 8 +++---- platform/launch/launch-terminology.mdx | 6 ++--- platform/launch/launch-view-jobs.mdx | 10 ++++---- platform/launch/setup-launch-kubernetes.mdx | 2 +- platform/launch/setup-launch-sagemaker.mdx | 2 +- platform/launch/setup-vertex.mdx | 2 +- platform/launch/sweeps-on-launch.mdx | 8 +++---- release-notes/server-releases-archived.mdx | 4 ++-- release-notes/server-releases.mdx | 12 +++++----- .../_includes/project-visibility-settings.mdx | 2 +- ...w-can-i-change-the-privacy-of-my-proje.mdx | 2 +- .../how-can-i-recover-deleted-runs.mdx | 4 ++-- .../articles/how-do-i-rerun-a-grid-search.mdx | 2 +- support/models/tags/runs.mdx | 2 +- 85 files changed, 251 insertions(+), 251 deletions(-) diff --git a/models/app/console-logs.mdx b/models/app/console-logs.mdx index 5a6e822f4d..d6127f5760 100644 --- a/models/app/console-logs.mdx +++ b/models/app/console-logs.mdx @@ -4,25 +4,25 @@ description: "View and debug console log messages including info, warnings, and keywords: ["run logs", "wandb logging", "debug runs", "log filtering", "stdout capture"] --- -When you run an experiment, you might notice messages printed to your console. W&B captures console logs and displays them in the W&B App. Use these messages to debug and monitor the behavior of your experiment. +When you run an experiment, you might notice messages printed to your console. W&B captures console logs and displays them in W&B. Use these messages to debug and monitor the behavior of your experiment. The following sections describe how to view, configure, search, filter, download, and copy console logs for your runs. ## View console logs -Access console logs for a run in the W&B App to inspect messages produced during the run. +Access console logs for a run in W&B to inspect messages produced during the run. -1. Navigate to your project in the W&B App. +1. Navigate to your project in W&B. 2. Select a run within the **Runs** table. 3. Click the **Logs** tab in the project sidebar. -W&B stores a maximum of 100,000 lines of your logs for a run. In the W&B App, a maximum of 10,000 lines of your logs display at once. To view all stored lines, scroll through the logs to display older lines. +W&B stores a maximum of 100,000 lines of your logs for a run. In W&B, a maximum of 10,000 lines of your logs display at once. To view all stored lines, scroll through the logs to display older lines. {/* ## Console log fields -Within the W&B App you can modify the fields shown in the console logs table. */} +Within W&B you can modify the fields shown in the console logs table. */} ## Types of console logs @@ -44,9 +44,9 @@ The following example shows how to configure these settings: import wandb settings = wandb.Settings( - show_errors=True, # Show error messages in the W&B App + show_errors=True, # Show error messages in W&B silent=False, # Disable all W&B console output - show_warnings=True # Show warning messages in the W&B App + show_warnings=True # Show warning messages in W&B ) with wandb.init(settings=settings) as run: @@ -116,18 +116,18 @@ with wandb.init( ## Download console logs -To save logs locally for offline analysis or sharing, download console logs for a run in the W&B App: +To save logs locally for offline analysis or sharing, download console logs for a run in W&B: -1. Navigate to your project in the W&B App. +1. Navigate to your project in W&B. 2. Select a run within the **Runs** table. 3. Click the **Logs** tab in the project sidebar. 4. Click the download button on the console logs page. ## Copy console logs -To paste logs into another tool or message, copy console logs for a run in the W&B App: +To paste logs into another tool or message, copy console logs for a run in W&B: -1. Navigate to your project in the W&B App. +1. Navigate to your project in W&B. 2. Select a run within the **Runs** table. 3. Click the **Logs** tab in the project sidebar. 4. Click the copy button on the console logs page. diff --git a/models/app/features/cascade-settings.mdx b/models/app/features/cascade-settings.mdx index b95f0b817e..aecfd9668c 100644 --- a/models/app/features/cascade-settings.mdx +++ b/models/app/features/cascade-settings.mdx @@ -1,6 +1,6 @@ --- title: Manage workspace, section, and panel settings -description: "Manage workspace, section, and panel settings in the W&B App, including layout and line plot configuration options." +description: "Manage workspace, section, and panel settings in W&B, including layout and line plot configuration options." keywords: ["workspace layout", "line plot defaults", "panel organization", "section settings", "x-axis options"] --- diff --git a/models/app/features/panels/line-plot/sampling.mdx b/models/app/features/panels/line-plot/sampling.mdx index 52158d01ff..2eb8bd015c 100644 --- a/models/app/features/panels/line-plot/sampling.mdx +++ b/models/app/features/panels/line-plot/sampling.mdx @@ -16,7 +16,7 @@ When you use full fidelity mode, W&B breaks the x-axis into dynamic buckets. The Full fidelity mode for point aggregation has three main advantages: * Preserve extreme values and spikes: retain extreme values and spikes in your data. -* Configure how minimum and maximum points render: use the W&B App to interactively decide whether you want to show extreme (min/max) values as a shaded area. +* Configure how minimum and maximum points render: use W&B to interactively decide whether you want to show extreme (min/max) values as a shaded area. * Explore your data without losing data fidelity: W&B recalculates x-axis bucket sizes when you zoom into specific data points. This helps ensure that you can explore your data without losing accuracy. W&B caches previously computed aggregations to help reduce loading times, which is useful when you navigate through large datasets. ### Turn on full fidelity diff --git a/models/app/keyboard-shortcuts.mdx b/models/app/keyboard-shortcuts.mdx index 9c5effb0f2..863c6dec8c 100644 --- a/models/app/keyboard-shortcuts.mdx +++ b/models/app/keyboard-shortcuts.mdx @@ -4,12 +4,12 @@ title: Keyboard shortcuts keywords: ["hotkeys", "LEET", "quick search", "undo redo", "panel navigation"] --- -W&B supports keyboard shortcuts to help you navigate and interact with experiments, workspaces, and data more efficiently. This guide covers keyboard shortcuts for the W&B App and the W&B LEET (Lightweight Experiment Exploration Tool) terminal UI. +W&B supports keyboard shortcuts to help you navigate and interact with experiments, workspaces, and data more efficiently. This guide covers keyboard shortcuts for W&B and the W&B LEET (Lightweight Experiment Exploration Tool) terminal UI. -The following tables list keyboard shortcuts available in the W&B App, grouped by where they apply. +The following tables list keyboard shortcuts available in W&B, grouped by where they apply. ## Workspace management @@ -26,7 +26,7 @@ The following tables list keyboard shortcuts available in the W&B App, grouped b | **Cmd+J** (macOS) / **Ctrl+J** (Windows/Linux) | Switch between the Workspaces and Runs tabs in the project sidebar. | | **Cmd+.** (macOS) / **Ctrl+.** (Windows/Linux) | Minimize or restore the Runs selector sidebar to reclaim screen space. | | **Cmd+K** (macOS) / **Ctrl+K** (Windows/Linux) | Open the quick search dialog to search across projects, runs, and other resources. | -| **Esc** | Throughout the W&B App, exit full-screen panel views, close settings drawers, dismiss the quick search dialog, close an editor, or dismiss other overlays. | +| **Esc** | Throughout W&B, exit full-screen panel views, close settings drawers, dismiss the quick search dialog, close an editor, or dismiss other overlays. | ## Panel navigation @@ -57,10 +57,10 @@ The following tables list keyboard shortcuts available in the W&B App, grouped b ## Notes -Keep the following points in mind when using keyboard shortcuts in the W&B App: +Keep the following points in mind when using keyboard shortcuts in W&B: - Most keyboard shortcuts use **Cmd** on macOS and **Ctrl** on Windows/Linux. -- The W&B App implements custom handling for some browser default shortcuts. +- W&B implements custom handling for some browser default shortcuts. - Some shortcuts are context-sensitive and only work in specific areas of the app. diff --git a/models/artifacts/construct-an-artifact.mdx b/models/artifacts/construct-an-artifact.mdx index 3f958d566b..4b3aa11225 100644 --- a/models/artifacts/construct-an-artifact.mdx +++ b/models/artifacts/construct-an-artifact.mdx @@ -24,7 +24,7 @@ Initialize the [`wandb.Artifact()`](/models/ref/python/experiments/artifact) cla -W&B uses the "name" and "type" you provide to create a directed acyclic graph in the W&B App. See the [Explore and traverse artifact graphs](./explore-and-traverse-an-artifact-graph) for more information. +W&B uses the "name" and "type" you provide to create a directed acyclic graph in W&B. See the [Explore and traverse artifact graphs](./explore-and-traverse-an-artifact-graph) for more information. diff --git a/models/artifacts/delete-artifacts.mdx b/models/artifacts/delete-artifacts.mdx index af6c966ae9..ceeb7bb9e5 100644 --- a/models/artifacts/delete-artifacts.mdx +++ b/models/artifacts/delete-artifacts.mdx @@ -4,7 +4,7 @@ description: Delete artifacts interactively with the App UI or programmatically title: Delete an artifact --- -Delete artifacts interactively with the W&B App or programmatically with the W&B Python SDK. When you delete an artifact, W&B marks that artifact as a *soft-delete*. In other words, the artifact is marked for deletion but files are not immediately deleted from storage. +Delete artifacts interactively with W&B or programmatically with the W&B Python SDK. When you delete an artifact, W&B marks that artifact as a *soft-delete*. In other words, the artifact is marked for deletion but files are not immediately deleted from storage. The contents of the artifact remain as a soft-delete, or pending deletion state, until a regularly run garbage collection process reviews all artifacts marked for deletion. The garbage collection process deletes associated files from storage if the artifact and its associated files are not used by a previous or subsequent artifact versions. @@ -20,7 +20,7 @@ The following diagram illustrates the complete artifact garbage collection proce graph TB Start([Artifact Deletion Initiated]) --> DeleteMethod{Deletion Method} - DeleteMethod -->|UI| UIDelete[Delete via W&B App] + DeleteMethod -->|UI| UIDelete[Delete via W&B] DeleteMethod -->|SDK| SDKDelete[Delete via W&B Python SDK] DeleteMethod -->|TTL| TTLDelete[TTL Policy Expires] @@ -51,7 +51,7 @@ graph TB You can schedule when artifacts are deleted from W&B with TTL policies. For more information, see [Manage data retention with Artifact TTL policy](./ttl). -Artifacts deleted by a TTL policy, the W&B Python SDK, or the W&B App are first soft-deleted. Soft-deleted artifacts are then garbage-collected before they are permanently deleted. +Artifacts deleted by a TTL policy, the W&B Python SDK, or W&B are first soft-deleted. Soft-deleted artifacts are then garbage-collected before they are permanently deleted. @@ -60,10 +60,10 @@ Deleting an entity, project, or artifact collection triggers the artifact deleti ## Delete an artifact version -Delete an artifact version interactively with the W&B App or programmatically with the W&B Python SDK. +Delete an artifact version interactively with W&B or programmatically with the W&B Python SDK. - + To delete an artifact version: 1. Navigate to the project that contains the artifact version you want to delete. @@ -154,7 +154,7 @@ for artifact in run.logged_artifacts(): ## Delete an artifact collection - + To delete an artifact collection: 1. Navigate to the artifact collection you want to delete. diff --git a/models/artifacts/explore-and-traverse-an-artifact-graph.mdx b/models/artifacts/explore-and-traverse-an-artifact-graph.mdx index eec9a780ca..38d9c95fa1 100644 --- a/models/artifacts/explore-and-traverse-an-artifact-graph.mdx +++ b/models/artifacts/explore-and-traverse-an-artifact-graph.mdx @@ -18,16 +18,16 @@ Tracking artifact lineage provides several key advantages: To view an artifact's lineage graph: -1. Navigate to your project's workspace in the W&B App. +1. Navigate to your project's workspace in W&B. 2. Click on the **Artifacts** tab in the project sidebar. 3. Select an artifact, then click the **Lineage** tab. ## Navigate lineage graphs -The lineage graph is a visual representation of the relationships between artifacts and runs in an ML experiment. Use the W&B App UI or the Python SDK to explore and traverse an artifact's lineage graph. +The lineage graph is a visual representation of the relationships between artifacts and runs in an ML experiment. Use W&B or the Python SDK to explore and traverse an artifact's lineage graph. - + Nodes with green icons represent runs. Nodes with blue icons represent artifacts. Arrows between nodes indicate the input and output of a run or artifact. diff --git a/models/artifacts/track-external-files.mdx b/models/artifacts/track-external-files.mdx index 7ce9747e47..17cfe7238d 100644 --- a/models/artifacts/track-external-files.mdx +++ b/models/artifacts/track-external-files.mdx @@ -7,7 +7,7 @@ Use *reference artifacts* to track and use files saved outside of W&B servers. C Reference artifacts behave similar to non-reference artifacts. The key difference is that the reference artifacts only consists of metadata about the files, such as their sizes and MD5 checksums. The files themselves never leave your system. -You can interact with reference artifact similarly to non-reference artifacts. In the W&B App, you can browse the contents of the reference artifact using the file browser, explore the full dependency graph, and scan through the versioned history of your artifact. However, the UI cannot render rich media such as images, audio, because the data itself is not contained within the artifact. +You can interact with reference artifact similarly to non-reference artifacts. In W&B, you can browse the contents of the reference artifact using the file browser, explore the full dependency graph, and scan through the versioned history of your artifact. However, the UI cannot render rich media such as images, audio, because the data itself is not contained within the artifact. If you log an artifact that does not track external files, W&B saves the artifact's files to W&B servers. This is the default behavior when you log artifacts with the W&B Python SDK. @@ -71,7 +71,7 @@ with wandb.init(project="my-project") as run: run.log_artifact(artifact) ``` -Within the W&B App, you can look through the contents of the reference artifact using the file browser, [explore the full dependency graph](/models/artifacts/explore-and-traverse-an-artifact-graph/), and scan through the versioned history of your artifact. The W&B App does not render rich media such as images, audio, and so forth because the data itself is not contained within the artifact. +Within W&B, you can look through the contents of the reference artifact using the file browser, [explore the full dependency graph](/models/artifacts/explore-and-traverse-an-artifact-graph/), and scan through the versioned history of your artifact. W&B does not render rich media such as images, audio, and so forth because the data itself is not contained within the artifact. W&B Artifacts support any Amazon S3 compatible interface, including CoreWeave Storage and MinIO. The scripts described below work as-is with both providers, when you set the `AWS_S3_ENDPOINT_URL` environment variable to point at your CoreWeave Storage or MinIO server. @@ -154,7 +154,7 @@ W&B uses the default mechanism to look for credentials based on the cloud provid For AWS, if the bucket is not located in the configured user's default region, you must set the `AWS_REGION` environment variable to match the bucket region. -Rich media such as images, audio, video, and point clouds may fail to render in the App UI depending on the CORS configuration of your bucket. Allow listing **app.wandb.ai** in your bucket's CORS settings will allow the W&B App to properly render such rich media. +Rich media such as images, audio, video, and point clouds may fail to render in the App UI depending on the CORS configuration of your bucket. Allow listing **app.wandb.ai** in your bucket's CORS settings will allow W&B to properly render such rich media. If rich media such as images, audio, video, and point clouds does not render in the App UI, ensure that `app.wandb.ai` is allowlisted in your bucket's CORS policy. diff --git a/models/artifacts/ttl.mdx b/models/artifacts/ttl.mdx index e6339c066d..8c8d851780 100644 --- a/models/artifacts/ttl.mdx +++ b/models/artifacts/ttl.mdx @@ -8,14 +8,14 @@ import { ColabLink } from '/snippets/_includes/colab-link.mdx'; Schedule when artifacts are deleted from W&B with a W&B Artifact time-to-live (TTL) policy. When you delete an artifact, W&B marks that artifact as a *soft-delete*. In other words, the artifact is marked for deletion but files are not immediately deleted from storage. For more information on how W&B deletes artifacts, see the [Delete artifacts](./delete-artifacts) page. -Watch a [Managing data retention with Artifacts TTL](https://www.youtube.com/watch?v=hQ9J6BoVmnc) video tutorial to learn how to manage data retention with Artifacts TTL in the W&B App. +Watch a [Managing data retention with Artifacts TTL](https://www.youtube.com/watch?v=hQ9J6BoVmnc) video tutorial to learn how to manage data retention with Artifacts TTL in W&B. W&B deactivates the option to set a TTL policy for artifacts linked to the Registry. This is to help ensure that linked artifacts do not accidentally expire if used in production workflows. * Only team admins can view a [team's settings](/platform/app/settings-page/teams) and access team level TTL settings such as (1) permitting who can set or edit a TTL policy or (2) setting a team default TTL. -* If you do not see the option to set or edit a TTL policy in an artifact's details in the W&B App UI or if setting a TTL programmatically does not successfully change an artifact's TTL property, your team admin has not given you permissions to do so. +* If you do not see the option to set or edit a TTL policy in an artifact's details in W&B or if setting a TTL programmatically does not successfully change an artifact's TTL property, your team admin has not given you permissions to do so. ## Auto-generated Artifacts @@ -93,7 +93,7 @@ with wandb.init(project="", entity="") as run: The preceding code snippet sets the TTL policy for the artifact to 30 days. In other words, W&B deletes the artifact after 30 days. ### Set or edit a TTL policy after you create an artifact -Use the W&B App UI or the W&B Python SDK to define a TTL policy for an artifact that already exists. +Use W&B or the W&B Python SDK to define a TTL policy for an artifact that already exists. When you modify an artifact's TTL, the time the artifact takes to expire is still calculated using the artifact's `createdAt` timestamp. @@ -118,8 +118,8 @@ artifact.save() The preceding code example sets the TTL policy to two years. - -1. Navigate to your W&B project in the W&B App UI. + +1. Navigate to your W&B project in W&B. 2. Select the artifact icon in the project sidebar. 3. From the list of artifacts, expand the artifact type you 4. Select on the artifact version you want to edit the TTL policy for. @@ -174,7 +174,7 @@ artifact.save() ``` ## Deactivate a TTL policy -Use the W&B Python SDK or W&B App UI to deactivate a TTL policy for a specific artifact version. +Use the W&B Python SDK or W&B to deactivate a TTL policy for a specific artifact version. {/* Artifacts with TTL turned off will not inherit an artifact collection's TTL. Refer to (## Inherit TTL Policy) on how to delete artifact TTL and inherit from the collection level TTL. */} @@ -193,8 +193,8 @@ artifact.ttl = None artifact.save() ``` - -1. Navigate to your W&B project in the W&B App UI. + +1. Navigate to your W&B project in W&B. 2. Select the artifact icon in the project sidebar. 3. From the list of artifacts, expand the artifact type you 4. Select on the artifact version you want to edit the TTL policy for. @@ -214,7 +214,7 @@ artifact.save() ## View TTL policies -View TTL policies for artifacts with the Python SDK or with the W&B App UI. +View TTL policies for artifacts with the Python SDK or with W&B. @@ -225,10 +225,10 @@ artifact = run.use_artifact("") print(artifact.ttl) ``` - -View a TTL policy for an artifact with the W&B App UI. + +View a TTL policy for an artifact with W&B. -1. Navigate to the [W&B App](https://wandb.ai). +1. Navigate to [W&B](https://wandb.ai). 2. Navigate to your W&B Project. 3. Within your project, select the Artifacts tab in the project sidebar. 4. Click on a collection. diff --git a/models/automations.mdx b/models/automations.mdx index bfdc50375e..b9446dcf03 100644 --- a/models/automations.mdx +++ b/models/automations.mdx @@ -58,7 +58,7 @@ To [create an automation](/models/automations/create-automations), you: [Run metric automations](/models/automations/automation-events/#run-metrics-events) and [run metrics z-score change automations](/models/automations/automation-events/#run-metrics-z-score-change-automations) are currently supported only in [W&B Multi-tenant Cloud](/platform/hosting/#wb-multi-tenant-cloud). ## Next steps -- [Automations tutorial](/models/automations/tutorial): Guides you to create a project automation to alert on run failures and a Registry automation to run a webhoook when an alias is added. The tutorial uses the W&B App. +- [Automations tutorial](/models/automations/tutorial): Guides you to create a project automation to alert on run failures and a Registry automation to run a webhoook when an alias is added. The tutorial uses W&B. - [Create an automation](/models/automations/create-automations). - [Automation events and scopes](/models/automations/automation-events). - [Create a secret](/platform/secrets). diff --git a/models/automations/api.mdx b/models/automations/api.mdx index 3096fb5850..502438ef19 100644 --- a/models/automations/api.mdx +++ b/models/automations/api.mdx @@ -1,13 +1,13 @@ --- title: Manage automations with the API -description: Programmatic automation management with the Python API. Create and update may be affected on some client versions. Prefer the W&B App until the SDK fix ships. +description: Programmatic automation management with the Python API. Create and update may be affected on some client versions. Prefer W&B until the SDK fix ships. keywords: ["Python API", "programmatic automation", "wandb.Api", "automation scripting", "SDK"] --- -Manage W&B automations programmatically with the `wandb` Python API when you script automation workflows instead of using the W&B App. +Manage W&B automations programmatically with the `wandb` Python API when you script automation workflows instead of using W&B. -Programmatic **create** and **update** for automations through `wandb.Api().create_automation()` and related helpers can fail on some `wandb` Python client versions because of a client-side feature check (for example, run-state automations). Until a fixed SDK ships, use the [W&B App](/models/automations/create-automations) to create and edit automations. The `list`, `get`, and `delete` methods aren't affected. Internal tracking: WB-34263. +Programmatic **create** and **update** for automations through `wandb.Api().create_automation()` and related helpers can fail on some `wandb` Python client versions because of a client-side feature check (for example, run-state automations). Until a fixed SDK ships, use [W&B](/models/automations/create-automations) to create and edit automations. The `list`, `get`, and `delete` methods aren't affected. Internal tracking: WB-34263. ## Next steps @@ -15,7 +15,7 @@ Programmatic **create** and **update** for automations through `wandb.Api().crea Refer to the following resources to manage automations and learn more about how they work: - [Automations overview](/models/automations) -- [Create an automation](/models/automations/create-automations) (W&B App) +- [Create an automation](/models/automations/create-automations) (W&B) - [Automation events and scopes](/models/automations/automation-events) - [Automations API reference](/models/ref/python/public-api/automations) (Python types and `Api` methods) diff --git a/models/automations/create-automations.mdx b/models/automations/create-automations.mdx index 54c046f776..7b35da9b83 100644 --- a/models/automations/create-automations.mdx +++ b/models/automations/create-automations.mdx @@ -69,7 +69,7 @@ View and manage automations from a project or registry's **Automations** tab: For more information, see the following resources: -- [Automations tutorials](/models/automations/tutorial): Build a [project run failure alert](/models/automations/project-automation-tutorial) or a [registry alias-to-webhook automation](/models/automations/registry-automation-tutorial) in the W&B App. +- [Automations tutorials](/models/automations/tutorial): Build a [project run failure alert](/models/automations/project-automation-tutorial) or a [registry alias-to-webhook automation](/models/automations/registry-automation-tutorial) in W&B. - [Automation events and scopes](/models/automations/automation-events). - [Create a Slack automation](/models/automations/create-automations/slack). - [Create a webhook automation](/models/automations/create-automations/webhook). diff --git a/models/automations/create-automations/webhook.mdx b/models/automations/create-automations/webhook.mdx index b9d26e3317..a3e7e29649 100644 --- a/models/automations/create-automations/webhook.mdx +++ b/models/automations/create-automations/webhook.mdx @@ -278,13 +278,13 @@ The following is an example payload: ## Troubleshoot your webhook -If a webhook isn't working as expected, you can troubleshoot it interactively with the W&B App UI or programmatically with a shell script. You can troubleshoot a webhook during creation or afterward. +If a webhook isn't working as expected, you can troubleshoot it interactively with W&B or programmatically with a shell script. You can troubleshoot a webhook during creation or afterward. For details about the format W&B uses for the `POST` request, refer to the **Shell script** tab. - -A team admin can test a webhook interactively with the W&B App UI. + +A team admin can test a webhook interactively with W&B. 1. Go to your team page, then click **Settings**. 1. Scroll to the **Webhooks** section. @@ -294,7 +294,7 @@ A team admin can test a webhook interactively with the W&B App UI. Demo of testing a webhook payload -1. Click **Test webhook**. Within the W&B App UI, W&B posts the response from your endpoint. +1. Click **Test webhook**. Within W&B, W&B posts the response from your endpoint. Demo of testing a webhook diff --git a/models/automations/project-automation-tutorial.mdx b/models/automations/project-automation-tutorial.mdx index a188c49a16..60b2ceb384 100644 --- a/models/automations/project-automation-tutorial.mdx +++ b/models/automations/project-automation-tutorial.mdx @@ -22,10 +22,10 @@ This tutorial walks you through building a **project** automation triggered by r Set up a project-scoped automation so that when a run in the project transitions to **Failed**, W&B sends a Slack notification. -{/* W&B App vs Python tab temporarily hidden pending Python SDK fix for `create_automation` / run-state automations (internal WB-34263). Restore when the regression is shipped. +{/* W&B vs Python tab temporarily hidden pending Python SDK fix for `create_automation` / run-state automations (internal WB-34263). Restore when the regression is shipped. - + */} 1. Open the project and click the **Automations** tab in the sidebar, then click **Create automation**. 1. Choose the event **Run state change**. Set the state to **Failed**. Optionally add a run name or user filter to limit which runs trigger the automation. diff --git a/models/automations/registry-automation-tutorial.mdx b/models/automations/registry-automation-tutorial.mdx index 7eba0ba1c9..dd05d7bebf 100644 --- a/models/automations/registry-automation-tutorial.mdx +++ b/models/automations/registry-automation-tutorial.mdx @@ -22,10 +22,10 @@ This tutorial walks you through building a **registry** automation triggered by Set up a registry-scoped automation so that when an artifact in any collection in the registry gets a specific alias (for example, **production**), W&B sends a `POST` request to your webhook. -{/* W&B App vs Python tab temporarily hidden pending Python SDK fix for `create_automation` (internal WB-34263). Restore when the regression is shipped. +{/* W&B vs Python tab temporarily hidden pending Python SDK fix for `create_automation` (internal WB-34263). Restore when the regression is shipped. - + */} 1. Open the registry and click the **Automations** tab, then click **Create automation**. 1. Choose the event **An artifact alias is added**. Enter an **Alias regex** that matches the alias you care about (for example, **production** or **staging**). @@ -72,7 +72,7 @@ automation = api.create_automation( ## Test the automation -To confirm that the automation fires end-to-end, trigger the configured event by adding the alias to an artifact version. Add the alias (for example, **production**) to an artifact version in the registry, using the W&B App or the public API. For example: +To confirm that the automation fires end-to-end, trigger the configured event by adding the alias to an artifact version. Add the alias (for example, **production**) to an artifact version in the registry, using W&B or the public API. For example: ```python import wandb diff --git a/models/models_quickstart.mdx b/models/models_quickstart.mdx index e5fbc7b53c..41c445cace 100644 --- a/models/models_quickstart.mdx +++ b/models/models_quickstart.mdx @@ -213,7 +213,7 @@ report = wr.Report( report.save() ``` -For more information on how to create a report programmatically or how to create a report interactively with the W&B App, see [Create a report](/models/reports/create-a-report) in the W&B Docs Developer guide. +For more information on how to create a report programmatically or how to create a report interactively with W&B, see [Create a report](/models/reports/create-a-report) in the W&B Docs Developer guide. ## Query the registry Use the [W&B Public APIs](/models/ref/python/public-api) to query, analyze, and manage historical data from W&B. This can be useful for tracking the lineage of artifacts, comparing different versions, and analyzing the performance of models over time. diff --git a/models/ref/cli/wandb-agent.mdx b/models/ref/cli/wandb-agent.mdx index 22658c1a7a..a0aeeb0e6a 100644 --- a/models/ref/cli/wandb-agent.mdx +++ b/models/ref/cli/wandb-agent.mdx @@ -25,7 +25,7 @@ Start a sweep agent. The agent exits when the sweep completes, the sweep is stopped, cancelled, or the `--count` limit is reached. - Find the sweep ID within the Sweeps tab in the W&B App + Find the sweep ID within the Sweeps tab in W&B or in the output of the `wandb sweep` command when you create a new sweep. The sweep ID can include the entity and project path diff --git a/models/ref/cli/wandb-sweep.mdx b/models/ref/cli/wandb-sweep.mdx index 56f8c39143..d2aaa37f69 100644 --- a/models/ref/cli/wandb-sweep.mdx +++ b/models/ref/cli/wandb-sweep.mdx @@ -29,7 +29,7 @@ Create, update, or manage a hyperparameter sweep. an existing sweep. The sweep ID is a unique identifier for the sweep, generated by - W&B when the sweep is created. You can find the sweep ID in the W&B App + W&B when the sweep is created. You can find the sweep ID in W&B or in the output of the `wandb sweep` command when you create a new sweep. For example, to create a sweep using the configuration defined in diff --git a/models/ref/python/experiments/artifact.mdx b/models/ref/python/experiments/artifact.mdx index ccd9545b45..f2fc16e198 100644 --- a/models/ref/python/experiments/artifact.mdx +++ b/models/ref/python/experiments/artifact.mdx @@ -31,9 +31,9 @@ __init__( **Args:** - - `name` (str): A human-readable name for the artifact. Use the name to identify a specific artifact in the W&B App UI or programmatically. You can interactively reference an artifact with the `use_artifact` Public API. A name can contain letters, numbers, underscores, hyphens, and dots. The name must be unique across a project. + - `name` (str): A human-readable name for the artifact. Use the name to identify a specific artifact in W&B or programmatically. You can interactively reference an artifact with the `use_artifact` Public API. A name can contain letters, numbers, underscores, hyphens, and dots. The name must be unique across a project. - `type` (str): The artifact's type. Use the type of an artifact to both organize and differentiate artifacts. You can use any string that contains letters, numbers, underscores, hyphens, and dots. Common types include `dataset` or `model`. Include `model` within your type string if you want to link the artifact to the W&B Model Registry. Note that some types reserved for internal use and cannot be set by users. Such types include `job` and types that start with `wandb-`. - - `description (str | None) = None`: A description of the artifact. For Model or Dataset Artifacts, add documentation for your standardized team model or dataset card. View an artifact's description programmatically with the `Artifact.description` attribute or programmatically with the W&B App UI. W&B renders the description as markdown in the W&B App. + - `description (str | None) = None`: A description of the artifact. For Model or Dataset Artifacts, add documentation for your standardized team model or dataset card. View an artifact's description programmatically with the `Artifact.description` attribute or programmatically with W&B. W&B renders the description as markdown in W&B. - `metadata (dict[str, Any] | None) = None`: Additional information about an artifact. Specify metadata as a dictionary of key-value pairs. You can specify no more than 100 total keys. - `incremental`: Use `Artifact.new_draft()` method instead to modify an existing artifact. - `use_as`: Deprecated. @@ -57,7 +57,7 @@ List of one or more semantically-friendly references or identifying "nicknames" assigned to an artifact version. -Aliases are mutable references that you can programmatically reference. Change an artifact's alias with the W&B App UI or programmatically. See [Create new artifact versions](https://docs.wandb.ai/models/artifacts/create-a-new-artifact-version) for more information. +Aliases are mutable references that you can programmatically reference. Change an artifact's alias with W&B or programmatically. See [Create new artifact versions](https://docs.wandb.ai/models/artifacts/create-a-new-artifact-version) for more information. @@ -504,7 +504,7 @@ Add a local directory to the artifact. **Args:** - `local_path`: The path of the local directory. - - `name`: The subdirectory name within an artifact. The name you specify appears in the W&B App UI nested by artifact's `type`. Defaults to the root of the artifact. + - `name`: The subdirectory name within an artifact. The name you specify appears in W&B nested by artifact's `type`. Defaults to the root of the artifact. - `skip_cache`: If set to `True`, W&B will not copy/move files to the cache while uploading - `policy`: By default, "mutable". - mutable: Create a temporary copy of the file to prevent corruption during upload. diff --git a/models/ref/python/experiments/run.mdx b/models/ref/python/experiments/run.mdx index d23da1fc48..57111a1c2f 100644 --- a/models/ref/python/experiments/run.mdx +++ b/models/ref/python/experiments/run.mdx @@ -123,7 +123,7 @@ Identifier for this run. Name of the job type associated with the run. -View a run's job type in the run's Overview page in the W&B App. +View a run's job type in the run's Overview page in W&B. You can use this to categorize runs by their job type, such as "training", "evaluation", or "inference". This is useful for organizing and filtering runs in the W&B UI, especially when you have multiple runs with different job types in the same project. For more information, see [Organize runs](https://docs.wandb.ai/models/runs#organize-runs). diff --git a/models/ref/python/experiments/system-metrics.mdx b/models/ref/python/experiments/system-metrics.mdx index 8b01408270..83777af8bf 100644 --- a/models/ref/python/experiments/system-metrics.mdx +++ b/models/ref/python/experiments/system-metrics.mdx @@ -13,14 +13,14 @@ This page provides detailed information about the system metrics that are tracke ## View system metrics -You can view and monitor system metrics using the W&B App or the `wandb beta leet` terminal UI. +You can view and monitor system metrics using W&B or the `wandb beta leet` terminal UI. -To view system metrics in the W&B App: +To view system metrics in W&B: -1. Navigate to your project in the W&B App. +1. Navigate to your project in W&B. 2. Select a run from the **Runs** table. 3. In the workspace, look for the **System** section which displays charts for: - GPU utilization and memory diff --git a/models/ref/wandb_workspaces/workspaces.mdx b/models/ref/wandb_workspaces/workspaces.mdx index 52874874d6..ee35ff4d53 100644 --- a/models/ref/wandb_workspaces/workspaces.mdx +++ b/models/ref/wandb_workspaces/workspaces.mdx @@ -173,7 +173,7 @@ Represents a section in a workspace. ## class `SectionLayoutSettings` -Panel layout settings for a section, typically seen at the top right of the section of the W&B App Workspace UI. +Panel layout settings for a section, typically seen at the top right of the section of the W&B Workspace UI. diff --git a/models/registry.mdx b/models/registry.mdx index 638c9de0ee..98ffeeb871 100644 --- a/models/registry.mdx +++ b/models/registry.mdx @@ -97,7 +97,7 @@ Based on your deployment type, satisfy the following conditions to enable W&B Re | Deployment type | How to enable | |--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Multi-tenant Cloud | No action required. W&B Registry is available on the W&B App. | +| Multi-tenant Cloud | No action required. W&B Registry is available on W&B. | | Dedicated Cloud | Contact your account team to enable W&B Registry for your deployment. | | Self-Managed | For Server v0.71.0 or newer, no action required. Registry is enabled by default. For older supported Server versions, contact your W&B account team to enable Registry. | diff --git a/models/registry/create_collection.mdx b/models/registry/create_collection.mdx index ca5c59b5c5..01347e3594 100644 --- a/models/registry/create_collection.mdx +++ b/models/registry/create_collection.mdx @@ -53,14 +53,14 @@ Before you link an artifact to a collection or create a new collection, [investi ### Check the types of artifact that a collection accepts -Before you link to a collection, inspect the artifact type that the collection accepts. You can inspect the artifact types that collection accepts programmatically with the W&B Python SDK or interactively with the W&B App +Before you link to a collection, inspect the artifact type that the collection accepts. You can inspect the artifact types that collection accepts programmatically with the W&B Python SDK or interactively with W&B An error message appears if you try to create link an artifact to a collection that does not accept that artifact type. - + You can find the accepted artifact types on the registry card on the homepage or within a registry's settings page. For both methods, first navigate to your W&B Registry. diff --git a/models/registry/delete_registry.mdx b/models/registry/delete_registry.mdx index 7d9ff20ea2..c782942dac 100644 --- a/models/registry/delete_registry.mdx +++ b/models/registry/delete_registry.mdx @@ -1,6 +1,6 @@ --- title: Delete registry -description: "Delete a W&B Registry as a Team admin or Registry admin using the Python SDK or the W&B App UI." +description: "Delete a W&B Registry as a Team admin or Registry admin using the Python SDK or W&B." --- This page shows how a Team admin or Registry admin can delete a registry. @@ -31,7 +31,7 @@ fetched_registry = api.registry("") fetched_registry.delete() ``` - + 1. Navigate to the W&B Registry at https://wandb.ai/registry/. 2. Select the registry you want to delete. 3. Click the gear icon in the upper right corner to view the registry's settings. diff --git a/models/registry/download_use_artifact.mdx b/models/registry/download_use_artifact.mdx index c71624a311..a8f84101d2 100644 --- a/models/registry/download_use_artifact.mdx +++ b/models/registry/download_use_artifact.mdx @@ -5,7 +5,7 @@ description: "Download an artifact linked to a W&B Registry collection by constr Use the W&B Python SDK to download an artifact linked to a registry. To download and use an artifact, you need to know the name of the registry, the name of the collection, and the alias or index of the artifact version you want to download. -Once you know the properties of the artifact, you can [construct the path to the linked artifact](#construct-path-to-linked-artifact) and download the artifact. Alternatively, you can [copy and paste a pre-generated code snippet](#copy-and-paste-pre-generated-code-snippet) from the W&B App UI to download an artifact linked to a registry. +Once you know the properties of the artifact, you can [construct the path to the linked artifact](#construct-path-to-linked-artifact) and download the artifact. Alternatively, you can [copy and paste a pre-generated code snippet](#copy-and-paste-pre-generated-code-snippet) from W&B to download an artifact linked to a registry. ## Construct path to linked artifact diff --git a/models/registry/link_version.mdx b/models/registry/link_version.mdx index 7963661b78..1199308aa7 100644 --- a/models/registry/link_version.mdx +++ b/models/registry/link_version.mdx @@ -6,7 +6,7 @@ description: "Link an artifact version to a collection in W&B Registry to share To make an artifact version available to your organization, *link* it to a [collection](/models/registry/create_collection) in the W&B Registry. Linking moves the version from a [private, project-level scope to a shared, organization-level scope](/models/registry/create_registry#visibility-types). You -can link an artifact version [programmatically by using the W&B Python SDK or interactively in the W&B App](/models/registry/link_version#link-an-artifact-to-a-collection). +can link an artifact version [programmatically by using the W&B Python SDK or interactively in W&B](/models/registry/link_version#link-an-artifact-to-a-collection). When you link an artifact, W&B creates a reference between the source artifact and the collection entry. The linked version points to the source artifact version that was logged to a run within a project. You can view both the linked version in the collection and the source version in the project where it was logged. @@ -141,7 +141,7 @@ artifact.link(target_path = target_path) {/* TO DO insert gif */} -1. Navigate to your project's artifact browser on the W&B App at: `https://wandb.ai///artifacts` +1. Navigate to your project's artifact browser on W&B at: `https://wandb.ai///artifacts` 2. Select the Artifacts icon in the project sidebar. 3. Click on the artifact version you want to link to your registry. 4. Within the **Version overview** section, click the **Link to registry** button. @@ -228,7 +228,7 @@ You can confirm the name of your team by: To log artifacts, see [Construct artifacts](/models/artifacts/construct-an-artifact/). 3. If an artifact is logged to your personal entity, you will need to re-log it to an entity within your organization. -### Confirm the path of a registry in the W&B App UI +### Confirm the path of a registry in W&B There are two ways to confirm the path of a registry with the UI: create an empty collection and view the collection details or copy and paste the autogenerated code on the collection's homepage. diff --git a/models/registry/organize-with-tags.mdx b/models/registry/organize-with-tags.mdx index 796346aee6..be3c9f9f3a 100644 --- a/models/registry/organize-with-tags.mdx +++ b/models/registry/organize-with-tags.mdx @@ -1,10 +1,10 @@ --- description: Use tags to organize collections or artifact versions within collections. - You can add, remove, edit tags with the Python SDK or W&B App UI. + You can add, remove, edit tags with the Python SDK or W&B. title: Organize versions with tags --- -Create and add tags to organize your collections or artifact versions within your registry. Add, modify, view, or remove tags to a collection or artifact version with the W&B App UI or the W&B Python SDK. +Create and add tags to organize your collections or artifact versions within your registry. Add, modify, view, or remove tags to a collection or artifact version with W&B or the W&B Python SDK. **When to use a tag versus using an alias** @@ -17,11 +17,11 @@ Use tags when you want more flexibility for grouping or searching. Tags are idea ## Add a tag to a collection -Use the W&B App UI or Python SDK to add a tag to a collection: +Use W&B or Python SDK to add a tag to a collection: - -Use the W&B App UI to add a tag to a collection: + +Use W&B to add a tag to a collection: 1. Navigate to the [W&B Registry](https://wandb.ai/registry). 2. Click on a registry card. @@ -85,7 +85,7 @@ collection.tags.clear() ## View tags that belong to a collection -Use the W&B App UI to view tags added to a collection: +Use W&B to view tags added to a collection: 1. Navigate to the [W&B Registry](https://wandb.ai/registry). 2. Click on a registry card. @@ -108,7 +108,7 @@ For example, in the following image, a tag called "tag1" was added to the "zoo-d ## Remove a tag from a collection -Use the W&B App UI to remove a tag from a collection: +Use W&B to remove a tag from a collection: 1. Navigate to the [W&B Registry](https://wandb.ai/registry). 2. Click on a registry card. @@ -118,10 +118,10 @@ Use the W&B App UI to remove a tag from a collection: ## Add a tag to an artifact version -Add a tag to an artifact version linked to a collection with the W&B App UI or with the Python SDK. +Add a tag to an artifact version linked to a collection with W&B or with the Python SDK. - + 1. Navigate to the W&B Registry at https://wandb.ai/registry 2. Click on a registry card. 3. Click **View details** next to the name of the collection you want to add a tag to. @@ -212,10 +212,10 @@ artifact.tags.clear() ## View tags that belong to an artifact version -View tags that belong to an artifact version that is linked to a registry with the W&B App UI or with the Python SDK. +View tags that belong to an artifact version that is linked to a registry with W&B or with the Python SDK. - + 1. Navigate to the [W&B Registry](https://wandb.ai/registry). 2. Click on a registry card. 3. Click **View details** next to the name of the collection you want to add a tag to. @@ -284,7 +284,7 @@ with wandb.init(entity = "", project="") as run: ## Search existing tags -Use the W&B App UI to search existing tags in collections and artifact versions: +Use W&B to search existing tags in collections and artifact versions: 1. Navigate to the [W&B Registry](https://wandb.ai/registry). 2. Click on a registry card. diff --git a/models/registry/search_registry.mdx b/models/registry/search_registry.mdx index cd7ab331a8..9e466a5964 100644 --- a/models/registry/search_registry.mdx +++ b/models/registry/search_registry.mdx @@ -13,7 +13,7 @@ Only items that you have permission to view appear in the search results. ## Search for registry items -Use the W&B App to search for a registry item: +Use W&B to search for a registry item: 1. Navigate to the W&B Registry. 2. Specify the search term in the search bar at the top of the page. Press Enter to search. diff --git a/models/reports.mdx b/models/reports.mdx index 536fbe3286..b42794b9c1 100644 --- a/models/reports.mdx +++ b/models/reports.mdx @@ -29,7 +29,7 @@ View the report where the above image was taken from [here](https://wandb.ai/sta ## How it works Create a collaborative report with a few clicks. -1. Navigate to your W&B project workspace in the W&B App. +1. Navigate to your W&B project workspace in W&B. 2. Click the **Create report** button in the upper right corner of your workspace. diff --git a/models/reports/clone-and-export-reports.mdx b/models/reports/clone-and-export-reports.mdx index e31ca6bbc8..a18eb2a412 100644 --- a/models/reports/clone-and-export-reports.mdx +++ b/models/reports/clone-and-export-reports.mdx @@ -16,10 +16,10 @@ Export a report as a PDF or LaTeX file to share its contents outside of W&B or t ## Clone a report -Clone a report to reuse an existing project's template and formatting as the basis for a new report. You can clone reports in the W&B App UI or programmatically with the Report and Workspace API. +Clone a report to reuse an existing project's template and formatting as the basis for a new report. You can clone reports in W&B or programmatically with the Report and Workspace API. - + In your report, select the **action ()** menu. Choose **Clone this report**. In the modal, pick a destination for your cloned report. Choose **Clone report**. diff --git a/models/reports/create-a-report.mdx b/models/reports/create-a-report.mdx index b9c8f3d9ba..48f194f88f 100644 --- a/models/reports/create-a-report.mdx +++ b/models/reports/create-a-report.mdx @@ -1,5 +1,5 @@ --- -description: Create a W&B Report with the W&B App or programmatically. +description: Create a W&B Report with W&B or programmatically. title: Create a report keywords: ["create report", "wandb-workspaces", "Report API", "programmatic reports"] --- @@ -8,14 +8,14 @@ keywords: ["create report", "wandb-workspaces", "Report API", "programmatic repo W&B Report and Workspace API is in Public Preview. -Select a tab to learn how to create a report in the W&B App or programmatically with the Report and Workspace API. +Select a tab to learn how to create a report in W&B or programmatically with the Report and Workspace API. For an example of how to programmatically create a report, see this [Google Colab](https://colab.research.google.com/github/wandb/examples/blob/master/colabs/intro/Report_API_Quickstart.ipynb). - -1. Navigate to your project workspace in the W&B App. + +1. Navigate to your project workspace in W&B. 2. In the upper-right corner of your workspace, click **Create report**. @@ -31,7 +31,7 @@ For an example of how to programmatically create a report, see this [Google Cola 4. Select the **Filter run sets** option to prevent new runs from being added to your report. You can toggle this option on or off. A draft report is saved automatically. Access it in the **Reports** tab. -1. Navigate to your project workspace in the W&B App. +1. Navigate to your project workspace in W&B. 2. Select the **Reports** tab in your project. 3. Click **Create report**. diff --git a/models/reports/edit-a-report.mdx b/models/reports/edit-a-report.mdx index 43580b9289..214faf9f98 100644 --- a/models/reports/edit-a-report.mdx +++ b/models/reports/edit-a-report.mdx @@ -33,7 +33,7 @@ pip install wandb wandb-workspaces Plots let you visualize run data inside a report. Each panel grid has a set of run sets and a set of panels. The run sets at the bottom of the section control what data appears on the panels in the grid. Create a new panel grid if you want to add charts that pull data from a different set of runs. - + Enter a forward slash (`/`) in the report to display a dropdown menu. Select **Add panel** to add a panel. You can add any panel that W&B supports, including a line plot, scatter plot, or parallel coordinates chart. @@ -79,7 +79,7 @@ For more information about available plots and charts you can add to a report pr 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**. W&B automatically imports 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. @@ -280,12 +280,12 @@ runset = wr.Runset( The name of the run is the name you specify in the `wandb.init(name=)` parameter. If you don't specify a name, W&B generates a random name for the run. -You can find the name of the run in the **Overview** page of a run in the W&B App or programmatically with `Api.runs().run.name`. +You can find the name of the run in the **Overview** page of a run in W&B or programmatically with `Api.runs().run.name`. ### Group runs by summary metrics -The following examples demonstrate how to group runs by summary metrics. Summary metrics are the values you log to a run with `wandb.Run.log()`. After you log a run, you can find the names of your summary metrics in the W&B App under the **Summary** section of a run's **Overview** page. +The following examples demonstrate how to group runs by summary metrics. Summary metrics are the values you log to a run with `wandb.Run.log()`. After you log a run, you can find the names of your summary metrics in W&B under the **Summary** section of a run's **Overview** page. The syntax for grouping runs by summary metrics is `summary.[KEY]`, where `[KEY]` is the name of the summary metric you want to group by. @@ -336,7 +336,7 @@ In this expression, `[KEY]` is the name of the filter, `operation` is a comparis | ---|---| --- | |`Config('[KEY]')` | Filter by config values | Values specified in `config` parameter in `wandb.init(config=)`. | |`SummaryMetric('[KEY]')` | Filter by summary metrics | Values you log to a run with `wandb.Run.log()`. | -|`Tags('[KEY]')` | Filter by tags | Tag values that you add to your run (programmatically or with the W&B App). | +|`Tags('[KEY]')` | Filter by tags | Tag values that you add to your run (programmatically or with W&B). | |`Metric('[KEY]')` | Filter by run properties | `tags`, `state`, `displayName`, `jobType` | After you define your filters, you can create a report and pass the filtered run sets to `wr.PanelGrid(runsets=)`. See the **Report and Workspace API** tabs throughout this page for more information about how to add various elements to a report programmatically. @@ -443,7 +443,7 @@ runset = wr.Runset( ``` -You can find the name of the run in the **Overview** page of a run in the W&B App or programmatically with `Api.runs().run.name`. +You can find the name of the run in the **Overview** page of a run in W&B or programmatically with `Api.runs().run.name`. The following examples demonstrate how to filter a runset by the run's state (`finished`, `crashed`, or `running`): @@ -467,7 +467,7 @@ runset = wr.Runset( ### SummaryMetric filters -The following examples demonstrate how to filter a run set by summary metrics. Summary metrics are the values you log to a run with `wandb.Run.log()`. After you log a run, you can find the names of your summary metrics in the W&B App under the **Summary** section of a run's **Overview** page. +The following examples demonstrate how to filter a run set by summary metrics. Summary metrics are the values you log to a run with `wandb.Run.log()`. After you log a run, you can find the names of your summary metrics in W&B under the **Summary** section of a run's **Overview** page. ```python runset = wr.Runset( @@ -487,7 +487,7 @@ runset = wr.Runset( ### Tags filters -The following code snippet shows how to filter a runs set by its tags. Tags are values you add to a run (programmatically or with the W&B App). +The following code snippet shows how to filter a runs set by its tags. Tags are values you add to a run (programmatically or with W&B). ```python runset = wr.Runset( diff --git a/models/runs.mdx b/models/runs.mdx index 73833fc386..5a28b329c6 100644 --- a/models/runs.mdx +++ b/models/runs.mdx @@ -29,12 +29,12 @@ If you do not specify a project name, W&B stores the run in a project called `Un Each run has a state that describes the current status of the run. See [Run states](/models/runs/run-states) for a full list of possible run states. -[View runs and their properties](/models/runs/view-logged-runs) within the run's project workspace on the W&B App. You can also programmatically access run properties with the [`wandb.Api.Run`](/models/ref/python/experiments/run) object. +[View runs and their properties](/models/runs/view-logged-runs) within the run's project workspace on W&B. You can also programmatically access run properties with the [`wandb.Api.Run`](/models/ref/python/experiments/run) object. As an example, consider the following code snippet that initializes a W&B run and logs some metrics to it: -Pass your W&B entity to the `entity` variable in the code snippets below if you want to follow along. Your entity is your W&B username or team name. You can find it in the URL of your W&B App workspace. For example, if your workspace URL is `https://wandb.ai/nico/awesome-project`, then your entity is `nico`. +Pass your W&B entity to the `entity` variable in the code snippets below if you want to follow along. Your entity is your W&B username or team name. You can find it in the URL of your W&B workspace. For example, if your workspace URL is `https://wandb.ai/nico/awesome-project`, then your entity is `nico`. ```python @@ -125,7 +125,7 @@ wandb: Find logs at: wandb/run-20241105_111816-pdo5110r/logs W&B captures the simulated training loop within a single run called `jolly-haze-4`. This is because the script calls `wandb.init()` method only once. -Copy and paste the URL that W&B prints from the previous output into your browser. The URL directs you to the run's workspace in the W&B App UI. For example, the following image shows the workspace for the run `jolly-haze-4`: +Copy and paste the URL that W&B prints from the previous output into your browser. The URL directs you to the run's workspace in W&B. For example, the following image shows the workspace for the run `jolly-haze-4`: Training run with logged metrics diff --git a/models/runs/compare-runs.mdx b/models/runs/compare-runs.mdx index 86f51e1be5..4c60cbac33 100644 --- a/models/runs/compare-runs.mdx +++ b/models/runs/compare-runs.mdx @@ -4,7 +4,7 @@ title: Pin and compare runs --- import PinRunsCondensed from '/snippets/_includes/pinned-and-baseline-runs/pin-runs-condensed.mdx'; -In a workspace with many runs, it can be difficult to keep track of your best performers, production models, failed experiments, or important reference points. The W&B App provides features to help organize and compare runs: +In a workspace with many runs, it can be difficult to keep track of your best performers, production models, failed experiments, or important reference points. W&B provides features to help organize and compare runs: - **Pinned runs**: Pin up to 6 runs to keep them visible in the workspace and at the top of the runs list. If you have a baseline run, you can pin up to 5 runs because the baseline is implicitly pinned. - **Baseline run**: Specify a baseline run as your reference point for comparisons. The baseline run is always visible in the workspace and at the top of the runs list. In the runs table, summary metric deltas show how each run compares to the baseline. In line plots, the baseline appears with visually distinct styling to help with comparison. diff --git a/models/runs/delete-runs.mdx b/models/runs/delete-runs.mdx index ba4c6f03c4..217b24b6d6 100644 --- a/models/runs/delete-runs.mdx +++ b/models/runs/delete-runs.mdx @@ -1,13 +1,13 @@ --- title: Delete runs -description: Delete runs from a W&B project using the W&B App or the Public API, and learn how deleted run data is removed from storage. +description: Delete runs from a W&B project using W&B or the Public API, and learn how deleted run data is removed from storage. --- ## Delete runs -Delete runs from a project with the W&B App or the Python API. +Delete runs from a project with W&B 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. @@ -81,5 +81,5 @@ Setting or changing `GORILLA_DATA_RETENTION_PERIOD` is irreversible for data pas Even after run or file deletion and retention processing, **bucket usage can lag** while background jobs catch up. W&B does not guarantee immediate reclamation of object storage. For a full overview of artifacts versus run data, timing expectations, and optional operator actions, see [Manage bucket storage and costs](/platform/hosting/managing-bucket-storage). -If deletions do not appear as expected in the W&B App when using the Public API, upgrade the W&B Python SDK to a current release and retry. +If deletions do not appear as expected in W&B when using the Public API, upgrade the W&B Python SDK to a current release and retry. diff --git a/models/runs/forking.mdx b/models/runs/forking.mdx index 23a8b9f195..fdfcb316d5 100644 --- a/models/runs/forking.mdx +++ b/models/runs/forking.mdx @@ -52,7 +52,7 @@ with wandb.init( ## Fork from a run in the same script -The following code snippet shows how to create a run and fork from that run within the same script. This might occur if you want to fork from a run that you just created without having to look up the run ID in the W&B App. +The following code snippet shows how to create a run and fork from that run within the same script. This might occur if you want to fork from a run that you just created without having to look up the run ID in W&B. First, initialize a run and log some data. Next, use the original run object's `id` property to obtain the run ID of that run. Finally, initialize a new run and pass the original run's ID and the step you want to fork from as arguments to `fork_from` in [`wandb.init()`](/models/ref/python/functions/init). diff --git a/models/runs/grouping.mdx b/models/runs/grouping.mdx index fe8e3d539f..541e80b343 100644 --- a/models/runs/grouping.mdx +++ b/models/runs/grouping.mdx @@ -14,7 +14,7 @@ Use `WANDB_RUN_GROUP` to specify a group for your runs as an environment variabl ## Organize runs into groups -You can add runs to a group programmatically using the W&B Python SDK or interactively in the W&B App. +You can add runs to a group programmatically using the W&B Python SDK or interactively in W&B. W&B stores group names as a run [`wandb.Run.group`](/models/ref/python/experiments/run#property-run-group) property. @@ -23,7 +23,7 @@ W&B stores group names as a run [`wandb.Run.group`](/models/ref/python/experimen -Programmatically add one or more runs to a group with the W&B Python SDK. Pass the name of your group as an argument to the `group` parameter when you initialize a run with `wandb.init(group="")`. You can use group names to organize and filter runs in the W&B App. +Programmatically add one or more runs to a group with the W&B Python SDK. Pass the name of your group as an argument to the `group` parameter when you initialize a run with `wandb.init(group="")`. You can use group names to organize and filter runs in W&B. The following example creates three groups named `A`, `B`, and `C`. Each group contains three runs. @@ -50,7 +50,7 @@ In the project's workspace, you can view runs organized by group. The following Runs table grouped by group name - + 1. Navigate to your W&B project. 2. Select the **Runs** tab from the project sidebar. @@ -64,7 +64,7 @@ In the project's workspace, you can view runs organized by group. The following ### View groups -View runs organized by group in the W&B App: +View runs organized by group in W&B: 1. In your project sidebar, select the **Runs** tab. 2. Above the list of runs, click the **Group** button. @@ -127,7 +127,7 @@ The following image shows runs organized by job type: ### View runs organized by job type -View runs organized by group in the W&B App: +View runs organized by group in W&B: 1. In your project sidebar, select the **Runs** tab. 2. Above the list of runs, click the **Group** button. diff --git a/models/runs/manage-runs.mdx b/models/runs/manage-runs.mdx index e01c4fb2eb..165ca81440 100644 --- a/models/runs/manage-runs.mdx +++ b/models/runs/manage-runs.mdx @@ -1,6 +1,6 @@ --- title: Move a run to a different project or team -description: Move runs between projects or teams using the W&B App. +description: Move runs between projects or teams using W&B. --- diff --git a/models/runs/rewind.mdx b/models/runs/rewind.mdx index 40938755e6..05294bfaab 100644 --- a/models/runs/rewind.mdx +++ b/models/runs/rewind.mdx @@ -93,7 +93,7 @@ The following image shows the updated project's workspace. Note the following ch ## View an archived run -After you rewind a run, you can explore the original archived run in the W&B App. Follow these steps to view an archived run: +After you rewind a run, you can explore the original archived run in W&B. Follow these steps to view an archived run: 1. **Access the Overview Tab:** Navigate to the [**Overview** tab](./#overview-tab) on the run's page. This tab provides a comprehensive view of the run's details and history. 2. **Locate the Forked From field:** Within the **Overview** tab, find the `Forked From` field. This field captures the history of the resumptions. The **Forked From** field includes a link to the source run, allowing you to trace back to the original run and understand the entire rewind history. diff --git a/models/runs/run-identifiers.mdx b/models/runs/run-identifiers.mdx index ed31442f5d..2e176e1f7c 100644 --- a/models/runs/run-identifiers.mdx +++ b/models/runs/run-identifiers.mdx @@ -11,7 +11,7 @@ A run's ID uniquely identifies the run. By default, W&B generates a [random and ### Find a run's ID -Find a run's unique ID programmatically with the W&B Python SDK or interactively in the W&B App. +Find a run's unique ID programmatically with the W&B Python SDK or interactively in W&B. @@ -36,10 +36,10 @@ wandb: 🚀 View run at https://wandb.ai/nico/awesome-project/runs/1jx1ud12 The last part of the run URL (`1jx1ud12`) is the unique run ID. - -You can also find a run's unique ID in the W&B App: + +You can also find a run's unique ID in W&B: -1. Navigate to the [W&B App](https://wandb.ai/home). +1. Navigate to [W&B](https://wandb.ai/home). 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. @@ -56,9 +56,9 @@ For example, in the following image, the unique run ID is `9mxi1arc`: -Use a run's unique ID to directly navigate to that run's overview page in the W&B App. The following code block shows the format of a URL path for a run: +Use a run's unique ID to directly navigate to that run's overview page in W&B. The following code block shows the format of a URL path for a run: -```text title="W&B App URL for a specific run" +```text title="W&B URL for a specific run" https://wandb.ai/// ``` @@ -101,7 +101,7 @@ with wandb.init(entity="", project="", name="") as r ### Rename a run -Rename a run after initializing it programmatically with the Python SDK or interactively in the W&B App. +Rename a run after initializing it programmatically with the Python SDK or interactively in W&B. @@ -125,7 +125,7 @@ run.update() - + 1. Navigate to your W&B project. 1. Select the **Workspace** or **Runs** tab. @@ -150,7 +150,7 @@ Use the run display name to override the run name displayed in that workspace wi ### Rename a run's display name -Change a run's display name from the W&B App: +Change a run's display name from W&B: 1. Navigate to your W&B project. 1. Select the **Workspace** or **Runs** tab. diff --git a/models/runs/run-states.mdx b/models/runs/run-states.mdx index 5a2fe46946..ceff648644 100644 --- a/models/runs/run-states.mdx +++ b/models/runs/run-states.mdx @@ -3,7 +3,7 @@ title: Run states description: Learn about the different states a W&B run can have. --- -The [Run state](/models/runs/run-states#run-states) indicates the current status of a W&B run. You can [view the state](/models/runs/run-states#view-the-state-of-a-run) of a run in the W&B App or programmatically using the W&B Python SDK. +The [Run state](/models/runs/run-states#run-states) indicates the current status of a W&B run. You can [view the state](/models/runs/run-states#view-the-state-of-a-run) of a run in W&B or programmatically using the W&B Python SDK. ## Run states The following table describes the possible states a run can be in: @@ -31,7 +31,7 @@ For a detailed explanation of how sweep and run statuses interact, see [Understa ## View the state of a run -Programmatically or interactively view a run's state with the Python SDK or W&B App. +Programmatically or interactively view a run's state with the Python SDK or W&B. @@ -57,9 +57,9 @@ for run in runs: You can apply different filters to retrieve runs from your projects based on different criteria. See [Filter runs](/models/runs/filter-runs) to learn more about filtering runs programmatically. - + -View the state of a run from the W&B App: +View the state of a run from W&B: 1. Navigate to your W&B project. 1. Select the **Workspace** or **Runs** tab from the project sidebar. diff --git a/models/runs/stop-runs.mdx b/models/runs/stop-runs.mdx index 55c9ee6ebf..4d4772b43e 100644 --- a/models/runs/stop-runs.mdx +++ b/models/runs/stop-runs.mdx @@ -1,9 +1,9 @@ --- title: Stop runs -description: Stop runs programmatically using the W&B Python SDK or manually from the W&B App. +description: Stop runs programmatically using the W&B Python SDK or manually from W&B. --- -Stop a run programmatically with the W&B Python SDK or interactively in the W&B App. +Stop a run programmatically with the W&B Python SDK or interactively in W&B. @@ -11,7 +11,7 @@ Stop a run programmatically with the W&B Python SDK or interactively in the W&B 2. Press `Ctrl+D` to stop the run. - + 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. diff --git a/models/runs/tags.mdx b/models/runs/tags.mdx index bca2fded3e..2ab915e598 100644 --- a/models/runs/tags.mdx +++ b/models/runs/tags.mdx @@ -1,6 +1,6 @@ --- title: Add labels to runs with tags -description: "Add, update, and remove tags on W&B runs using the Python SDK, Public API, or the W&B App UI for organization." +description: "Add, update, and remove tags on W&B runs using the Python SDK, Public API, or W&B for organization." --- Add tags to label runs with particular features that might not be obvious from the logged metrics or artifact data. @@ -75,7 +75,7 @@ This method is best suited to applying a tag or tags to a single run manually. ## Remove tags from one or more runs -Follow these steps to remove tags from a run in the W&B App. +Follow these steps to remove tags from a run in W&B. diff --git a/models/runs/view-logged-runs.mdx b/models/runs/view-logged-runs.mdx index fccffc738a..15cfc7ed64 100644 --- a/models/runs/view-logged-runs.mdx +++ b/models/runs/view-logged-runs.mdx @@ -1,16 +1,16 @@ --- title: View a specific run in a project -description: Learn how to view a specific logged run and its properties using the W&B App or the LEET terminal UI. +description: Learn how to view a specific logged run and its properties using W&B or the LEET terminal UI. --- -View information about a specific run, such as its current state, artifacts, metrics, and more. You can view and monitor runs using the W&B App or the `wandb beta leet` terminal UI. +View information about a specific run, such as its current state, artifacts, metrics, and more. You can view and monitor runs using W&B or the `wandb beta leet` terminal UI. -To view a specific run in the W&B App: +To view a specific run in W&B: -1. Navigate to the [W&B App](https://wandb.ai/home). +1. Navigate to [W&B](https://wandb.ai/home). 2. Navigate to the W&B project you specified when you initialized the run. 3. Within the project sidebar, select the **Workspace** tab. 4. Within the run selector, click the run you want to view, or enter a partial run name to filter for matching runs. @@ -71,12 +71,12 @@ See the [`wandb beta leet`](/models/ref/cli/wandb-beta/wandb-beta-leet) referenc ## Overview Use the **Overview** tab to learn about specific run information in a project, such as: -* **References**: Dictionary keys from your experiment's [config](/models/track/config) that you want to show prominently in the W&B App. See [Highlight config values](/models/track/config#highlight-config-values) for more details. -* **Notes**: Any notes you added to the run. You can add notes to a run with the W&B App or programmatically with the Python SDK. -* **Tags**: A list of strings. Tags are useful for organizing related runs together or applying temporary labels like `baseline` or `production`. You can add tags to a run with the W&B App or programmatically with the Python SDK. +* **References**: Dictionary keys from your experiment's [config](/models/track/config) that you want to show prominently in W&B. See [Highlight config values](/models/track/config#highlight-config-values) for more details. +* **Notes**: Any notes you added to the run. You can add notes to a run with W&B or programmatically with the Python SDK. +* **Tags**: A list of strings. Tags are useful for organizing related runs together or applying temporary labels like `baseline` or `production`. You can add tags to a run with W&B or programmatically with the Python SDK. * **Author**: The W&B entity that creates the run. * **Command**: The command that initializes the run. -* **Description**: A description of the run that you provided. This field is empty if you do not specify a description when you create the run. You can add a description to a run with the W&B App or programmatically with the Python SDK. +* **Description**: A description of the run that you provided. This field is empty if you do not specify a description when you create the run. You can add a description to a run with W&B or programmatically with the Python SDK. * **Tracked Hours**: The amount of time the run is actively computing or logging data, excluding any pauses or waiting periods. This metric helps you understand the actual computational time spent on your run. You are not billed for tracked hours, which are unlimited for all plans. * **Runtime**: Measures the total time from the start to the end of the run. It's the wall-clock time for the run, including any time where the run is paused or waiting for resources. This metric provides the complete elapsed time for your run. * **Git repository**: The git repository associated with the run. You must [enable git](/platform/app/settings-page/user-settings/#personal-github-integration) to view this field. diff --git a/models/sweeps/existing-project.mdx b/models/sweeps/existing-project.mdx index 3a1b4d8fe5..71600ac075 100644 --- a/models/sweeps/existing-project.mdx +++ b/models/sweeps/existing-project.mdx @@ -15,7 +15,7 @@ First, create a baseline. Download the PyTorch MNIST dataset example model from 2. Open this example `cd examples/pytorch/pytorch-cnn-fashion` 3. Run a run manually `python train.py` -Optionally explore the example appear in the W&B App UI dashboard. +Optionally explore the example appear in W&B dashboard. [View an example project page →](https://app.wandb.ai/carey/pytorch-cnn-fashion) diff --git a/models/sweeps/sweep-config-keys.mdx b/models/sweeps/sweep-config-keys.mdx index 7a943890b0..d05542129a 100644 --- a/models/sweeps/sweep-config-keys.mdx +++ b/models/sweeps/sweep-config-keys.mdx @@ -83,7 +83,7 @@ Iterate over every combination of hyperparameter values. Grid search makes uninf Grid search executes forever if it is searching within in a continuous search space. #### Random search -Choose a random, uninformed, set of hyperparameter values on each iteration based on a distribution. Random search runs forever unless you stop the process from the command line, within your python script, or [the W&B App](/models/sweeps/visualize-sweep-results/). +Choose a random, uninformed, set of hyperparameter values on each iteration based on a distribution. Random search runs forever unless you stop the process from the command line, within your python script, or [W&B](/models/sweeps/visualize-sweep-results/). Specify the distribution space with the metric key if you choose random (`method: random`) search. @@ -92,7 +92,7 @@ In contrast to [random](#random-search) and [grid](#grid-search) search, Bayesia {/* There are different Bayesian optimization methods. W&B uses a Gaussian process to model the relationship between hyperparameters and the model metric. For more information, see this paper. [LINK] */} -Bayesian search runs forever unless you stop the process from the command line, within your python script, or [the W&B App](/models/sweeps/visualize-sweep-results/). +Bayesian search runs forever unless you stop the process from the command line, within your python script, or [W&B](/models/sweeps/visualize-sweep-results/). ### Distribution options for random and Bayesian search Within the `parameter` key, nest the name of the hyperparameter. Next, specify the `distribution` key and specify a distribution for the value. diff --git a/models/sweeps/visualize-sweep-results.mdx b/models/sweeps/visualize-sweep-results.mdx index 531ade653a..2f35d1e1c9 100644 --- a/models/sweeps/visualize-sweep-results.mdx +++ b/models/sweeps/visualize-sweep-results.mdx @@ -1,9 +1,9 @@ --- -description: Visualize the results of your W&B Sweeps with the W&B App UI. +description: Visualize the results of your W&B Sweeps with W&B. title: Visualize sweep results --- -Visualize the results of your W&B Sweeps with the W&B App. Navigate to the [W&B App](https://wandb.ai/home). Choose the project that you specified when you initialized a sweep. You will be redirected to your project [workspace](/models/track/workspaces/). Select the **Sweep icon** in the project sidebar (broom icon). From the Sweep UI, select the name of your Sweep from the list. +Visualize the results of your W&B Sweeps with W&B. Navigate to [W&B](https://wandb.ai/home). Choose the project that you specified when you initialized a sweep. You will be redirected to your project [workspace](/models/track/workspaces/). Select the **Sweep icon** in the project sidebar (broom icon). From the Sweep UI, select the name of your Sweep from the list. The sweep list shows each sweep's state (**State**), creation time (**Created**), who started it (**Creator**), how many runs finished (**Run count**), and total **Compute time**. For a grid search over a discrete search space, W&B also shows **Est. Runs** (the expected number of runs). Open a sweep from the list to pause, resume, stop, or kill it from the app. For the same controls with the CLI, see [Manage sweeps](/models/sweeps/pause-resume-and-cancel-sweeps/). diff --git a/models/sweeps/walkthrough.mdx b/models/sweeps/walkthrough.mdx index 71074481f1..2b7eb13529 100644 --- a/models/sweeps/walkthrough.mdx +++ b/models/sweeps/walkthrough.mdx @@ -128,7 +128,7 @@ See [Python standard library `multiprocessing`](https://docs.python.org/3/librar ## Visualize results (optional) -Open your project to see your live results in the W&B App dashboard. With just a few clicks, construct rich, interactive charts like [parallel coordinates plots](/models/app/features/panels/parallel-coordinates/),[ parameter importance analyzes](/models/app/features/panels/parameter-importance/), and [additional chart types](/models/app/features/panels/). +Open your project to see your live results in the W&B dashboard. With just a few clicks, construct rich, interactive charts like [parallel coordinates plots](/models/app/features/panels/parallel-coordinates/),[ parameter importance analyzes](/models/app/features/panels/parameter-importance/), and [additional chart types](/models/app/features/panels/). Sweeps Dashboard example diff --git a/models/tables/log_tables.mdx b/models/tables/log_tables.mdx index 6f98eeb2df..1d7046ba95 100644 --- a/models/tables/log_tables.mdx +++ b/models/tables/log_tables.mdx @@ -41,7 +41,7 @@ with wandb.init(project="table-demo") as run: ## Logging modes -The [`wandb.Table`](/models/ref/python/data-types/table) `log_mode` parameter determines how a table is logged and updated during your ML experiments. The `log_mode` parameter accepts one of three arguments: `IMMUTABLE`, `MUTABLE`, and `INCREMENTAL`. Each mode has different implications for how a table is logged, how it can be modified, and how it is rendered in the W&B App. +The [`wandb.Table`](/models/ref/python/data-types/table) `log_mode` parameter determines how a table is logged and updated during your ML experiments. The `log_mode` parameter accepts one of three arguments: `IMMUTABLE`, `MUTABLE`, and `INCREMENTAL`. Each mode has different implications for how a table is logged, how it can be modified, and how it is rendered in W&B. The following describes the three logging modes, the high-level differences, and common use case for each mode: @@ -106,7 +106,7 @@ If you only want to add new batches of rows (no columns) incrementally like in a In incremental mode, you log batches of rows to a table during the machine learning experiment. This is ideal for monitoring long-running jobs or when working with large tables that would be inefficient to log during the run for updates. Within the UI, the table is updated with new rows as they are logged, allowing you to view the latest data without having to wait for the entire run to finish. You can also step through the increments to view the table at different points in time. -Run workspaces in the W&B App have a limit of 100 increments. If you log more than 100 increments, only the most recent 100 are shown in the run workspace. +Run workspaces in W&B have a limit of 100 increments. If you log more than 100 increments, only the most recent 100 are shown in the run workspace. The following example creates a table in `INCREMENTAL` mode, logs it, and then adds new rows to it. Note that the table is logged once per training step (`step`). @@ -141,7 +141,7 @@ with wandb.init(project="incremental-table-demo") as run: run.log({"training_table": table}, step=step) ``` -Incremental logging is generally more computationally efficient than logging a new table each time (`log_mode=MUTABLE`). However, the W&B App may not render all rows in the table if you log a large number of increments. If your goal is to update and view your table data while your run is ongoing and to have all the data available for analysis, consider using two tables. One with `INCREMENTAL` log mode and one with `IMMUTABLE` log mode. +Incremental logging is generally more computationally efficient than logging a new table each time (`log_mode=MUTABLE`). However, W&B may not render all rows in the table if you log a large number of increments. If your goal is to update and view your table data while your run is ongoing and to have all the data available for analysis, consider using two tables. One with `INCREMENTAL` log mode and one with `IMMUTABLE` log mode. The following example shows how to combine `INCREMENTAL` and `IMMUTABLE` logging modes to achieve this. @@ -173,7 +173,7 @@ with wandb.init(project="combined-logging-example") as run: run.log({"table": final_table}) ``` -In this example, the `incr_table` is logged incrementally (with `log_mode="INCREMENTAL"`) during training. This allows you to log and view updates to the table as new data is processed. At the end of training, an immutable table (`final_table`) is created with all data from the incremental table. The immutable table is logged to preserve the complete dataset for further analysis and it enables you to view all rows in the W&B App. +In this example, the `incr_table` is logged incrementally (with `log_mode="INCREMENTAL"`) during training. This allows you to log and view updates to the table as new data is processed. At the end of training, an immutable table (`final_table`) is created with all data from the incremental table. The immutable table is logged to preserve the complete dataset for further analysis and it enables you to view all rows in W&B. ## Examples diff --git a/models/tables/tables-walkthrough.mdx b/models/tables/tables-walkthrough.mdx index bd69cd5b27..6b6e4e1421 100644 --- a/models/tables/tables-walkthrough.mdx +++ b/models/tables/tables-walkthrough.mdx @@ -54,7 +54,7 @@ For more information on supported data types, see the [`wandb.Table`](/models/re View the resulting table in your workspace. -1. Navigate to your project in the W&B App. +1. Navigate to your project in W&B. 2. Select the name of your run in your project workspace. A new panel is added for each unique table key. diff --git a/models/tables/visualize-tables.mdx b/models/tables/visualize-tables.mdx index 038926ccc8..857759d4ae 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. Go to your project in W&B. 2. Select the artifacts icon in the project sidebar. 2. Select an artifact version. @@ -132,7 +132,7 @@ The following image shows a query panel with three W&B runs and the values they Step slider feature -Within the W&B App UI you may notice duplicate values for multiple steps. This duplication can occur if multiple runs log the same value at different steps, or if a run does not log values at every step. If a value is missing for a given step, W&B uses the last value that was logged as the slider key. +Within W&B you may notice duplicate values for multiple steps. This duplication can occur if multiple runs log the same value at different steps, or if a run does not log values at every step. If a value is missing for a given step, W&B uses the last value that was logged as the slider key. ### Custom step key diff --git a/models/track/config.mdx b/models/track/config.mdx index 9716b085f2..886825c45f 100644 --- a/models/track/config.mdx +++ b/models/track/config.mdx @@ -11,7 +11,7 @@ Use the `config` property of a run to save your training configuration: - input settings such as the dataset name or model type - any other independent variables for your experiments. -The `wandb.Run.config` property makes it easy to analyze your experiments and reproduce your work in the future. You can group by configuration values in the W&B App, compare the configurations of different W&B runs, and evaluate how each training configuration affects the output. The `config` property is a dictionary-like object that can be composed from multiple dictionary-like objects. +The `wandb.Run.config` property makes it easy to analyze your experiments and reproduce your work in the future. You can group by configuration values in W&B, compare the configurations of different W&B runs, and evaluate how each training configuration affects the output. The `config` property is a dictionary-like object that can be composed from multiple dictionary-like objects. To save output metrics or dependent variables like loss and accuracy, use `wandb.Run.log()` instead of `wandb.Run.config`. @@ -174,14 +174,14 @@ run.config.update({"lr": 0.1, "channels": 16}) ### Set the configuration after your Run has finished Use the [W&B Public API](/models/ref/python/public-api/) to update a completed run's config. -You must provide the API with your entity, project name and the run's ID. You can find these details in the Run object or in the [W&B App](/models/track/workspaces/): +You must provide the API with your entity, project name and the run's ID. You can find these details in the Run object or in [W&B](/models/track/workspaces/): ```python with wandb.init() as run: ... # Find the following values from the Run object if it was initiated from the -# current script or notebook, or you can copy them from the W&B App UI. +# current script or notebook, or you can copy them from W&B. username = run.entity project = run.project run_id = run.id diff --git a/models/track/create-an-experiment.mdx b/models/track/create-an-experiment.mdx index 73613fc3ce..aa336b2cc6 100644 --- a/models/track/create-an-experiment.mdx +++ b/models/track/create-an-experiment.mdx @@ -127,8 +127,8 @@ The following are some suggested guidelines to consider when you create experime ``` 2. **Config**: Track hyperparameters, architecture, dataset, and anything else you'd like to use to reproduce your model. These will show up in columns— use config columns to group, sort, and filter runs dynamically in the app. 3. **Project**: A project is a set of experiments you can compare together. Each project gets a dedicated dashboard page, and you can easily turn on and off different groups of runs to compare different model versions. -4. **Notes**: Set a quick commit message directly from your script. Edit and access notes in the Overview section of a run in the W&B App. -5. **Tags**: Identify baseline runs and favorite runs. You can filter runs using tags. You can edit tags at a later time on the Overview section of your project's dashboard on the W&B App. +4. **Notes**: Set a quick commit message directly from your script. Edit and access notes in the Overview section of a run in W&B. +5. **Tags**: Identify baseline runs and favorite runs. You can filter runs using tags. You can edit tags at a later time on the Overview section of your project's dashboard on W&B. 6. **Create multiple run sets to compare experiments**: When comparing experiments, create multiple run sets to make metrics easy to compare. You can toggle run sets on or off on the same chart or group of charts. The following code snippet demonstrates how to define a W&B Experiment using the best practices listed above: diff --git a/models/track/log/customize-logging-axes.mdx b/models/track/log/customize-logging-axes.mdx index f10cc783e3..6564d0281c 100644 --- a/models/track/log/customize-logging-axes.mdx +++ b/models/track/log/customize-logging-axes.mdx @@ -66,7 +66,7 @@ with wandb.init() as run: run.log(log_dict) ``` -The following image shows the resulting plot in the W&B App UI. The `validation_loss` metric is plotted against the custom x-axis `x_axis_squared`, which is the square of the for loop index `i`. Note that the x-axis values are `0, 1, 4, 9, 16, 25, 36, 49, 64, 81`, which correspond to the squares of `0, 1, 2, ..., 9` respectively. +The following image shows the resulting plot in W&B. The `validation_loss` metric is plotted against the custom x-axis `x_axis_squared`, which is the square of the for loop index `i`. Note that the x-axis values are `0, 1, 4, 9, 16, 25, 36, 49, 64, 81`, which correspond to the squares of `0, 1, 2, ..., 9` respectively. Line plot panel that uses a custom x axis. Values are logged to W&B as the square of the loop number. diff --git a/models/track/log/distributed-training.mdx b/models/track/log/distributed-training.mdx index 985ffcb006..e25d38cbea 100644 --- a/models/track/log/distributed-training.mdx +++ b/models/track/log/distributed-training.mdx @@ -7,7 +7,7 @@ During a distributed training experiment, you train a model using multiple machi * **Track a single process**: Track a rank 0 process (also known as a "leader" or "coordinator") with W&B. This is a common solution for logging distributed training experiments with the [PyTorch Distributed Data Parallel](https://pytorch.org/docs/stable/generated/torch.nn.parallel.DistributedDataParallel.html#torch.nn.parallel.DistributedDataParallel) (DDP) Class. * **Track multiple processes**: For multiple processes, you can either: - * Track each process separately using one run per process. You can optionally group them together in the W&B App UI. + * Track each process separately using one run per process. You can optionally group them together in W&B. * Track all processes to a single run. @@ -104,13 +104,13 @@ if __name__ == "__main__": run.finish() # mark the run as finished ``` -Explore the W&B App UI to view an [example dashboard](https://wandb.ai/ayush-thakur/DDP?workspace=user-noahluna) of metrics tracked from multiple processes. Note that there are two W&B Runs grouped together in the left sidebar. Click on a group to view the dedicated group page for the experiment. The dedicated group page displays metrics from each process separately. +Explore W&B to view an [example dashboard](https://wandb.ai/ayush-thakur/DDP?workspace=user-noahluna) of metrics tracked from multiple processes. Note that there are two W&B Runs grouped together in the left sidebar. Click on a group to view the dedicated group page for the experiment. The dedicated group page displays metrics from each process separately. Grouped distributed runs -The preceding image demonstrates the W&B App UI dashboard. On the sidebar we see two experiments. One labeled 'null' and a second (bound by a yellow box) called 'DPP'. If you expand the group (select the Group dropdown) you will see the W&B Runs that are associated to that experiment. +The preceding image demonstrates W&B dashboard. On the sidebar we see two experiments. One labeled 'null' and a second (bound by a yellow box) called 'DPP'. If you expand the group (select the Group dropdown) you will see the W&B Runs that are associated to that experiment. ### Organize distributed runs @@ -159,12 +159,12 @@ To track multiple processes to a single run, you must have: - W&B Server v0.68 or newer. -In this approach you use a primary node and one or more worker nodes. Within the primary node you initialize a W&B run. For each worker node, initialize a run using the run ID used by the primary node. During training each worker node logs to the same run ID as the primary node. W&B aggregates metrics from all nodes and displays them in the W&B App UI. +In this approach you use a primary node and one or more worker nodes. Within the primary node you initialize a W&B run. For each worker node, initialize a run using the run ID used by the primary node. During training each worker node logs to the same run ID as the primary node. W&B aggregates metrics from all nodes and displays them in W&B. Within the primary node, initialize a W&B run with [`wandb.init()`](/models/ref/python/functions/init). Pass in a `wandb.Settings` object to the `settings` parameter (`wandb.init(settings=wandb.Settings()`) with the following: 1. The `mode` parameter set to `"shared"` to enable shared mode. -2. A unique label for [`x_label`](https://github.com/wandb/wandb/blob/main/wandb/sdk/wandb_settings.py#L638). You use the value you specify for `x_label` to identify which node the data is coming from in logs and system metrics in the W&B App UI. If left unspecified, W&B creates a label for you using the hostname and a random hash. +2. A unique label for [`x_label`](https://github.com/wandb/wandb/blob/main/wandb/sdk/wandb_settings.py#L638). You use the value you specify for `x_label` to identify which node the data is coming from in logs and system metrics in W&B. If left unspecified, W&B creates a label for you using the hostname and a random hash. 3. Set the [`x_primary`](https://github.com/wandb/wandb/blob/main/wandb/sdk/wandb_settings.py#L660) parameter to `True` to indicate that this is the primary node. 4. Optionally provide a list of GPU indexes ([0,1,2]) to `x_stats_gpu_device_ids` to specify which GPUs W&B tracks metrics for. If you do not provide a list, W&B tracks metrics for all GPUs on the machine. @@ -177,7 +177,7 @@ Make note of the run ID of the primary node. Each worker node needs the run ID o For each worker node, initialize a W&B run with [`wandb.init()`](/models/ref/python/functions/init) and provide the following: 1. A `wandb.Settings` object to the `settings` parameter (`wandb.init(settings=wandb.Settings()`) with: * The `mode` parameter set to `"shared"` to enable shared mode. - * A unique label for `x_label`. You use the value you specify for `x_label` to identify which node the data is coming from in logs and system metrics in the W&B App UI. If left unspecified, W&B creates a label for you using the hostname and a random hash. + * A unique label for `x_label`. You use the value you specify for `x_label` to identify which node the data is coming from in logs and system metrics in W&B. If left unspecified, W&B creates a label for you using the hostname and a random hash. * Set the `x_primary` parameter to `False` to indicate that this is a worker node. 2. Pass the run ID used by the primary node to the `id` parameter. 3. Optionally set [`x_update_finish_state`](https://github.com/wandb/wandb/blob/main/wandb/sdk/wandb_settings.py#L772) to `False`. This prevents non-primary nodes from updating the [run's state](/models/runs/run-states#run-states) to `finished` prematurely, ensuring the run state remains consistent and managed by the primary node. @@ -249,7 +249,7 @@ You can filter console logs based on the labels you provide for `x_label` in the See [Console logs](/models/app/console-logs/) for more information. -W&B aggregates system metrics from all nodes and displays them in the W&B App UI. For example, the following image shows a sample dashboard with system metrics from multiple nodes. Each node possesses a unique label (`rank_0`, `rank_1`, `rank_2`) that you specify in the `x_label` parameter. +W&B aggregates system metrics from all nodes and displays them in W&B. For example, the following image shows a sample dashboard with system metrics from multiple nodes. Each node possesses a unique label (`rank_0`, `rank_1`, `rank_2`) that you specify in the `x_label` parameter. Multi-node system metrics diff --git a/models/track/log/log-models.mdx b/models/track/log/log-models.mdx index 326ce381ba..b1ef02e016 100644 --- a/models/track/log/log-models.mdx +++ b/models/track/log/log-models.mdx @@ -24,7 +24,7 @@ For more information on W&B Artifacts and advanced versioning use cases, see the ## Log a model to a run Use the [`log_model`](/models/ref/python/experiments/run#log_model) to log a model artifact that contains content within a directory you specify. The [`log_model`](/models/ref/python/experiments/run#log_model) method also marks the resulting model artifact as an output of the W&B run. -You can track a model's dependencies and the model's associations if you mark the model as the input or output of a W&B run. View the lineage of the model within the W&B App UI. See the [Explore and traverse artifact graphs](/models/artifacts/explore-and-traverse-an-artifact-graph/) page within the [Artifacts](/models/artifacts/) chapter for more information. +You can track a model's dependencies and the model's associations if you mark the model as the input or output of a W&B run. View the lineage of the model within W&B. See the [Explore and traverse artifact graphs](/models/artifacts/explore-and-traverse-an-artifact-graph/) page within the [Artifacts](/models/artifacts/) chapter for more information. Provide the path where your model files are saved to the `path` parameter. The path can be a local file, directory, or [reference URI](/models/artifacts/track-external-files/#amazon-s3--gcs--azure-blob-storage-references) to an external bucket such as `s3://bucket/path`. diff --git a/models/track/log/log-summary.mdx b/models/track/log/log-summary.mdx index 0617541c33..99f32a7329 100644 --- a/models/track/log/log-summary.mdx +++ b/models/track/log/log-summary.mdx @@ -77,7 +77,7 @@ View summary values in a run's **Overview** page or the project's runs table. -1. Navigate to the W&B App. +1. Navigate to W&B. 2. Select the **Workspace** tab from the project sidebar. 3. Click the run that logged the summary values. The run page opens with the **Overview** tab shown by default. 4. View the summary values in the **Summary** section. @@ -87,7 +87,7 @@ View summary values in a run's **Overview** page or the project's runs table. -1. Navigate to the W&B App. +1. Navigate to W&B. 2. Select the **Runs** tab. 3. Within the runs table, you can view the summary values within the columns based on the name of the summary value. diff --git a/models/track/project-page.mdx b/models/track/project-page.mdx index 9063c688f1..141c577f98 100644 --- a/models/track/project-page.mdx +++ b/models/track/project-page.mdx @@ -281,11 +281,11 @@ For example, the previous image shows different model artifact versions for a mo ## Create a project -You can create a project in the W&B App or programmatically by specifying a project in a call to `wandb.init()`. +You can create a project in W&B or programmatically by specifying a project in a call to `wandb.init()`. - -In the W&B App, you can create a project from the **Projects** page or from a team's landing page. + +In W&B, you can create a project from the **Projects** page or from a team's landing page. From the **Projects** page: 1. Click the global navigation icon in the upper left. The project sidebar opens. @@ -320,7 +320,7 @@ Refer to the [`wandb.init()` API reference](/models/ref/python/functions/init/#e ## Organization home and Recent Activity -In the W&B App, the organization home page summarizes recent work. +In W&B, the organization home page summarizes recent work. The **Recent Activity** viewer shows recent runs. Choose **Your projects** to see your own runs, or **Organization** to see recent runs by your colleagues. @@ -340,7 +340,7 @@ There are two ways to mark a project as important: within a project's overview t -1. Navigate to your W&B project on the W&B App at `https://wandb.ai//`. +1. Navigate to your W&B project on W&B at `https://wandb.ai//`. 2. Select the **Overview** tab from the project sidebar. 3. Click the star icon in the upper right corner next to the **Edit** button. diff --git a/platform/hosting/data-security/secure-storage-connector.mdx b/platform/hosting/data-security/secure-storage-connector.mdx index 1247096d30..0930da4ac5 100644 --- a/platform/hosting/data-security/secure-storage-connector.mdx +++ b/platform/hosting/data-security/secure-storage-connector.mdx @@ -87,12 +87,12 @@ After you [verify availability](#availability-matrix), you're ready to provision For details, see [Create a CoreWeave AI Object Storage bucket](https://docs.coreweave.com/docs/products/storage/object-storage/buckets/create-bucket) in the CoreWeave documentation. 1. **Multi-tenant Cloud**: Obtain your organization ID, which is required for your bucket policy. - 1. Log in to the [W&B App](https://wandb.ai/site). + 1. Log in to [W&B](https://wandb.ai/site). 1. In the left navigation, click **Create a new team**. 1. In the drawer that opens, copy the W&B organization ID, which appears above **Invite team members**. 1. Leave this page open. You use it to [configure W&B](#configure-byob). 1. **Dedicated Cloud** / **Self-Managed**: Obtain your customer namespace, which is required for your bucket policy. - 1. In the W&B App, click your user profile icon, then click **System Console**. + 1. In W&B, click your user profile icon, then click **System Console**. 1. Click the **Authentication** tab. 1. At the bottom of the page, copy the value for **Customer Namespace**. Keep this value for configuring the bucket policy. 1. You can close the System Console. @@ -472,7 +472,7 @@ For CoreWeave AI Object Storage at the instance level, contact [W&B support](mai For **Dedicated Cloud**: Share the bucket details with your W&B team, who configures your Dedicated Cloud instance. -For **Self-Managed**, you can configure instance level BYOB using the W&B App: +For **Self-Managed**, you can configure instance level BYOB using W&B: 1. Log in to W&B as a user with the `admin` role. 1. Click the user icon at the top, then click **System Console**. 1. Navigate to **Settings** > **System Connections**. @@ -486,7 +486,7 @@ After you save, W&B uses the configured bucket as the default storage destinatio ### Team level BYOB -You can configure team level BYOB when you create a team in the W&B App or using the [SCIM API](/platform/hosting/iam/scim#create-team) (POST Groups with optional `storageBucket`). You have two options: +You can configure team level BYOB when you create a team in W&B or using the [SCIM API](/platform/hosting/iam/scim#create-team) (POST Groups with optional `storageBucket`). You have two options: - **Use an existing bucket**: You must [determine the storage location](#determine-the-storage-address) for your bucket first. - **Create a new bucket** (Multi-tenant Cloud only): W&B can automatically create a bucket in your cloud provider when you create the team. W&B supports this for CoreWeave, AWS, and Google Cloud. diff --git a/platform/hosting/enterprise-licenses.mdx b/platform/hosting/enterprise-licenses.mdx index 52c5fa3713..313ae5306f 100644 --- a/platform/hosting/enterprise-licenses.mdx +++ b/platform/hosting/enterprise-licenses.mdx @@ -45,7 +45,7 @@ Request an Enterprise license: This section is relevant only for W&B Self-Managed. Dedicated Cloud deployments don't require manual configuration. -After you [obtain an Enterprise license](#obtain-an-enterprise-license), you can configure it programmatically as part of your deployment or in the W&B App after deployment. Select the tab that matches your deployment method. +After you [obtain an Enterprise license](#obtain-an-enterprise-license), you can configure it programmatically as part of your deployment or in W&B after deployment. Select the tab that matches your deployment method. @@ -77,7 +77,7 @@ After you [obtain an Enterprise license](#obtain-an-enterprise-license), you can terraform apply -var="license=$LICENSE_KEY" ``` - + For existing deployments without environment variable configuration: 1. Log in as an admin user. @@ -105,7 +105,7 @@ Next, [verify your Enterprise license](#verify-and-manage-an-enterprise-license) After you configure a license, verify that it's active and review its entitlements. As an instance or organization admin, follow these steps: -1. In the W&B App, click your user profile icon in the top right, then click **System Console**. +1. In W&B, click your user profile icon in the top right, then click **System Console**. 2. Go to the **License** tab. A dashboard summarizes the license entitlements, expiration, and usage over time. If you see an error, see [Common issues](#common-issues). 3. For detailed information about the license and its entitlements, click **View license online**. diff --git a/platform/hosting/iam/access-management/manage-organization.mdx b/platform/hosting/iam/access-management/manage-organization.mdx index 63781ab67a..fdc88a0089 100644 --- a/platform/hosting/iam/access-management/manage-organization.mdx +++ b/platform/hosting/iam/access-management/manage-organization.mdx @@ -142,7 +142,7 @@ This table summarizes the behavior of new and existing users with and without do | ----- | ----- | ----- | | New users | Users who sign up for W&B from verified domains are automatically added as members to your organization's default team. They can choose additional teams to join at sign up, if you enable team joining. They can still join other organizations and teams with an invitation. | Users can create W&B accounts without knowing a centralized organization is available. | | Invited users | Invited users automatically join your organization when accepting your invite. Invited users aren't automatically added as members to your organization's default team. They can still join other organizations and teams with an invitation. | Invited users automatically join your organization when accepting your invite. They can still join other organizations and teams with an invitation.| -| Existing users | Existing users with verified email addresses from your domains can join your organization's teams within the W&B App. All data that existing users create before joining your organization remains. W&B doesn't migrate the existing user's data. | Existing W&B users may be spread across multiple organizations and teams.| +| Existing users | Existing users with verified email addresses from your domains can join your organization's teams within W&B. All data that existing users create before joining your organization remains. W&B doesn't migrate the existing user's data. | Existing W&B users may be spread across multiple organizations and teams.| To automatically assign non-invited new users to a default team when they join your organization: diff --git a/platform/hosting/iam/identity_federation.mdx b/platform/hosting/iam/identity_federation.mdx index 16bd3a9aee..9a6da49baa 100644 --- a/platform/hosting/iam/identity_federation.mdx +++ b/platform/hosting/iam/identity_federation.mdx @@ -83,7 +83,7 @@ W&B recommends using a mix of built-in and external service accounts across your The value you enter for **Subject** must exactly match the `sub` (subject) claim in JWTs issued by your IdP for the service account. W&B applies the same comparison for every identity provider. The match is exact, case-sensitive, and whitespace-sensitive, so even a trailing space or a difference in capitalization causes authentication to fail. -The W&B App accepts any non-empty **Subject** without validating its value, since the value is entirely dependent on the IdP. W&B can't detect an incorrect value when you create the service account. Instead, authentication fails later, when the service account presents its JWT. +W&B accepts any non-empty **Subject** without validating its value, since the value is entirely dependent on the IdP. W&B can't detect an incorrect value when you create the service account. Instead, authentication fails later, when the service account presents its JWT. The most reliable way to determine the correct value is to read it from a real token. Obtain a sample JWT issued for the service account, base64url-decode its payload (the middle segment, between the two dots) locally, and copy the `sub` value verbatim into the **Subject** field. Don't paste JWTs into third-party online decoders, because a JWT is a credential. diff --git a/platform/hosting/iam/ldap.mdx b/platform/hosting/iam/ldap.mdx index 8c0bf820b6..5bb8abf0b8 100644 --- a/platform/hosting/iam/ldap.mdx +++ b/platform/hosting/iam/ldap.mdx @@ -4,7 +4,7 @@ description: "Configure LDAP-based SSO authentication for W&B Server including c keywords: ["Active Directory", "LDAP bind", "directory service", "distinguished name", "anonymous bind"] --- -This guide is for W&B Admins who enable LDAP-based single sign-on (SSO) for W&B Server, so that users can authenticate against an existing LDAP directory instead of managing separate W&B credentials. It explains how to configure the LDAP connection from the W&B App system settings UI or with environment variables. It also describes the required and optional configuration parameters, including the address, base distinguished name, and attributes. You can set up either an anonymous bind, or bind with an administrator DN and password. +This guide is for W&B Admins who enable LDAP-based single sign-on (SSO) for W&B Server, so that users can authenticate against an existing LDAP directory instead of managing separate W&B credentials. It explains how to configure the LDAP connection from the W&B system settings UI or with environment variables. It also describes the required and optional configuration parameters, including the address, base distinguished name, and attributes. You can set up either an anonymous bind, or bind with an administrator DN and password. {/* As a W&B Team Admin, you can set up either an anonymous bind, or bind with an administrator DN and password. @@ -16,13 +16,13 @@ Only W&B Admin roles can enable and configure LDAP authentication. ## Configure LDAP connection -Choose one of the following methods to configure the LDAP connection. Use the W&B App tab to configure LDAP through the system settings UI, or use the Environment variable tab to configure LDAP at deployment time. +Choose one of the following methods to configure the LDAP connection. Use the W&B tab to configure LDAP through the system settings UI, or use the Environment variable tab to configure LDAP at deployment time. - -To configure LDAP through the W&B App: + +To configure LDAP through W&B: -1. Go to the W&B App. +1. Go to W&B. 2. Select your profile icon, then select **System Settings**. 3. Toggle **Configure LDAP Client**. 4. Add the details in the form. For more information about each input, see [Configuration parameters](#configuration-parameters). diff --git a/platform/hosting/iam/scim.mdx b/platform/hosting/iam/scim.mdx index 0f5403cab2..c63fc4f500 100644 --- a/platform/hosting/iam/scim.mdx +++ b/platform/hosting/iam/scim.mdx @@ -10,7 +10,7 @@ Watch a [video demonstrating SCIM in action](https://www.youtube.com/watch?v=Nw3 ## Overview -This page describes how instance and organization admins use the System for Cross-domain Identity Management (SCIM) API to automate identity management in W&B. With the SCIM API, you can provision and deprovision users, manage team membership, and define custom roles programmatically through an identity provider or CI/CD pipeline instead of clicking through the W&B App. SCIM groups map to W&B Teams. +This page describes how instance and organization admins use the System for Cross-domain Identity Management (SCIM) API to automate identity management in W&B. With the SCIM API, you can provision and deprovision users, manage team membership, and define custom roles programmatically through an identity provider or CI/CD pipeline instead of clicking through W&B. SCIM groups map to W&B Teams. W&B's SCIM API is compatible with identity providers such as Okta. For SSO configuration with Okta and other identity providers, see the [SSO documentation](/platform/hosting/iam/sso/). @@ -186,7 +186,7 @@ The response includes details about the user's activity in the organization: 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 sign in, open any page in W&B, 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. @@ -271,7 +271,7 @@ The response includes details about each user's activity in the organization: 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 sign in, open any page in W&B, 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. @@ -434,7 +434,7 @@ Available in **Dedicated Cloud** and **Self-Managed** v0.81.0+ and in **Multi-te - Set `userName` to the service account name. The API uses `userName` for the account's display name. The `displayName` field in the request body is ignored. - `emails` aren't required for service accounts. - `modelsSeat` and `weaveRole` aren't supported on create and return `400 Bad Request` if present. -- Service accounts can't be updated with `PATCH` or `PUT`, can't be deactivated, and can't be assigned organization, team, or registry roles through SCIM. Create API keys in the W&B App after provisioning. +- Service accounts can't be updated with `PATCH` or `PUT`, can't be deactivated, and can't be assigned organization, team, or registry roles through SCIM. Create API keys in W&B after provisioning. #### Endpoint @@ -582,7 +582,7 @@ If the response returns one of the following errors, check the request for these Permanently deletes a service account and its organization membership. Use this endpoint when a service account is no longer needed (for example, after you retire an automation pipeline). This is a hard delete, and the account can't be reactivated through SCIM. -Available in **Dedicated Cloud** and **Self-Managed** v0.81.0+ and in **Multi-tenant Cloud**. Use the service account's SCIM user `id` from the provision response or from [Get user](#get-user). Deprovisioning doesn't delete API keys that were already issued. Revoke keys separately in the W&B App if needed. +Available in **Dedicated Cloud** and **Self-Managed** v0.81.0+ and in **Multi-tenant Cloud**. Use the service account's SCIM user `id` from the provision response or from [Get user](#get-user). Deprovisioning doesn't delete API keys that were already issued. Revoke keys separately in W&B if needed. #### Endpoint @@ -2081,7 +2081,7 @@ PATCH /scim/Groups/{team_id} ### Delete team -The SCIM API doesn't support deleting teams because additional data is linked to teams. Delete teams from the W&B App to confirm you want everything deleted. +The SCIM API doesn't support deleting teams because additional data is linked to teams. Delete teams from W&B to confirm you want everything deleted. ## Role resource diff --git a/platform/hosting/iam/sso.mdx b/platform/hosting/iam/sso.mdx index d074a65d3e..9c85aae1bd 100644 --- a/platform/hosting/iam/sso.mdx +++ b/platform/hosting/iam/sso.mdx @@ -231,7 +231,7 @@ To set up SSO, you must have administrator privileges and the following informat If your IdP requires an 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 in the following example. +- In W&B, go to **System Console** > **Settings** > **Advanced** > **User Spec** and add `GORILLA_OIDC_SECRET` to the `extraENV` section as shown in the following example. - In Helm, configure `values.global.extraEnv` as shown in the following example. ```yaml values: @@ -269,10 +269,10 @@ For detailed instructions on configuring CoreWeave storage with your Customer Na 1. Sign in to your W&B instance. -2. Navigate to the W&B App. +2. Navigate to W&B. - W&B App navigation + W&B navigation 3. From the dropdown, select **System Settings**: diff --git a/platform/hosting/managing-bucket-storage.mdx b/platform/hosting/managing-bucket-storage.mdx index 5f4d3aa65f..de97f85238 100644 --- a/platform/hosting/managing-bucket-storage.mdx +++ b/platform/hosting/managing-bucket-storage.mdx @@ -14,7 +14,7 @@ W&B stores several categories of data in your configured object storage. The [BY ## How W&B removes data from storage -Deletion in the W&B App or [Public API](/models/ref/python/public-api/api) updates W&B metadata first. Removing a run, artifact, or file from the product doesn't guarantee an immediate drop in reported bucket usage. Object storage cleanup runs as background work that can lag, especially on busy instances. +Deletion in W&B or [Public API](/models/ref/python/public-api/api) updates W&B metadata first. Removing a run, artifact, or file from the product doesn't guarantee an immediate drop in reported bucket usage. Object storage cleanup runs as background work that can lag, especially on busy instances. ### Artifacts @@ -36,7 +36,7 @@ This section describes the recommended order of operations for freeing space in Use supported product flows first: -- [Delete runs in the W&B App](/models/runs/delete-runs#ui) or [with Python](/models/runs/delete-runs#python) when you no longer need them. +- [Delete runs in W&B](/models/runs/delete-runs#ui) or [with Python](/models/runs/delete-runs#python) when you no longer need them. - [Delete artifacts](/models/artifacts/delete-artifacts) you no longer need, and use [Artifact TTL](/models/artifacts/ttl) where it fits your workflow. If you must reclaim space immediately, operators with access to the bucket may delete specific object keys directly in cloud storage. @@ -53,7 +53,7 @@ For high-level usage in W&B Multi-tenant Cloud, organization admins can review s ## Troubleshooting -If deletions don't appear correctly in the W&B App after you use the Public API, upgrade the W&B Python SDK to a current release and retry. Large per-run file counts can increase how long background cleanup takes across the instance. +If deletions don't appear correctly in W&B after you use the Public API, upgrade the W&B Python SDK to a current release and retry. Large per-run file counts can increase how long background cleanup takes across the instance. For scripted cleanup patterns that match your deployment, contact [W&B Support](mailto:support@wandb.ai) or your account team. diff --git a/platform/hosting/monitoring-usage/org_dashboard.mdx b/platform/hosting/monitoring-usage/org_dashboard.mdx index 4cb22fe031..5d54fb32eb 100644 --- a/platform/hosting/monitoring-usage/org_dashboard.mdx +++ b/platform/hosting/monitoring-usage/org_dashboard.mdx @@ -26,7 +26,7 @@ The following procedure shows how to open the dashboard that lists every user in A user is _active_ if they do any of the following: - Log in to W&B. -- Open any page in the W&B App. +- Open any page in W&B. - Log runs. - Use the SDK to track an experiment. - Interact with the W&B server in any way. @@ -60,7 +60,7 @@ To change the reporting period, use the drop-down above a plot. Options are **La Use the **Activity Dashboard** to view aggregate activity. -1. Click your user icon in the upper-right corner of the W&B App. +1. Click your user icon in the upper-right corner of W&B. 2. Under **Account**, click **Users**. 3. Above the table of users, review the Activity Panel: * **Active user count**: Unique active users during the selected period (defaults to 3 months). diff --git a/platform/hosting/self-managed/disable-automatic-app-version-updates.mdx b/platform/hosting/self-managed/disable-automatic-app-version-updates.mdx index f59d202eb3..af9a2cb80d 100644 --- a/platform/hosting/self-managed/disable-automatic-app-version-updates.mdx +++ b/platform/hosting/self-managed/disable-automatic-app-version-updates.mdx @@ -21,7 +21,7 @@ To verify that you meet these requirements, refer to the W&B Custom Resource or To disable automatic updates, use the System Console to pin W&B Server to a specific version, then check the Operator reconciliation logs to confirm that version pinning is active. -1. Log in to the W&B App as a user with the `admin` role. +1. Log in to W&B as a user with the `admin` role. 2. Click the user icon at the top, then click **System Console**. 3. Go to **Settings** > **Advanced**, then select the **Other** tab. 4. In the **Disable Auto Upgrades** section, turn on **Pin specific version**. diff --git a/platform/hosting/server-upgrade-process.mdx b/platform/hosting/server-upgrade-process.mdx index 444cae0ed7..f05d38f2e1 100644 --- a/platform/hosting/server-upgrade-process.mdx +++ b/platform/hosting/server-upgrade-process.mdx @@ -107,9 +107,9 @@ For more information, see the [upgrade guide](https://github.com/wandb/helm-char ## Update with admin UI -Use the admin UI to rotate your license key from within the W&B App, without changing your deployment configuration. This method only works for updating licenses that aren't set with an environment variable in the W&B server container, typically in self-managed Docker installations. This method updates the license only. It doesn't change the running W&B Server version. +Use the admin UI to rotate your license key from within W&B, without changing your deployment configuration. This method only works for updating licenses that aren't set with an environment variable in the W&B server container, typically in self-managed Docker installations. This method updates the license only. It doesn't change the running W&B Server version. 1. Obtain a new license from the [W&B Deployment Page](https://deploy.wandb.ai/), ensuring it matches the correct organization and deployment ID for the deployment you want to upgrade. -2. Access the **License** page in the W&B App. Click **Settings** > **License** or browse to `HOST_URL/console/settings/license`, where `HOST_URL` is your W&B Server host URL. +2. Access the **License** page in W&B. Click **Settings** > **License** or browse to `HOST_URL/console/settings/license`, where `HOST_URL` is your W&B Server host URL. 3. Navigate to the license management section. 4. Enter the new license key and save your changes. diff --git a/platform/launch/add-job-to-queue.mdx b/platform/launch/add-job-to-queue.mdx index 600f8061cc..356039a48a 100644 --- a/platform/launch/add-job-to-queue.mdx +++ b/platform/launch/add-job-to-queue.mdx @@ -11,11 +11,11 @@ Ensure that you, or someone on your team, already configured a launch queue. For ## Add jobs to your queue -Add jobs to your queue interactively with the W&B App or programmatically with the W&B CLI. +Add jobs to your queue interactively with W&B or programmatically with the W&B CLI. - -To add a job to your queue interactively with the W&B App: + +To add a job to your queue interactively with W&B: 1. Navigate to your W&B project page. 2. Select the **Jobs** icon in the project sidebar: diff --git a/platform/launch/launch-faq/dockerfile_let_wb_build_docker_image_me.mdx b/platform/launch/launch-faq/dockerfile_let_wb_build_docker_image_me.mdx index 82b1ff9389..1b1e18292f 100644 --- a/platform/launch/launch-faq/dockerfile_let_wb_build_docker_image_me.mdx +++ b/platform/launch/launch-faq/dockerfile_let_wb_build_docker_image_me.mdx @@ -12,7 +12,7 @@ After you configure the Dockerfile, specify it to W&B in one of the following wa * Use `Dockerfile.wandb` * Use W&B CLI -* Use W&B App +* Use W&B @@ -25,12 +25,12 @@ To queue a job, use the `--dockerfile` flag with the `wandb launch` command: wandb launch --dockerfile path/to/Dockerfile ``` - -When you add a job to a queue in the W&B App, provide the Dockerfile path in the **Overrides** section. Enter it as a key-value pair with `"dockerfile"` as the key and the path as the value. + +When you add a job to a queue in W&B, provide the Dockerfile path in the **Overrides** section. Enter it as a key-value pair with `"dockerfile"` as the key and the path as the value. The following JSON shows how to include a Dockerfile from a local directory: -```json title="Launch job W&B App" +```json title="Launch job W&B" { "args": [], "run_config": { diff --git a/platform/launch/launch-terminology.mdx b/platform/launch/launch-terminology.mdx index 2273613eea..d8011cbb5a 100644 --- a/platform/launch/launch-terminology.mdx +++ b/platform/launch/launch-terminology.mdx @@ -4,7 +4,7 @@ description: "Learn key W&B Launch concepts including jobs, queues, target resou keywords: ["launch glossary", "launch concepts", "queue definition", "agent concepts", "target resource"] --- -This page defines the core terms and concepts used throughout the W&B Launch documentation. Use it as a reference when you encounter unfamiliar terms in setup guides, tutorials, or the W&B App. +This page defines the core terms and concepts used throughout the W&B Launch documentation. Use it as a reference when you encounter unfamiliar terms in setup guides, tutorials, or W&B. With W&B Launch, you enqueue [jobs](#launch-job) onto [queues](#launch-queue) to create runs. Jobs are Python scripts instrumented with W&B. Queues hold a list of jobs to execute on a [target resource](#target-resources). [Agents](#launch-agent) pull jobs from queues and execute them on target resources. W&B tracks Launch jobs similarly to how it tracks [runs](/models/runs/). @@ -30,11 +30,11 @@ The three main kinds of job definitions are: Although Launch jobs can perform activities not related to model training (for example, deploying 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, you can configure jobs and send them to a [Launch queue](#launch-queue) to execute on different [target resources](#target-resources). +Find jobs you created in W&B under the **Jobs** tab of your project workspace. From there, you can configure jobs and send them to a [Launch queue](#launch-queue) to execute on different [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). No practical limit applies to the number of queues you can have, but a good guideline is one queue per target resource. You can enqueue jobs 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. +Launch *queues* are ordered lists of jobs to execute on a specific target resource. Launch queues are first-in, first-out (FIFO). No practical limit applies to the number of queues you can have, but a good guideline is one queue per target resource. You can enqueue jobs with W&B, 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. ## Target resources diff --git a/platform/launch/launch-view-jobs.mdx b/platform/launch/launch-view-jobs.mdx index 8ad448a3ad..fb81b6da0f 100644 --- a/platform/launch/launch-view-jobs.mdx +++ b/platform/launch/launch-view-jobs.mdx @@ -1,16 +1,16 @@ --- title: View launch jobs -description: "View launch job details, list available jobs, and check job statuses in the W&B App and CLI." +description: "View launch job details, list available jobs, and check job statuses in W&B and CLI." keywords: ["job status", "list jobs", "inspect job", "CLI job list"] --- -This page describes how to view information about launch jobs in queues. You can inspect job details in the W&B App, list jobs from the CLI, and interpret the status of a queued run. +This page describes how to view information about launch jobs in queues. You can inspect job details in W&B, list jobs from the CLI, and interpret the status of a queued run. ## View jobs -To view jobs in a queue, use the W&B App: +To view jobs in a queue, use W&B: -1. Navigate to the W&B App at https://wandb.ai/home. +1. Navigate to W&B at https://wandb.ai/home. 2. Select **Launch** in the **Applications** section of the left sidebar. 3. Select the **All entities** dropdown and select the entity the launch job belongs to. 4. Expand the collapsible UI from the Launch Application page to view a list of jobs added to that specific queue. @@ -26,7 +26,7 @@ For example, the following image shows two runs created from a job called `job-s Launch jobs status view -In the W&B App UI, you can find additional information about runs created from launch jobs, such as the: +In W&B, you can find additional information about runs created from launch jobs, such as the: - **Run**: The name of the W&B run assigned to that job. - **Job ID**: The name of the job. diff --git a/platform/launch/setup-launch-kubernetes.mdx b/platform/launch/setup-launch-kubernetes.mdx index 845534b4be..6415eaf7cc 100644 --- a/platform/launch/setup-launch-kubernetes.mdx +++ b/platform/launch/setup-launch-kubernetes.mdx @@ -99,7 +99,7 @@ spec: ## Create a queue -Create a queue in the W&B App that uses Kubernetes as its compute resource: +Create a queue in W&B that uses Kubernetes as its compute resource: 1. Navigate to the [Launch page](https://wandb.ai/launch). 2. Click the **Create Queue** button. diff --git a/platform/launch/setup-launch-sagemaker.mdx b/platform/launch/setup-launch-sagemaker.mdx index b5f061fe5a..0f651765d9 100644 --- a/platform/launch/setup-launch-sagemaker.mdx +++ b/platform/launch/setup-launch-sagemaker.mdx @@ -173,7 +173,7 @@ To create IAM roles, see the [AWS Identity and Access Management Documentation]( ## Configure the Launch queue for SageMaker -With the AWS prerequisites in place, you can create the W&B Launch queue that routes jobs to SageMaker. Create a queue in the W&B App that uses SageMaker as its compute resource: +With the AWS prerequisites in place, you can create the W&B Launch queue that routes jobs to SageMaker. Create a queue in W&B that uses SageMaker as its compute resource: 1. Navigate to the [Launch App](https://wandb.ai/launch). 2. Click **Create Queue**. diff --git a/platform/launch/setup-vertex.mdx b/platform/launch/setup-vertex.mdx index 2fa139a175..6879397e9b 100644 --- a/platform/launch/setup-vertex.mdx +++ b/platform/launch/setup-vertex.mdx @@ -43,7 +43,7 @@ For more information about available machine types and accelerator types, see th ## Create a queue -Now that you have planned your queue configuration, create a queue in the W&B App that uses Vertex AI as its compute resource: +Now that you have planned your queue configuration, create a queue in W&B that uses Vertex AI as its compute resource: 1. Navigate to the [Launch page](https://wandb.ai/launch). 2. Click the **Create Queue** button. diff --git a/platform/launch/sweeps-on-launch.mdx b/platform/launch/sweeps-on-launch.mdx index 4ff3d4c158..6c31f33072 100644 --- a/platform/launch/sweeps-on-launch.mdx +++ b/platform/launch/sweeps-on-launch.mdx @@ -21,7 +21,7 @@ We recommend you create a sweep on launch using the `basic` method if you're a f ## Create a sweep with a W&B standard scheduler -This section describes how to create W&B Sweeps with Launch using the standard scheduling engine. You can create a sweep interactively with the W&B App or programmatically with the W&B CLI. For advanced configurations of Launch sweeps, including the ability to customize the scheduler, use the CLI. +This section describes how to create W&B Sweeps with Launch using the standard scheduling engine. You can create a sweep interactively with W&B or programmatically with the W&B CLI. For advanced configurations of Launch sweeps, including the ability to customize the scheduler, use the CLI. Before you create a sweep with W&B Launch, ensure that you first create a job to sweep over. See the [Create a Job](/platform/launch/create-launch-job/) page for more information. @@ -29,9 +29,9 @@ Before you create a sweep with W&B Launch, ensure that you first create a job to -Create a sweep interactively with the W&B App. +Create a sweep interactively with W&B. -1. Navigate to your W&B project on the W&B App. +1. Navigate to your W&B project on W&B. 2. Select the sweeps icon in the project sidebar (broom image). 3. Select the **Create Sweep** button. 4. Click the **Configure Launch** button. @@ -222,7 +222,7 @@ Create a launch sweep using Optuna's scheduling logic with a job. If the initial sweep used a training job with an alias like `latest`, resuming can lead to different results if the latest job version has changed since the last run. - 1. Identify the sweep name/ID for a previously run launch sweep. The sweep ID is an eight-character string (for example, `hhd16935`) that you can find in your project on the W&B App. + 1. Identify the sweep name/ID for a previously run launch sweep. The sweep ID is an eight-character string (for example, `hhd16935`) that you can find in your project on W&B. 2. If you change the scheduler parameters, construct an updated config file. 3. In your terminal, execute the following command. Replace content wrapped in `[` and `]` with your information: diff --git a/release-notes/server-releases-archived.mdx b/release-notes/server-releases-archived.mdx index 963494cb83..5d783c4d1d 100644 --- a/release-notes/server-releases-archived.mdx +++ b/release-notes/server-releases-archived.mdx @@ -167,7 +167,7 @@ Private preview features are available by invitation only. To request enrollment - When you open a media panel in full screen mode, you can now use the left or right arrows on your keyboard to step through the images, *without* first clicking on the step slider. - Media panels now color run names, matching the run selector. This makes it easier to associate a run’s media values with related metrics and plots. - In the run selector, you can now filter by whether a run has certain media key or not. -- You can now move runs between groups in the W&B App UI, and you can create new groups after the run is logged. +- You can now move runs between groups in W&B, and you can create new groups after the run is logged. - Automations can now be edited in the UI - An automation can now notify a Slack channel for artifact events. When creating an automation, select “Slack notification” for the Action type. - Registry now supports global search by default, allowing you to search across all registries by registry name, collection name, alias, or tag. @@ -759,7 +759,7 @@ For Dedicated Cloud customers, this feature has been turned on. For Self-Manage Fixed issue where API keys were logged for recently logged in users. Check for `FetchAuthUserByAPIKey` in the logs which you can find in `gorilla.log` from a debug bundle and rotate any keys that are found. ## Features -- Launch agent logs are now available in the W&B App. +- Launch agent logs are now available in W&B. ![Image showing Launch agent logs in GUI](https://github.com/wandb/server/assets/97066933/9d68dc0d-54c9-4024-a108-ffb5a1500fa8) diff --git a/release-notes/server-releases.mdx b/release-notes/server-releases.mdx index 741a8caa2c..fa34acaa9c 100644 --- a/release-notes/server-releases.mdx +++ b/release-notes/server-releases.mdx @@ -107,7 +107,7 @@ W&B Server 0.81.0 makes debugging and comparing runs easier with deeper, searcha - Reduced the risk of deadlocks during artifact creation, deletion, and garbage collection. - Fixed a memory caching bug in the storage engine that could significantly under-report the actual heap retained by cache entries. - Fixed bugs where if the workspace or section's **Panel settings** configure a specific x-axis or step size, users could not override the settings for an individual panel. Instead, the workspace or section setting forced its value onto the panel. -- Improved the display of long aliases and tags in the W&B App. +- Improved the display of long aliases and tags in W&B. - Fixed a bug that caused jumbled characters to appear when filtering runs by regular expression. - Fixed an infinite loading page when opening a link to a nonexistent run group. - Fixed a bug where discarding a report draft would redirect to the list of reports instead of the source report. @@ -173,7 +173,7 @@ Refer to [Release policies and processes](/release-notes/release-policies). For ![Media panel compare mode grid](/images/release-notes/v0-80-0/media-compare-mode.png) -- The W&B App’s home page has been improved. +- W&B’s home page has been improved. - View, search, or filter recent activity, both your own and that of your colleagues. - Access recent reports directly in the home page. - Starred projects are no longer displayed on the home page, but appear at the top of the Projects page and in the left navigation. @@ -195,7 +195,7 @@ Refer to [Release policies and processes](/release-notes/release-policies). For - **Dim non-frontier points**: Optionally reduce the weight of non-frontier points. - You can now play audio in a table panel while it is downloading. - For manually-added custom panels, position overrides are now preserved across reloads. -- Access release notes for your deployment’s current version from within the W&B App. In the top navigation, click **?** to open the **Resources & Help** menu, then click **Release Notes**. +- Access release notes for your deployment’s current version from within W&B. In the top navigation, click **?** to open the **Resources & Help** menu, then click **Release Notes**. - Improved Lineage DAG navigation: you can now filter lineage by artifact type and upstream/downstream hops. Filtered or hidden nodes now remain visible as placeholders, which should make it easier to understand graph structure while iterating on filters. - When you share an artifact’s lineage view by URL, the recipient now sees the exact same graph configuration, including filters, hidden nodes, manual positions, viewports, and zoom levels. @@ -260,7 +260,7 @@ Refer to [Release policies and processes](/release-notes/release-policies). For ## Security - When creating a service account, you are now automatically guided to create an API key for it. -- Confirmation is now required to delete a service account or an API key from the W&B App. +- Confirmation is now required to delete a service account or an API key from W&B. - The backend now escapes column names in filters to help prevent SQL injection. - Email addresses that contain [diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks) are now blocked from user registration or login. @@ -484,7 +484,7 @@ Refer to [Release policies and processes](/release-notes/release-policies). For - When viewing an artifact version, you can now create a new registry and link the artifact version to it in a single operation. ### Weave -- Weave onboarding pages in the empty state in the W&B App now include TypeScript example code alongside the Python example code. +- Weave onboarding pages in the empty state in W&B now include TypeScript example code alongside the Python example code. - Weave call logs now support continuous scrolling by default. Previously, you could view only the most recent 10,000 lines of logs. - Bar charts and radar charts in the [Evaluation](/weave/guides/core-types/evaluations) comparison page now support resizing and displaying in full-screen view, and when you hover over an area of the chart, a tooltip displays details. - [Weave Playground](https://wandb.ai/site/playground/) includes new models: @@ -773,7 +773,7 @@ In v0.73.0, resizing or reordering workspace panels may not be reflected in save - Fixed a bug on mobile displays where scrolling could cause logged videos to automatically play in full screen. ## Other changes -- The custom grid layout was removed from W&B Workspaces with Server release v0.73.0. Previously, custom grid layout allowed you to adjust the size of individual panels within a section. Now, resizing a panel in a workspace section resizes all panels in that section, whether you configure the workspace using the [W&B App](/models/app/features/panels/#manage-a-sections-panels) or the [Workspace API](/models/ref/wandb_workspaces/workspaces#class-sectionlayoutsettings). Custom grid layout remains available in [W&B Reports](/models/reports) and the [Reports API](/models/ref/wandb_workspaces/reports). +- The custom grid layout was removed from W&B Workspaces with Server release v0.73.0. Previously, custom grid layout allowed you to adjust the size of individual panels within a section. Now, resizing a panel in a workspace section resizes all panels in that section, whether you configure the workspace using [W&B](/models/app/features/panels/#manage-a-sections-panels) or the [Workspace API](/models/ref/wandb_workspaces/workspaces#class-sectionlayoutsettings). Custom grid layout remains available in [W&B Reports](/models/reports) and the [Reports API](/models/ref/wandb_workspaces/reports). diff --git a/snippets/_includes/project-visibility-settings.mdx b/snippets/_includes/project-visibility-settings.mdx index 8225262c28..bdc14bdab3 100644 --- a/snippets/_includes/project-visibility-settings.mdx +++ b/snippets/_includes/project-visibility-settings.mdx @@ -1,4 +1,4 @@ -1. In the W&B App, from any page in the project, click **Overview** in the left navigation. +1. In W&B, from any page in the project, click **Overview** in the left navigation. 1. At the top right, click **Edit**. 1. Choose a new value for **Project visibility**: diff --git a/support/models/articles/how-can-i-change-the-privacy-of-my-proje.mdx b/support/models/articles/how-can-i-change-the-privacy-of-my-proje.mdx index 151df18b8d..b66895d6a0 100644 --- a/support/models/articles/how-can-i-change-the-privacy-of-my-proje.mdx +++ b/support/models/articles/how-can-i-change-the-privacy-of-my-proje.mdx @@ -5,7 +5,7 @@ keywords: ["Privacy", "Projects"] A project's privacy setting controls who can view, edit, or submit runs to the project. To change a project's privacy (visibility): -1. In the W&B App, from any page in the project, click **Overview** in the project sidebar. +1. In W&B, from any page in the project, click **Overview** in the project sidebar. 1. At the top right, click **Edit**. 1. Choose a new value for **Project visibility**: diff --git a/support/models/articles/how-can-i-recover-deleted-runs.mdx b/support/models/articles/how-can-i-recover-deleted-runs.mdx index 04341d41e7..837341b2a3 100644 --- a/support/models/articles/how-can-i-recover-deleted-runs.mdx +++ b/support/models/articles/how-can-i-recover-deleted-runs.mdx @@ -1,10 +1,10 @@ --- title: "How can I recover deleted runs?" keywords: ["Runs"] -description: "Learn how to recover recently deleted runs in the W&B App for up to 7 days." +description: "Learn how to recover recently deleted runs in W&B for up to 7 days." --- -If you accidentally delete a run, you can restore it from the W&B App so you don't lose your experiment history. To recover deleted runs: +If you accidentally delete a run, you can restore it from W&B so you don't lose your experiment history. To recover deleted runs: 1. Go to the **Project Overview** page. 2. Click the **action ()** menu in the top-right corner. diff --git a/support/models/articles/how-do-i-rerun-a-grid-search.mdx b/support/models/articles/how-do-i-rerun-a-grid-search.mdx index 6049156dd9..bc43b5446d 100644 --- a/support/models/articles/how-do-i-rerun-a-grid-search.mdx +++ b/support/models/articles/how-do-i-rerun-a-grid-search.mdx @@ -3,7 +3,7 @@ title: "How do I rerun a grid search?" keywords: ["Sweeps", "Hyperparameter", "Runs"] --- -If a grid search completes but some W&B Runs crashed, delete those runs to rerun them. Then select the **Resume** button on the [Sweep list in the W&B App](/models/sweeps/visualize-sweep-results). Start new W&B Sweep agents using the new sweep ID. +If a grid search completes but some W&B Runs crashed, delete those runs to rerun them. Then select the **Resume** button on the [Sweep list in W&B](/models/sweeps/visualize-sweep-results). Start new W&B Sweep agents using the new sweep ID. The sweep doesn't rerun parameter combinations that already completed. diff --git a/support/models/tags/runs.mdx b/support/models/tags/runs.mdx index c78bfbf35f..0168595592 100644 --- a/support/models/tags/runs.mdx +++ b/support/models/tags/runs.mdx @@ -33,7 +33,7 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" To add metrics to a run that has already finished, W&B offers several approaches depending on the complexity of your wor ... - Learn how to recover recently deleted runs in the W&B App for up to 7 days. + Learn how to recover recently deleted runs in W&B for up to 7 days. You can change the group assigned to a completed run using the API. This feature doesn't appear in the web UI. To update ...