-
Notifications
You must be signed in to change notification settings - Fork 52
docs: refer to the web app as "W&B" instead of "W&B App" #2737
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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. | ||||||
|
|
||||||
| <Note> | ||||||
| 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. | ||||||
| </Note> | ||||||
|
|
||||||
| {/* ## 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: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
I wonder if an agent could look for and fix similar redundancies. |
||||||
|
|
||||||
| 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: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| 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. | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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). | ||||||
|
|
||||||
| <Note> | ||||||
| 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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| </Note> | ||||||
|
|
||||||
| <Note> | ||||||
|
|
@@ -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. | ||||||
|
|
||||||
| <Tabs> | ||||||
| <Tab title="W&B App" value="ui"> | ||||||
| <Tab title="W&B" value="ui"> | ||||||
| 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 | ||||||
|
|
||||||
| <Tabs> | ||||||
| <Tab title="W&B App" value="ui"> | ||||||
| <Tab title="W&B" value="ui"> | ||||||
| To delete an artifact collection: | ||||||
|
|
||||||
| 1. Navigate to the artifact collection you want to delete. | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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. | ||||||
|
|
||||||
| <Note> | ||||||
| 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. | ||||||
|
|
||||||
| <Note> | ||||||
| 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. | ||||||
|
|
||||||
| <Warning> | ||||||
| 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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
The next paragraph may be redundant. |
||||||
|
|
||||||
| 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. | ||||||
| </Warning> | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Similar patterns may exist elsewhere |
||||||
|
|
||||||
| <Note> | ||||||
| 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. | ||||||
| </Note> | ||||||
| <Note> | ||||||
| * 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. | ||||||
| </Note> | ||||||
|
Comment on lines
13
to
19
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider rewriting to merge these notes or demoting one. |
||||||
|
|
||||||
| ## Auto-generated Artifacts | ||||||
|
|
@@ -93,7 +93,7 @@ with wandb.init(project="<my-project-name>", entity="<my-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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We may want to handle patterns like "W&B or the W&B Python SDK" differently in general, maybe something like "the W&B UI or SDK". WDYT? |
||||||
|
|
||||||
| <Note> | ||||||
| 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. | ||||||
| </Tab> | ||||||
| <Tab title="W&B App"> | ||||||
| 1. Navigate to your W&B project in the W&B App UI. | ||||||
| <Tab title="W&B"> | ||||||
| 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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ditto this pattern |
||||||
| {/* <Note> | ||||||
| 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. | ||||||
| </Note> */} | ||||||
|
|
@@ -193,8 +193,8 @@ artifact.ttl = None | |||||
| artifact.save() | ||||||
| ``` | ||||||
| </Tab> | ||||||
| <Tab title="W&B App"> | ||||||
| 1. Navigate to your W&B project in the W&B App UI. | ||||||
| <Tab title="W&B"> | ||||||
| 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. | ||||||
|
|
||||||
| <Tabs> | ||||||
| <Tab title="Python SDK"> | ||||||
|
|
@@ -225,10 +225,10 @@ artifact = run.use_artifact("<my-entity/my-project/my-artifact:alias>") | |||||
| print(artifact.ttl) | ||||||
| ``` | ||||||
| </Tab> | ||||||
| <Tab title="W&B App"> | ||||||
| View a TTL policy for an artifact with the W&B App UI. | ||||||
| <Tab title="W&B"> | ||||||
| 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. | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit but maybe rewrite this to avoid having "W&B" followed by "In W&B...."