From e84b2d186b983a45c939c4b016c477ed5d4e25ae Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 1 May 2026 00:26:42 +0000 Subject: [PATCH 1/2] Add SEO frontmatter descriptions to MDX pages Add or rewrite the description frontmatter for 261 hand-written documentation pages so each one has a unique 50-160 character summary suitable for search engines and link previews. Auto-generated reference pages (CLI, Python and TypeScript SDKs, query panel, support tag indexes) are intentionally excluded so the next generator run does not overwrite the new descriptions. Generated-By: mintlify-agent --- blog.mdx | 1 + courses.mdx | 1 + inference/ref-link-api.mdx | 1 + inference/support-inference.mdx | 1 + models/artifacts/artifacts-walkthrough.mdx | 3 +-- models/ref-link-cli.mdx | 1 + models/ref-link-public-api.mdx | 1 + models/ref-link-python.mdx | 1 + models/ref-link-query-panel.mdx | 1 + models/ref-link-workspaces.mdx | 1 + models/runs/delete-runs.mdx | 2 +- models/support-models.mdx | 1 + platform/hosting/managing-bucket-storage.mdx | 2 +- platform/hosting/monitoring-usage/mobile-app.mdx | 2 +- .../launch/launch-faq/best_practices_launch_effectively.mdx | 1 + platform/launch/launch-faq/build_container_launch.mdx | 1 + .../launch/launch-faq/clicking_launch_without_going_ui.mdx | 1 + platform/launch/launch-faq/control_push_queue.mdx | 1 + ...s_run_multiple_jobs_download_same_artifact_useartifact.mdx | 4 ++-- .../launch-faq/dockerfile_let_wb_build_docker_image_me.mdx | 1 + ...ly_provision_spin_compute_resources_target_environment.mdx | 4 ++-- platform/launch/launch-faq/launch_build_images.mdx | 1 + ...launch_d_wandb_job_create_image_uploading_whole_docker.mdx | 4 ++-- ...h_support_parallelization_limit_resources_consumed_job.mdx | 4 ++-- platform/launch/launch-faq/launch_tensorflow_gpu.mdx | 1 + platform/launch/launch-faq/launcherror_permission_denied.mdx | 1 + .../launch-faq/permissions_agent_require_kubernetes.mdx | 1 + .../launch/launch-faq/requirements_accelerator_base_image.mdx | 1 + platform/launch/launch-faq/restrict_access_modify_example.mdx | 1 + ...jobsautomations_instance_api_key_wish_directly_visible.mdx | 4 ++-- platform/launch/launch-library/launch.mdx | 1 + platform/launch/launch-library/launch_add.mdx | 1 + platform/launch/launch-library/launchagent.mdx | 1 + pricing.mdx | 1 + product-inference.mdx | 1 + product-models.mdx | 1 + product-sandboxes.mdx | 1 + product-training.mdx | 1 + product-weave.mdx | 1 + sandboxes.mdx | 1 + sandboxes/create-sandbox.mdx | 2 +- sandboxes/secrets.mdx | 2 +- security.mdx | 1 + support.mdx | 1 + .../articles/api-error-code-401-authentication-failed.mdx | 1 + .../articles/api-error-code-402-you-exceeded-your-cur.mdx | 1 + .../articles/api-error-code-403-country-region-or-ter.mdx | 1 + .../articles/api-error-code-403-the-inference-gateway.mdx | 1 + .../articles/api-error-code-429-concurrency-limit-rea.mdx | 1 + .../articles/api-error-code-500-the-server-had-an-err.mdx | 1 + .../articles/api-error-code-503-the-engine-is-current.mdx | 1 + .../models/articles/adding-multiple-authors-to-a-report.mdx | 1 + support/models/articles/anaconda-400-error-during-a-sweep.mdx | 1 + .../articles/best-practices-to-organize-hyperparamete.mdx | 1 + .../articles/can-i-get-an-academic-plan-as-a-student.mdx | 1 + .../articles/can-i-group-runs-without-using-the-group.mdx | 1 + .../articles/can-i-just-log-metrics-no-code-or-datase.mdx | 1 + .../articles/can-i-just-set-the-run-name-to-the-run-i.mdx | 1 + .../articles/can-i-log-metrics-on-two-different-time-.mdx | 1 + support/models/articles/can-i-rerun-a-grid-search.mdx | 1 + support/models/articles/can-i-run-wandb-offline.mdx | 1 + .../articles/can-i-turn-off-wandb-when-testing-my-cod.mdx | 1 + support/models/articles/can-i-use-markdown-in-my-reports.mdx | 1 + support/models/articles/can-i-use-sweeps-and-sagemaker.mdx | 1 + support/models/articles/can-wb-team-members-see-my-data.mdx | 1 + .../articles/can-we-flag-boolean-variables-as-hyperpa.mdx | 1 + support/models/articles/can-you-group-runs-by-tags.mdx | 1 + .../articles/can-you-use-wb-sweeps-with-cloud-infrast.mdx | 1 + .../articles/cannot-link-artifact-to-registry-from-p.mdx | 1 + .../articles/commerror-run-does-not-exist-during-swee.mdx | 1 + support/models/articles/cuda-out-of-memory-during-a-sweep.mdx | 1 + .../articles/do-environment-variables-overwrite-the-p.mdx | 1 + .../articles/do-i-need-to-provide-values-for-all-hype.mdx | 1 + .../articles/do-run-finished-alerts-work-in-notebooks.mdx | 1 + support/models/articles/do-you-have-a-bug-bounty-program.mdx | 1 + support/models/articles/does-logging-block-my-training.mdx | 1 + .../models/articles/does-the-wb-client-support-python-2.mdx | 1 + .../models/articles/does-the-wb-client-support-python-35.mdx | 1 + support/models/articles/does-this-only-work-for-python.mdx | 1 + .../models/articles/does-wb-support-sso-for-multi-tenant.mdx | 1 + .../articles/does-wb-use-the-multiprocessing-library.mdx | 1 + .../articles/does-your-tool-track-or-store-training-d.mdx | 1 + support/models/articles/embedding-reports.mdx | 1 + support/models/articles/enterprise-license-not-recognized.mdx | 1 + .../models/articles/filter-and-delete-unwanted-reports.mdx | 1 + .../articles/how-can-i-access-the-data-logged-to-my-r.mdx | 1 + support/models/articles/how-can-i-be-removed-from-a-team.mdx | 1 + .../articles/how-can-i-change-how-frequently-to-log-s.mdx | 1 + .../articles/how-can-i-change-my-account-from-corpora.mdx | 1 + .../articles/how-can-i-change-the-colors-of-each-run-.mdx | 1 + .../articles/how-can-i-change-the-directory-my-sweep-.mdx | 1 + .../articles/how-can-i-change-the-privacy-of-my-proje.mdx | 1 + .../articles/how-can-i-compare-images-or-media-across.mdx | 1 + .../articles/how-can-i-configure-the-name-of-the-run-.mdx | 1 + .../articles/how-can-i-define-the-local-location-for-.mdx | 1 + .../articles/how-can-i-delete-multiple-runs-in-bulk-i.mdx | 1 + support/models/articles/how-can-i-delete-my-user-account.mdx | 1 + .../articles/how-can-i-disable-logging-of-system-metr.mdx | 1 + .../articles/how-can-i-fetch-these-version-ids-and-et.mdx | 1 + .../articles/how-can-i-find-the-artifacts-logged-or-c.mdx | 1 + .../articles/how-can-i-fix-an-error-like-attributeerr.mdx | 1 + .../articles/how-can-i-log-a-metric-that-doesnt-chang.mdx | 1 + .../articles/how-can-i-log-additional-metrics-after-a.mdx | 1 + support/models/articles/how-can-i-log-in-to-wb-server.mdx | 1 + .../articles/how-can-i-organize-my-logged-charts-and-.mdx | 1 + .../articles/how-can-i-overwrite-the-logs-from-previo.mdx | 1 + .../articles/how-can-i-regain-access-to-my-account-if.mdx | 1 + .../articles/how-can-i-remove-projects-from-a-team-sp.mdx | 1 + .../articles/how-can-i-resolve-login-issues-with-my-a.mdx | 1 + .../articles/how-can-i-resolve-the-filestream-rate-li.mdx | 1 + .../articles/how-can-i-resume-a-sweep-using-python-co.mdx | 1 + support/models/articles/how-can-i-rotate-or-revoke-access.mdx | 1 + .../articles/how-can-i-save-the-git-commit-associated.mdx | 1 + .../articles/how-can-i-see-files-that-do-not-appear-i.mdx | 1 + .../articles/how-can-i-see-the-bytes-stored-bytes-tra.mdx | 1 + .../articles/how-can-i-send-run-alerts-to-microsoft-t.mdx | 1 + .../articles/how-can-i-use-wandb-with-multiprocessing.mdx | 1 + .../articles/how-do-i-add-plotly-or-bokeh-charts-into.mdx | 1 + .../articles/how-do-i-best-log-models-from-runs-in-a-.mdx | 1 + support/models/articles/how-do-i-cancel-my-subscription.mdx | 1 + .../models/articles/how-do-i-change-my-billing-address.mdx | 1 + support/models/articles/how-do-i-deal-with-network-issues.mdx | 1 + support/models/articles/how-do-i-delete-a-panel-grid.mdx | 1 + .../articles/how-do-i-delete-a-team-from-my-account.mdx | 1 + .../articles/how-do-i-delete-my-organization-account.mdx | 1 + .../articles/how-do-i-downgrade-my-subscription-plan.mdx | 1 + .../articles/how-do-i-enable-code-logging-with-sweeps.mdx | 1 + .../articles/how-do-i-export-a-list-of-users-from-my-.mdx | 1 + .../articles/how-do-i-find-an-artifact-from-the-best-.mdx | 1 + support/models/articles/how-do-i-find-my-api-key.mdx | 1 + .../articles/how-do-i-fix-invalid-authentication-401-.mdx | 1 + .../articles/how-do-i-fix-server-errors-500-503-with-.mdx | 1 + .../articles/how-do-i-fix-the-error-resumemust-but-ru.mdx | 1 + .../articles/how-do-i-fix-the-overflows-maximum-value.mdx | 1 + .../models/articles/how-do-i-get-added-to-a-team-on-wb.mdx | 1 + .../articles/how-do-i-get-the-random-run-name-in-my-s.mdx | 1 + .../articles/how-do-i-handle-the-failed-to-query-for-.mdx | 1 + support/models/articles/how-do-i-insert-a-table.mdx | 1 + .../articles/how-do-i-install-the-wandb-python-librar.mdx | 1 + support/models/articles/how-do-i-kill-a-job-with-wandb.mdx | 1 + .../articles/how-do-i-launch-multiple-runs-from-one-s.mdx | 1 + support/models/articles/how-do-i-log-a-list-of-values.mdx | 1 + .../articles/how-do-i-log-an-artifact-to-an-existing-.mdx | 1 + .../articles/how-do-i-log-runs-launched-by-continuous.mdx | 1 + .../articles/how-do-i-log-to-the-right-wandb-user-on-.mdx | 1 + .../articles/how-do-i-plot-multiple-lines-on-a-plot-w.mdx | 1 + .../articles/how-do-i-programmatically-access-the-hum.mdx | 1 + support/models/articles/how-do-i-rename-a-project.mdx | 1 + support/models/articles/how-do-i-renew-my-expired-license.mdx | 1 + .../articles/how-do-i-request-the-complete-deletion-o.mdx | 1 + .../articles/how-do-i-resolve-a-run-initialization-ti.mdx | 1 + .../articles/how-do-i-resolve-permission-errors-when-.mdx | 1 + support/models/articles/how-do-i-save-code.mdx | 1 + .../articles/how-do-i-set-a-retention-or-expiration-p.mdx | 1 + support/models/articles/how-do-i-silence-wb-info-messages.mdx | 1 + .../articles/how-do-i-stop-wandb-from-writing-to-my-t.mdx | 1 + .../articles/how-do-i-switch-between-accounts-on-the-.mdx | 1 + support/models/articles/how-do-i-turn-off-logging.mdx | 1 + .../articles/how-do-i-use-custom-cli-commands-with-sw.mdx | 1 + .../articles/how-do-i-use-the-resume-parameter-when-r.mdx | 1 + .../models/articles/how-do-we-update-our-payment-method.mdx | 1 + .../articles/how-do-you-delete-a-custom-chart-preset.mdx | 1 + .../articles/how-do-you-show-a-step-slider-in-a-custo.mdx | 1 + .../articles/how-does-someone-without-an-account-see-.mdx | 1 + .../articles/how-does-wandb-stream-logs-and-writes-to.mdx | 1 + .../models/articles/how-is-wb-different-from-tensorboard.mdx | 1 + .../articles/how-many-runs-can-i-create-per-project.mdx | 1 + .../articles/how-much-storage-does-each-artifact-vers.mdx | 1 + .../articles/how-often-are-system-metrics-collected.mdx | 1 + support/models/articles/how-should-i-run-sweeps-on-slurm.mdx | 1 + .../articles/how-to-get-multiple-charts-with-differen.mdx | 1 + .../articles/i-converted-my-report-to-wysiwyg-but-wan.mdx | 1 + .../articles/i-didnt-name-my-run-where-is-the-run-nam.mdx | 1 + .../articles/if-i-am-the-admin-of-my-local-instance-h.mdx | 1 + .../articles/if-wandb-crashes-will-it-possibly-crash-.mdx | 1 + support/models/articles/incorporating-latex.mdx | 1 + .../articles/initstarterror-error-communicating-with-.mdx | 1 + .../articles/is-it-possible-to-add-the-same-service-a.mdx | 1 + .../articles/is-it-possible-to-change-the-group-assig.mdx | 1 + .../models/articles/is-it-possible-to-change-the-username.mdx | 1 + .../articles/is-it-possible-to-create-a-new-account-w.mdx | 1 + .../articles/is-it-possible-to-move-a-run-from-one-pr.mdx | 1 + .../articles/is-it-possible-to-plot-the-max-of-a-metr.mdx | 1 + .../articles/is-it-possible-to-recover-an-artifact-af.mdx | 1 + .../articles/is-it-possible-to-save-metrics-offline-a.mdx | 1 + support/models/articles/is-there-a-dark-mode.mdx | 1 + .../articles/is-there-a-monthly-subscription-option-f.mdx | 1 + .../articles/is-there-a-way-to-add-extra-values-to-a-.mdx | 1 + support/models/articles/is-there-a-way-to-add-more-seats.mdx | 1 + support/models/articles/is-there-a-wb-outage.mdx | 1 + .../articles/is-there-an-anaconda-package-for-weights.mdx | 1 + .../articles/my-report-is-running-slowly-after-the-ch.mdx | 1 + .../articles/my-report-looks-different-after-converti.mdx | 1 + .../articles/my-runs-state-is-crashed-on-the-ui-but-i.mdx | 1 + .../articles/on-a-local-instance-which-files-should-i.mdx | 1 + support/models/articles/optimizing-multiple-metrics.mdx | 1 + .../articles/process-hangs-when-using-hydra-with-wan.mdx | 1 + .../models/articles/rate-limit-exceeded-on-metric-logging.mdx | 1 + support/models/articles/refreshing-data.mdx | 1 + .../articles/service-account-unauthorized-or-runs-no.mdx | 1 + .../articles/training-hangs-with-distributed-trainin.mdx | 1 + support/models/articles/upload-a-csv-to-a-report.mdx | 1 + support/models/articles/upload-an-image-to-a-report.mdx | 1 + .../articles/using-artifacts-with-multiple-architectu.mdx | 1 + .../articles/what-are-features-that-are-not-available.mdx | 1 + .../articles/what-are-the-best-practices-for-handling.mdx | 1 + .../articles/what-does-wandbinit-do-to-my-training-pr.mdx | 1 + .../articles/what-formula-do-you-use-for-your-smoothi.mdx | 1 + .../articles/what-happens-if-i-edit-my-python-files-w.mdx | 1 + .../articles/what-happens-if-i-pass-a-class-attribute.mdx | 1 + .../articles/what-happens-if-internet-connection-is-l.mdx | 1 + .../articles/what-happens-when-i-log-millions-of-step.mdx | 1 + .../articles/what-if-i-want-to-integrate-wb-into-my-p.mdx | 1 + .../articles/what-if-i-want-to-log-some-metrics-on-ba.mdx | 1 + .../articles/what-is-a-service-account-and-why-is-it-.mdx | 1 + .../articles/what-is-a-team-and-where-can-i-find-more.mdx | 1 + .../articles/what-is-the-difference-between-log-and-s.mdx | 1 + .../articles/what-is-the-difference-between-team-and-.mdx | 1 + .../articles/what-is-the-difference-between-team-and-_2.mdx | 1 + .../articles/what-is-the-difference-between-wandbinit.mdx | 1 + support/models/articles/what-is-the-est-runs-column.mdx | 1 + .../articles/what-really-good-functionalities-are-hid.mdx | 1 + .../articles/what-type-of-roles-are-available-and-wha.mdx | 1 + .../articles/when-should-i-log-to-my-personal-entity-.mdx | 1 + .../articles/where-are-artifacts-downloaded-and-how-c.mdx | 1 + .../articles/which-files-should-i-check-when-my-code-.mdx | 1 + .../articles/who-can-create-a-team-who-can-add-or-del.mdx | 1 + support/models/articles/who-can-edit-and-share-reports.mdx | 1 + support/models/articles/who-has-access-to-my-artifacts.mdx | 1 + .../articles/why-am-i-getting-insufficient-quota-erro.mdx | 1 + .../articles/why-am-i-getting-rate-limit-errors-429-w.mdx | 1 + .../articles/why-am-i-seeing-fewer-data-points-than-i.mdx | 1 + .../articles/why-are-steps-missing-from-a-csv-metric-.mdx | 1 + .../articles/why-cant-i-sort-or-filter-metrics-with-c.mdx | 1 + .../articles/why-does-the-storage-meter-not-update-af.mdx | 1 + .../articles/why-is-a-run-marked-crashed-in-wb-when-i.mdx | 1 + .../articles/why-is-nothing-showing-up-in-my-graphs.mdx | 1 + .../articles/why-is-the-same-metric-appearing-more-th.mdx | 1 + support/models/articles/will-wandb-slow-down-my-training.mdx | 1 + .../articles/workspace-loads-slowly-with-many-metric.mdx | 1 + .../articles/how-can-i-disable-client-information-cap.mdx | 1 + support/weave/articles/how-can-i-disable-code-capture.mdx | 1 + .../articles/how-can-i-disable-system-information-cap.mdx | 1 + support/weave/articles/how-do-i-render-markdown-in-the-ui.mdx | 1 + .../articles/how-do-i-render-python-datetime-values-i.mdx | 1 + .../weave/articles/how-is-weave-data-ingestion-calculated.mdx | 1 + support/weave/articles/long-eval-clean-up-times.mdx | 1 + support/weave/articles/os-errors-too-many-open-files.mdx | 1 + support/weave/articles/server-response-caching.mdx | 1 + support/weave/articles/trace-data-is-truncated.mdx | 1 + .../weave/articles/trace-data-loss-in-worker-processes.mdx | 1 + support/weave/articles/trace-pages-load-slowly.mdx | 1 + .../weave/articles/weave-call-does-not-raise-exceptions.mdx | 1 + .../articles/what-information-does-weave-capture-for.mdx | 1 + .../articles/what-is-pairwise-evaluation-and-how-do-i.mdx | 1 + .../articles/will-weave-affect-my-function-s-executio.mdx | 1 + training/ref-link-api.mdx | 1 + weave/details/support-weave.mdx | 1 + weave/ref-link-python.mdx | 1 + weave/ref-link-service-api.mdx | 1 + weave/ref-link-typescript.mdx | 1 + 261 files changed, 266 insertions(+), 17 deletions(-) diff --git a/blog.mdx b/blog.mdx index a9fc4170fa..7e9c4ab327 100644 --- a/blog.mdx +++ b/blog.mdx @@ -1,4 +1,5 @@ --- title: "W&B Tutorials & Blog" +description: "Browse W&B tutorials, articles, and guides on the Fully Connected blog covering ML experiment tracking, MLOps, and LLM workflows." url: "https://wandb.ai/fully-connected" --- \ No newline at end of file diff --git a/courses.mdx b/courses.mdx index eb3dd62fe6..5036808461 100644 --- a/courses.mdx +++ b/courses.mdx @@ -1,4 +1,5 @@ --- title: "W&B Courses" +description: "Take free W&B platform courses to learn experiment tracking, hyperparameter sweeps, model management, and LLM evaluations." url: "https://wandb.ai/site/courses/?e-filter-32fa548-course-category=wb-platform" --- \ No newline at end of file diff --git a/inference/ref-link-api.mdx b/inference/ref-link-api.mdx index 5afad2bf93..71c84701d2 100644 --- a/inference/ref-link-api.mdx +++ b/inference/ref-link-api.mdx @@ -1,4 +1,5 @@ --- title: "API Reference" +description: "Browse the W&B Inference API reference for the OpenAI-compatible chat completions endpoint and supported parameters." url: "/inference/api-reference" --- diff --git a/inference/support-inference.mdx b/inference/support-inference.mdx index 27d8aaaed6..938148d0b8 100644 --- a/inference/support-inference.mdx +++ b/inference/support-inference.mdx @@ -1,4 +1,5 @@ --- title: "Support: Inference" +description: "Browse W&B Inference support articles covering API errors, authentication, billing, rate limits, and troubleshooting." url: "/support/inference" --- \ No newline at end of file diff --git a/models/artifacts/artifacts-walkthrough.mdx b/models/artifacts/artifacts-walkthrough.mdx index 2744c1580c..b0e4e7dabd 100644 --- a/models/artifacts/artifacts-walkthrough.mdx +++ b/models/artifacts/artifacts-walkthrough.mdx @@ -1,6 +1,5 @@ --- -description: - Create, track, and use a dataset artifact with W&B. +description: "Follow this tutorial to create, track, and use a dataset artifact in W&B and learn artifact versioning fundamentals." title: "Tutorial: Create, track, and use a dataset artifact" --- diff --git a/models/ref-link-cli.mdx b/models/ref-link-cli.mdx index f4b501e62b..057323f760 100644 --- a/models/ref-link-cli.mdx +++ b/models/ref-link-cli.mdx @@ -1,4 +1,5 @@ --- title: "CLI" +description: "Browse the W&B Command Line Interface (CLI) reference for logging in, running jobs, executing sweeps, and more." url: "/models/ref/cli" --- diff --git a/models/ref-link-public-api.mdx b/models/ref-link-public-api.mdx index 724d503330..1f88af6830 100644 --- a/models/ref-link-public-api.mdx +++ b/models/ref-link-public-api.mdx @@ -1,4 +1,5 @@ --- title: "Public API" +description: "Browse the W&B Public API Python reference for querying runs, projects, artifacts, reports, and other resources programmatically." url: "/models/ref/python/public-api" --- diff --git a/models/ref-link-python.mdx b/models/ref-link-python.mdx index e7c4840684..bc7f3bfa56 100644 --- a/models/ref-link-python.mdx +++ b/models/ref-link-python.mdx @@ -1,4 +1,5 @@ --- title: "Python SDK" +description: "Browse the W&B Python SDK API reference including installation, classes, functions, and data types." url: "/models/ref/python" --- diff --git a/models/ref-link-query-panel.mdx b/models/ref-link-query-panel.mdx index 570f1b9fde..27fe3c4110 100644 --- a/models/ref-link-query-panel.mdx +++ b/models/ref-link-query-panel.mdx @@ -1,4 +1,5 @@ --- title: "Query Expression Language" +description: "Browse the W&B Query Expression Language reference for selecting and aggregating data in custom panels." url: "/models/ref/query-panel" --- diff --git a/models/ref-link-workspaces.mdx b/models/ref-link-workspaces.mdx index 8118fa4880..ecd7d0995e 100644 --- a/models/ref-link-workspaces.mdx +++ b/models/ref-link-workspaces.mdx @@ -1,4 +1,5 @@ --- title: "Reports and Workspaces API" +description: "Browse the Reports and Workspaces API reference for creating and managing reports and workspaces programmatically." url: "/models/ref/wandb_workspaces/reports" --- diff --git a/models/runs/delete-runs.mdx b/models/runs/delete-runs.mdx index e496ad67c8..9ca07a6529 100644 --- a/models/runs/delete-runs.mdx +++ b/models/runs/delete-runs.mdx @@ -1,6 +1,6 @@ --- 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 on Dedicated Cloud and Self-Managed deployments. +description: "Delete W&B runs through the W&B App or Public API, and learn how deleted run data is removed from storage on Dedicated Cloud and Self-Managed deployments." --- ## Delete runs diff --git a/models/support-models.mdx b/models/support-models.mdx index 1b2930bb70..1fb1b4ac53 100644 --- a/models/support-models.mdx +++ b/models/support-models.mdx @@ -1,4 +1,5 @@ --- title: "Support: Models" +description: "Browse W&B Models support articles covering experiments, sweeps, artifacts, reports, billing, and account management." url: "/support/models" --- \ No newline at end of file diff --git a/platform/hosting/managing-bucket-storage.mdx b/platform/hosting/managing-bucket-storage.mdx index a43cd9871b..1a6681b2c6 100644 --- a/platform/hosting/managing-bucket-storage.mdx +++ b/platform/hosting/managing-bucket-storage.mdx @@ -1,6 +1,6 @@ --- title: Manage bucket storage and costs -description: Understand how W&B uses object storage, how deletion maps to bucket bytes, and how to reduce usage on self-managed, Dedicated Cloud, and bring-your-own-bucket deployments. +description: "How W&B uses object storage, how deletion maps to bucket bytes, and how to reduce usage on self-managed, Dedicated Cloud, and BYOB deployments." --- When you use [Bring your own bucket (BYOB)](/platform/hosting/data-security/secure-storage-connector), [W&B Dedicated Cloud](/platform/hosting/hosting-options/dedicated-cloud), or [W&B Self-Managed](/platform/hosting/hosting-options/self-managed), your team often pays cloud storage providers directly. This page explains what occupies your bucket, how W&B removes objects after deletion in the app or API, and what you should expect in practice. diff --git a/platform/hosting/monitoring-usage/mobile-app.mdx b/platform/hosting/monitoring-usage/mobile-app.mdx index 5143117cf0..7e52e9805b 100644 --- a/platform/hosting/monitoring-usage/mobile-app.mdx +++ b/platform/hosting/monitoring-usage/mobile-app.mdx @@ -1,6 +1,6 @@ --- title: W&B Mobile App (iOS) -description: From your iPhone or iPad, track training runs, review console logs, view line plots, search project panels with regular expressions, and explore your W&B Models projects. +description: "Track training runs, review console logs, view line plots, search projects with regex, and explore W&B Models projects from your iPhone or iPad." --- diff --git a/platform/launch/launch-faq/best_practices_launch_effectively.mdx b/platform/launch/launch-faq/best_practices_launch_effectively.mdx index 9faf122276..de237c06aa 100644 --- a/platform/launch/launch-faq/best_practices_launch_effectively.mdx +++ b/platform/launch/launch-faq/best_practices_launch_effectively.mdx @@ -1,5 +1,6 @@ --- title: Are there best practices for using Launch effectively? +description: "Best practices for using W&B Launch effectively, including queue setup, service accounts, and managing hyperparameters." --- 1. Create the queue before starting the agent to enable easy configuration. Failure to do this results in errors that prevent the agent from functioning until a queue is added. diff --git a/platform/launch/launch-faq/build_container_launch.mdx b/platform/launch/launch-faq/build_container_launch.mdx index dff2755ff0..46e31f4002 100644 --- a/platform/launch/launch-faq/build_container_launch.mdx +++ b/platform/launch/launch-faq/build_container_launch.mdx @@ -1,5 +1,6 @@ --- title: I do not want W&B to build a container for me, can I still use Launch? +description: "Use a pre-built Docker image with W&B Launch instead of letting Launch build a container for you." --- To launch a pre-built Docker image, execute the following command. Replace the placeholders in the `<>` with your specific information: diff --git a/platform/launch/launch-faq/clicking_launch_without_going_ui.mdx b/platform/launch/launch-faq/clicking_launch_without_going_ui.mdx index f21846851f..91b276a12d 100644 --- a/platform/launch/launch-faq/clicking_launch_without_going_ui.mdx +++ b/platform/launch/launch-faq/clicking_launch_without_going_ui.mdx @@ -1,5 +1,6 @@ --- title: I do not like clicking- can I use Launch without going through the UI? +description: "Use the W&B Launch CLI subcommand to launch and manage jobs without using the W&B App UI." --- Yes. The standard `wandb` CLI includes a `launch` subcommand to launch jobs. For more information, run: diff --git a/platform/launch/launch-faq/control_push_queue.mdx b/platform/launch/launch-faq/control_push_queue.mdx index 4dc9bb015c..c87554d1a7 100644 --- a/platform/launch/launch-faq/control_push_queue.mdx +++ b/platform/launch/launch-faq/control_push_queue.mdx @@ -1,5 +1,6 @@ --- title: How do I control who can push to a queue? +description: "Restrict who can push to a W&B Launch queue by managing membership of the queue's owning team." --- Queues are specific to a user team. Define the owning entity during queue creation. To restrict access, modify team membership. \ No newline at end of file diff --git a/platform/launch/launch-faq/docker_queues_run_multiple_jobs_download_same_artifact_useartifact.mdx b/platform/launch/launch-faq/docker_queues_run_multiple_jobs_download_same_artifact_useartifact.mdx index 8e7a7a5fa7..5c2a5ae715 100644 --- a/platform/launch/launch-faq/docker_queues_run_multiple_jobs_download_same_artifact_useartifact.mdx +++ b/platform/launch/launch-faq/docker_queues_run_multiple_jobs_download_same_artifact_useartifact.mdx @@ -1,6 +1,6 @@ --- -title: When multiple jobs in a Docker queue download the same artifact, is any caching - used, or is it re-downloaded every run? +title: "When multiple jobs in a Docker queue download the same artifact, is any caching used, or is it re-downloaded every run?" +description: "Configure shared artifact caching for Docker Launch queues to avoid redundant downloads across parallel jobs." --- No caching exists. Each launch job operates independently. Configure the queue or agent to mount a shared cache using Docker arguments in the queue configuration. 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 31ea65d697..dde6cc9af8 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 @@ -1,5 +1,6 @@ --- title: Can I specify a Dockerfile and let W&B build a Docker image for me? +description: "Specify a Dockerfile so W&B Launch builds the Docker image for you, useful for stable requirements with changing code." --- This feature suits projects with stable requirements but frequently changing codebases. diff --git a/platform/launch/launch-faq/launch_automatically_provision_spin_compute_resources_target_environment.mdx b/platform/launch/launch-faq/launch_automatically_provision_spin_compute_resources_target_environment.mdx index 34a1f73664..3af6ac1311 100644 --- a/platform/launch/launch-faq/launch_automatically_provision_spin_compute_resources_target_environment.mdx +++ b/platform/launch/launch-faq/launch_automatically_provision_spin_compute_resources_target_environment.mdx @@ -1,6 +1,6 @@ --- -title: Can Launch automatically provision (and spin down) compute resources for me - in the target environment? +title: "Can Launch automatically provision (and spin down) compute resources for me in the target environment?" +description: "Whether W&B Launch can automatically provision and tear down compute resources in SageMaker, Vertex, and Kubernetes." --- This process depends on the environment. Resources provision in Amazon SageMaker and Vertex. In Kubernetes, autoscalers automatically adjust resources based on demand. Solution Architects at W&B assist in configuring Kubernetes infrastructure to enable retries, autoscaling, and the use of spot instance node pools. For support, contact support@wandb.com or use your shared Slack channel. \ No newline at end of file diff --git a/platform/launch/launch-faq/launch_build_images.mdx b/platform/launch/launch-faq/launch_build_images.mdx index 364ff052a1..727dffecd4 100644 --- a/platform/launch/launch-faq/launch_build_images.mdx +++ b/platform/launch/launch-faq/launch_build_images.mdx @@ -1,5 +1,6 @@ --- title: How does W&B Launch build images? +description: "How W&B Launch builds container images based on the job source, accelerator base image, and queue configuration." --- The steps for building an image depend on the job source and the specified accelerator base image in the resource configuration. diff --git a/platform/launch/launch-faq/launch_d_wandb_job_create_image_uploading_whole_docker.mdx b/platform/launch/launch-faq/launch_d_wandb_job_create_image_uploading_whole_docker.mdx index e498659178..bfc61129ee 100644 --- a/platform/launch/launch-faq/launch_d_wandb_job_create_image_uploading_whole_docker.mdx +++ b/platform/launch/launch-faq/launch_d_wandb_job_create_image_uploading_whole_docker.mdx @@ -1,6 +1,6 @@ --- -title: Is `wandb launch -d` or `wandb job create image` uploading a whole docker artifact - and not pulling from a registry? +title: "Is `wandb launch -d` or `wandb job create image` uploading a whole docker artifact and not pulling from a registry?" +description: "Whether `wandb launch -d` and `wandb job create image` upload Docker artifacts, and how to push images to a registry." --- No, the `wandb launch -d` command does not upload images to a registry. Upload images to a registry separately. Follow these steps: diff --git a/platform/launch/launch-faq/launch_support_parallelization_limit_resources_consumed_job.mdx b/platform/launch/launch-faq/launch_support_parallelization_limit_resources_consumed_job.mdx index 9547de4ac5..a559350494 100644 --- a/platform/launch/launch-faq/launch_support_parallelization_limit_resources_consumed_job.mdx +++ b/platform/launch/launch-faq/launch_support_parallelization_limit_resources_consumed_job.mdx @@ -1,6 +1,6 @@ --- -title: Does Launch support parallelization? How can I limit the resources consumed - by a job? +title: "Does Launch support parallelization? How can I limit the resources consumed by a job?" +description: "How W&B Launch supports parallelization across GPUs and nodes, and how to limit resources consumed per job." --- Launch supports scaling jobs across multiple GPUs and nodes. Refer to the [Volcano integration guide](/models/integrations) for details. diff --git a/platform/launch/launch-faq/launch_tensorflow_gpu.mdx b/platform/launch/launch-faq/launch_tensorflow_gpu.mdx index 2eb0a48884..354b5070ff 100644 --- a/platform/launch/launch-faq/launch_tensorflow_gpu.mdx +++ b/platform/launch/launch-faq/launch_tensorflow_gpu.mdx @@ -1,5 +1,6 @@ --- title: How do I make W&B Launch work with Tensorflow on GPU? +description: "Configure a custom accelerator base image so W&B Launch jobs run TensorFlow with GPU support." --- For TensorFlow jobs using GPUs, specify a custom base image for the container build. This ensures proper GPU utilization during runs. Add an image tag under the `builder.accelerator.base_image` key in the resource configuration. For example: diff --git a/platform/launch/launch-faq/launcherror_permission_denied.mdx b/platform/launch/launch-faq/launcherror_permission_denied.mdx index 6c7a9e424e..964e98f74d 100644 --- a/platform/launch/launch-faq/launcherror_permission_denied.mdx +++ b/platform/launch/launch-faq/launcherror_permission_denied.mdx @@ -1,5 +1,6 @@ --- title: How do I fix a "permission denied" error in Launch? +description: "Troubleshoot the \"Launch Error: Permission denied\" error caused by missing W&B login or insufficient project permissions." --- If you encounter the error message `Launch Error: Permission denied`, it indicates insufficient permissions to log to the desired project. Possible causes include: diff --git a/platform/launch/launch-faq/permissions_agent_require_kubernetes.mdx b/platform/launch/launch-faq/permissions_agent_require_kubernetes.mdx index 936210fba3..8413cc48eb 100644 --- a/platform/launch/launch-faq/permissions_agent_require_kubernetes.mdx +++ b/platform/launch/launch-faq/permissions_agent_require_kubernetes.mdx @@ -1,5 +1,6 @@ --- title: What permissions does the agent require in Kubernetes? +description: "Required Kubernetes role and permissions for running the W&B Launch agent, including pods, configmaps, secrets, and logs." --- The following Kubernetes manifest creates a role named `wandb-launch-agent` in the `wandb` namespace. This role allows the agent to create pods, configmaps, secrets, and access pod logs in the `wandb` namespace. The `wandb-cluster-role` enables the agent to create pods, access pod logs, create secrets, jobs, and check job status across any specified namespace. \ No newline at end of file diff --git a/platform/launch/launch-faq/requirements_accelerator_base_image.mdx b/platform/launch/launch-faq/requirements_accelerator_base_image.mdx index 48bb5113df..d21ac2d077 100644 --- a/platform/launch/launch-faq/requirements_accelerator_base_image.mdx +++ b/platform/launch/launch-faq/requirements_accelerator_base_image.mdx @@ -1,5 +1,6 @@ --- title: What requirements does the accelerator base image have? +description: "Requirements for the W&B Launch accelerator base image, including OS compatibility, GPU drivers, and CUDA support." --- For jobs utilizing an accelerator, provide a base image that includes the necessary accelerator components. Ensure the following requirements for the accelerator image: diff --git a/platform/launch/launch-faq/restrict_access_modify_example.mdx b/platform/launch/launch-faq/restrict_access_modify_example.mdx index 9a53c17694..0ddaf3a56a 100644 --- a/platform/launch/launch-faq/restrict_access_modify_example.mdx +++ b/platform/launch/launch-faq/restrict_access_modify_example.mdx @@ -1,5 +1,6 @@ --- title: How can admins restrict which users have modify access? +description: "How W&B team admins use queue config templates to restrict which queue fields non-admin users can modify." --- Control access to certain queue fields for users who are not team administrators through [queue config templates](/platform/launch/setup-queue-advanced/). Team administrators define which fields non-admin users can view, and set the editing limits. Only team administrators have the ability to create or edit queues. \ No newline at end of file diff --git a/platform/launch/launch-faq/secrets_jobsautomations_instance_api_key_wish_directly_visible.mdx b/platform/launch/launch-faq/secrets_jobsautomations_instance_api_key_wish_directly_visible.mdx index 7fd4c78ca1..2255611f09 100644 --- a/platform/launch/launch-faq/secrets_jobsautomations_instance_api_key_wish_directly_visible.mdx +++ b/platform/launch/launch-faq/secrets_jobsautomations_instance_api_key_wish_directly_visible.mdx @@ -1,6 +1,6 @@ --- -title: Can you specify secrets for jobs/automations? For instance, an API key which - you do not wish to be directly visible to users? +title: "Can you specify secrets for jobs/automations? For instance, an API key which you do not wish to be directly visible to users?" +description: "Use Kubernetes secrets to pass API keys to W&B Launch jobs and automations without exposing them in run configs." --- Yes. Follow these steps: diff --git a/platform/launch/launch-library/launch.mdx b/platform/launch/launch-library/launch.mdx index c03fcfb16b..37d1c649bc 100644 --- a/platform/launch/launch-library/launch.mdx +++ b/platform/launch/launch-library/launch.mdx @@ -1,5 +1,6 @@ --- title: launch api +description: "Reference for the W&B Launch `launch` Python API used to programmatically run a Launch experiment from a job source." --- diff --git a/platform/launch/launch-library/launch_add.mdx b/platform/launch/launch-library/launch_add.mdx index 80bb37b012..2166559ec7 100644 --- a/platform/launch/launch-library/launch_add.mdx +++ b/platform/launch/launch-library/launch_add.mdx @@ -1,5 +1,6 @@ --- title: launch_add +description: "Reference for the W&B Launch `launch_add` Python API used to enqueue a Launch experiment from a URI, job, or Docker image." --- diff --git a/platform/launch/launch-library/launchagent.mdx b/platform/launch/launch-library/launchagent.mdx index 646fc1f323..167601bb89 100644 --- a/platform/launch/launch-library/launchagent.mdx +++ b/platform/launch/launch-library/launchagent.mdx @@ -1,5 +1,6 @@ --- title: LaunchAgent +description: "Reference for the W&B Launch `LaunchAgent` Python class used to poll run queues and launch runs." --- diff --git a/pricing.mdx b/pricing.mdx index 206d818326..734adebfdc 100644 --- a/pricing.mdx +++ b/pricing.mdx @@ -1,4 +1,5 @@ --- title: "W&B Pricing" +description: "Compare W&B pricing plans for individuals, teams, and enterprises across W&B Models, Weave, Inference, Training, and Sandboxes." url: "https://wandb.ai/site/pricing/" --- \ No newline at end of file diff --git a/product-inference.mdx b/product-inference.mdx index bc05e76231..f1f51a4aa9 100644 --- a/product-inference.mdx +++ b/product-inference.mdx @@ -1,4 +1,5 @@ --- title: "W&B Inference" +description: "Open-source foundation model inference as a service from W&B with OpenAI-compatible APIs and built-in tracing through Weave." url: "/inference" --- diff --git a/product-models.mdx b/product-models.mdx index 6d48247809..c4e12e87ee 100644 --- a/product-models.mdx +++ b/product-models.mdx @@ -1,4 +1,5 @@ --- title: "W&B Models" +description: "Track ML experiments, hyperparameter sweeps, datasets, and model versions with the W&B Models MLOps platform." url: "/models" --- diff --git a/product-sandboxes.mdx b/product-sandboxes.mdx index af989e7900..9f1bf8b1b8 100644 --- a/product-sandboxes.mdx +++ b/product-sandboxes.mdx @@ -1,5 +1,6 @@ --- title: "W&B Sandboxes" +description: "Spin up isolated, on-demand compute sandboxes for running ML code, agents, and experiments in W&B-managed containers." url: "/sandboxes" tag: Preview --- diff --git a/product-training.mdx b/product-training.mdx index a708a959ef..f5c5385307 100644 --- a/product-training.mdx +++ b/product-training.mdx @@ -1,4 +1,5 @@ --- title: "W&B Training" +description: "Run serverless reinforcement learning and supervised fine-tuning jobs on managed GPU infrastructure with W&B Training." url: "/training" --- diff --git a/product-weave.mdx b/product-weave.mdx index f19f4f67e4..5fedadec4d 100644 --- a/product-weave.mdx +++ b/product-weave.mdx @@ -1,4 +1,5 @@ --- title: "W&B Weave" +description: "Trace, evaluate, and monitor LLM applications and AI agents with the W&B Weave observability and evaluation platform." url: "/weave" --- diff --git a/sandboxes.mdx b/sandboxes.mdx index b18bbfa70a..cde80421ca 100644 --- a/sandboxes.mdx +++ b/sandboxes.mdx @@ -1,5 +1,6 @@ --- title: W&B Sandboxes +description: "W&B Sandboxes provide on-demand, isolated compute environments you can create, run code in, and discard programmatically." mode: wide --- diff --git a/sandboxes/create-sandbox.mdx b/sandboxes/create-sandbox.mdx index c743af0c16..bc07387b0d 100644 --- a/sandboxes/create-sandbox.mdx +++ b/sandboxes/create-sandbox.mdx @@ -1,6 +1,6 @@ --- title: Create sandboxes -description: Learn how to create W&B Sandboxes. +description: "Create W&B Sandboxes to run ML code and agents in isolated, on-demand compute containers with their own filesystem, network, and process space." --- diff --git a/sandboxes/secrets.mdx b/sandboxes/secrets.mdx index 938ed99c26..3fa8f2d5e8 100644 --- a/sandboxes/secrets.mdx +++ b/sandboxes/secrets.mdx @@ -1,6 +1,6 @@ --- title: Secrets -description: Learn how to manage secrets in W&B Sandboxes. +description: "Manage secrets in W&B Sandboxes by using the W&B Secrets Manager to securely access API keys, tokens, and credentials inside a sandbox container." --- diff --git a/security.mdx b/security.mdx index 3944b4aa08..0ef07aa3eb 100644 --- a/security.mdx +++ b/security.mdx @@ -1,4 +1,5 @@ --- title: "W&B Platform Security" +description: "Learn how W&B protects customer data with SOC 2 compliance, encryption, access controls, and platform security best practices." url: "https://wandb.ai/site/security/" --- \ No newline at end of file diff --git a/support.mdx b/support.mdx index a9fefd5356..2f6245053e 100644 --- a/support.mdx +++ b/support.mdx @@ -1,5 +1,6 @@ --- title: Support Home +description: "Search support articles, product documentation, and community resources for W&B Models, Weave, Inference, and the platform." mode: "center" --- diff --git a/support/inference/articles/api-error-code-401-authentication-failed.mdx b/support/inference/articles/api-error-code-401-authentication-failed.mdx index 35fed407ed..45a0e3f1f9 100644 --- a/support/inference/articles/api-error-code-401-authentication-failed.mdx +++ b/support/inference/articles/api-error-code-401-authentication-failed.mdx @@ -1,5 +1,6 @@ --- title: "API error code 401 - Authentication failed" +description: "Resolve the W&B Inference 401 \"Authentication failed\" error caused by incorrect API credentials, project entity, or project name." keywords: ["Authentication & Access"] --- diff --git a/support/inference/articles/api-error-code-402-you-exceeded-your-cur.mdx b/support/inference/articles/api-error-code-402-you-exceeded-your-cur.mdx index 83488b542c..0f826232ab 100644 --- a/support/inference/articles/api-error-code-402-you-exceeded-your-cur.mdx +++ b/support/inference/articles/api-error-code-402-you-exceeded-your-cur.mdx @@ -1,5 +1,6 @@ --- title: "API error code 402 - You exceeded your current quota" +description: "Resolve the W&B Inference 402 quota error caused by running out of credits or hitting your monthly spending cap." keywords: ["Quotas & Rate Limits", "Billing"] --- diff --git a/support/inference/articles/api-error-code-403-country-region-or-ter.mdx b/support/inference/articles/api-error-code-403-country-region-or-ter.mdx index 6699e61eca..4eca418c90 100644 --- a/support/inference/articles/api-error-code-403-country-region-or-ter.mdx +++ b/support/inference/articles/api-error-code-403-country-region-or-ter.mdx @@ -1,5 +1,6 @@ --- title: "API error code 403 - Country, region, or territory not supported" +description: "Resolve the W&B Inference 403 error returned when accessing the API from a country, region, or territory that is not supported." keywords: ["Authentication & Access"] --- diff --git a/support/inference/articles/api-error-code-403-the-inference-gateway.mdx b/support/inference/articles/api-error-code-403-the-inference-gateway.mdx index 9fa6c7c959..d69606b33e 100644 --- a/support/inference/articles/api-error-code-403-the-inference-gateway.mdx +++ b/support/inference/articles/api-error-code-403-the-inference-gateway.mdx @@ -1,5 +1,6 @@ --- title: "API error code 403 - The inference gateway is not enabled for your organization" +description: "Resolve the W&B Inference 403 error returned when the inference gateway is not enabled for your organization." keywords: ["Authentication & Access", "Administrator"] --- diff --git a/support/inference/articles/api-error-code-429-concurrency-limit-rea.mdx b/support/inference/articles/api-error-code-429-concurrency-limit-rea.mdx index 71281904b3..31cacda9ec 100644 --- a/support/inference/articles/api-error-code-429-concurrency-limit-rea.mdx +++ b/support/inference/articles/api-error-code-429-concurrency-limit-rea.mdx @@ -1,5 +1,6 @@ --- title: "API error code 429 - Concurrency limit reached for requests" +description: "Resolve the W&B Inference 429 error returned when you exceed the concurrency limit for parallel API requests." keywords: ["Quotas & Rate Limits"] --- diff --git a/support/inference/articles/api-error-code-500-the-server-had-an-err.mdx b/support/inference/articles/api-error-code-500-the-server-had-an-err.mdx index 4ac75209ff..c042a57a55 100644 --- a/support/inference/articles/api-error-code-500-the-server-had-an-err.mdx +++ b/support/inference/articles/api-error-code-500-the-server-had-an-err.mdx @@ -1,5 +1,6 @@ --- title: "API error code 500 - The server had an error while processing your request" +description: "Resolve the W&B Inference 500 internal server error, a transient issue that usually clears with a retry." keywords: ["Server Errors"] --- diff --git a/support/inference/articles/api-error-code-503-the-engine-is-current.mdx b/support/inference/articles/api-error-code-503-the-engine-is-current.mdx index be0d7fe0fe..617f2f5726 100644 --- a/support/inference/articles/api-error-code-503-the-engine-is-current.mdx +++ b/support/inference/articles/api-error-code-503-the-engine-is-current.mdx @@ -1,5 +1,6 @@ --- title: "API error code 503 - The engine is currently overloaded" +description: "Resolve the W&B Inference 503 \"engine overloaded\" error returned during periods of high traffic on the API." keywords: ["Server Errors"] --- diff --git a/support/models/articles/adding-multiple-authors-to-a-report.mdx b/support/models/articles/adding-multiple-authors-to-a-report.mdx index 57f2ef2a10..72ee2dc41a 100644 --- a/support/models/articles/adding-multiple-authors-to-a-report.mdx +++ b/support/models/articles/adding-multiple-authors-to-a-report.mdx @@ -1,5 +1,6 @@ --- title: "Adding multiple authors to a report" +description: "Add multiple authors to a W&B report so all contributors are credited, using the author dropdown next to the author name." keywords: ["Reports"] --- diff --git a/support/models/articles/anaconda-400-error-during-a-sweep.mdx b/support/models/articles/anaconda-400-error-during-a-sweep.mdx index 0af6390961..ab694d7b1f 100644 --- a/support/models/articles/anaconda-400-error-during-a-sweep.mdx +++ b/support/models/articles/anaconda-400-error-during-a-sweep.mdx @@ -1,5 +1,6 @@ --- title: "How do I fix an `anaconda 400 error` during a sweep?" +description: "Fix the `anaconda 400 error` during a W&B sweep by logging the metric specified in your sweep configuration." keywords: ["Sweeps", "Metrics"] --- diff --git a/support/models/articles/best-practices-to-organize-hyperparamete.mdx b/support/models/articles/best-practices-to-organize-hyperparamete.mdx index eb23cc4aae..b2b06698a8 100644 --- a/support/models/articles/best-practices-to-organize-hyperparamete.mdx +++ b/support/models/articles/best-practices-to-organize-hyperparamete.mdx @@ -1,5 +1,6 @@ --- title: "Best practices to organize hyperparameter searches" +description: "Set unique tags with `wandb.init(tags='your_tag')`." keywords: ["Hyperparameter", "Sweeps", "Runs"] --- diff --git a/support/models/articles/can-i-get-an-academic-plan-as-a-student.mdx b/support/models/articles/can-i-get-an-academic-plan-as-a-student.mdx index 5f6ae6f902..32d340b9c2 100644 --- a/support/models/articles/can-i-get-an-academic-plan-as-a-student.mdx +++ b/support/models/articles/can-i-get-an-academic-plan-as-a-student.mdx @@ -1,5 +1,6 @@ --- title: "Can I get an academic plan as a student?" +description: "Students can apply for an academic plan by following these steps: - Visit the Pricing page on the wandb.com." keywords: ["Administrator", "Academic", "User Management"] --- diff --git a/support/models/articles/can-i-group-runs-without-using-the-group.mdx b/support/models/articles/can-i-group-runs-without-using-the-group.mdx index 53ae2ae733..91fdcaa93b 100644 --- a/support/models/articles/can-i-group-runs-without-using-the-group.mdx +++ b/support/models/articles/can-i-group-runs-without-using-the-group.mdx @@ -1,5 +1,6 @@ --- title: "Can I group runs without using the 'Group' feature?" +description: "Yes, you can also use tags or custom metadata to categorize runs." keywords: ["Workspaces", "Runs"] --- diff --git a/support/models/articles/can-i-just-log-metrics-no-code-or-datase.mdx b/support/models/articles/can-i-just-log-metrics-no-code-or-datase.mdx index 795fb23c46..71e4ba7151 100644 --- a/support/models/articles/can-i-just-log-metrics-no-code-or-datase.mdx +++ b/support/models/articles/can-i-just-log-metrics-no-code-or-datase.mdx @@ -1,5 +1,6 @@ --- title: "Can I just log metrics, no code or dataset examples?" +description: "Configure W&B to only log metrics by disabling code and dataset capture with environment variables such as `WANDB_DISABLE_CODE`." keywords: ["Administrator", "Team Management", "Metrics"] --- diff --git a/support/models/articles/can-i-just-set-the-run-name-to-the-run-i.mdx b/support/models/articles/can-i-just-set-the-run-name-to-the-run-i.mdx index d229ad49d5..ac66fac19f 100644 --- a/support/models/articles/can-i-just-set-the-run-name-to-the-run-i.mdx +++ b/support/models/articles/can-i-just-set-the-run-name-to-the-run-i.mdx @@ -1,5 +1,6 @@ --- title: "Can I just set the run name to the run ID?" +description: "Set a W&B run name to the run ID by overriding the run name with the ID after `wandb.init()`." keywords: ["Experiments"] --- diff --git a/support/models/articles/can-i-log-metrics-on-two-different-time-.mdx b/support/models/articles/can-i-log-metrics-on-two-different-time-.mdx index 4ff2de3c4c..fdf3c71a8c 100644 --- a/support/models/articles/can-i-log-metrics-on-two-different-time-.mdx +++ b/support/models/articles/can-i-log-metrics-on-two-different-time-.mdx @@ -1,5 +1,6 @@ --- title: "Can I log metrics on two different time scales?" +description: "Log metrics in W&B on two different time scales such as per-batch training accuracy and per-epoch validation accuracy." keywords: ["Experiments", "Metrics"] --- diff --git a/support/models/articles/can-i-rerun-a-grid-search.mdx b/support/models/articles/can-i-rerun-a-grid-search.mdx index f871e5cca6..52406ebc3f 100644 --- a/support/models/articles/can-i-rerun-a-grid-search.mdx +++ b/support/models/articles/can-i-rerun-a-grid-search.mdx @@ -1,5 +1,6 @@ --- title: "Can I rerun a grid search?" +description: "If a grid search completes but some W&B Runs need re-execution due to crashes, delete the specific W&B Runs to re-run." keywords: ["Sweeps", "Hyperparameter", "Runs"] --- diff --git a/support/models/articles/can-i-run-wandb-offline.mdx b/support/models/articles/can-i-run-wandb-offline.mdx index 28a150902b..4792a6d0ef 100644 --- a/support/models/articles/can-i-run-wandb-offline.mdx +++ b/support/models/articles/can-i-run-wandb-offline.mdx @@ -1,5 +1,6 @@ --- title: "Can I run wandb offline?" +description: "If training occurs on an offline machine, use the following steps to upload results to the servers: 1." keywords: ["Experiments", "Environment Variables"] --- diff --git a/support/models/articles/can-i-turn-off-wandb-when-testing-my-cod.mdx b/support/models/articles/can-i-turn-off-wandb-when-testing-my-cod.mdx index 37838484a3..48996ff303 100644 --- a/support/models/articles/can-i-turn-off-wandb-when-testing-my-cod.mdx +++ b/support/models/articles/can-i-turn-off-wandb-when-testing-my-cod.mdx @@ -1,5 +1,6 @@ --- title: "Can I turn off wandb when testing my code?" +description: "Use `wandb.init(mode=\"disabled\")` or set `WANDB_MODE=disabled` to configure W&B as a no-operation (NOOP) for testing purposes." keywords: ["Artifacts"] --- diff --git a/support/models/articles/can-i-use-markdown-in-my-reports.mdx b/support/models/articles/can-i-use-markdown-in-my-reports.mdx index 9ae01a9658..ab9208292d 100644 --- a/support/models/articles/can-i-use-markdown-in-my-reports.mdx +++ b/support/models/articles/can-i-use-markdown-in-my-reports.mdx @@ -1,5 +1,6 @@ --- title: "Can I use Markdown in my reports?" +description: "Use Markdown formatting in W&B reports for headings, lists, links, and other rich text content." keywords: ["Reports"] --- diff --git a/support/models/articles/can-i-use-sweeps-and-sagemaker.mdx b/support/models/articles/can-i-use-sweeps-and-sagemaker.mdx index 5f01f3813f..8aeb8377a1 100644 --- a/support/models/articles/can-i-use-sweeps-and-sagemaker.mdx +++ b/support/models/articles/can-i-use-sweeps-and-sagemaker.mdx @@ -1,5 +1,6 @@ --- title: "Can I use Sweeps and SageMaker?" +description: "To authenticate W&B, complete the following steps: create a `requirements.txt` file if using a built-in Amazon SageMaker estimator." keywords: ["Sweeps", "AWS"] --- diff --git a/support/models/articles/can-wb-team-members-see-my-data.mdx b/support/models/articles/can-wb-team-members-see-my-data.mdx index 3c45e27cfd..c5efee8f31 100644 --- a/support/models/articles/can-wb-team-members-see-my-data.mdx +++ b/support/models/articles/can-wb-team-members-see-my-data.mdx @@ -1,5 +1,6 @@ --- title: "Can W&B team members see my data?" +description: "Key engineers and support staff at W&B access logged values for debugging purposes with user permission." keywords: ["Privacy", "Security"] --- diff --git a/support/models/articles/can-we-flag-boolean-variables-as-hyperpa.mdx b/support/models/articles/can-we-flag-boolean-variables-as-hyperpa.mdx index 69f4bb986d..a76f12e394 100644 --- a/support/models/articles/can-we-flag-boolean-variables-as-hyperpa.mdx +++ b/support/models/articles/can-we-flag-boolean-variables-as-hyperpa.mdx @@ -1,5 +1,6 @@ --- title: "Can we flag boolean variables as hyperparameters?" +description: "Use the `${args_no_boolean_flags}` macro in the command section of the configuration to pass hyperparameters as boolean flags." keywords: ["Sweeps"] --- diff --git a/support/models/articles/can-you-group-runs-by-tags.mdx b/support/models/articles/can-you-group-runs-by-tags.mdx index fc3964c370..93495abb13 100644 --- a/support/models/articles/can-you-group-runs-by-tags.mdx +++ b/support/models/articles/can-you-group-runs-by-tags.mdx @@ -1,5 +1,6 @@ --- title: "Can you group runs by tags?" +description: "A run can have multiple tags, so grouping by tags is not supported. Add a value to the `config` object for these runs and group by this config value instead." keywords: ["Runs"] --- diff --git a/support/models/articles/can-you-use-wb-sweeps-with-cloud-infrast.mdx b/support/models/articles/can-you-use-wb-sweeps-with-cloud-infrast.mdx index 8265b8be1a..4f37f0555c 100644 --- a/support/models/articles/can-you-use-wb-sweeps-with-cloud-infrast.mdx +++ b/support/models/articles/can-you-use-wb-sweeps-with-cloud-infrast.mdx @@ -1,5 +1,6 @@ --- title: "Can you use W&B Sweeps with cloud infrastructures such as AWS Batch, ECS, etc.?" +description: "To publish the `sweep_id` so that any W&B Sweep agent can access it, implement a method for these agents to read and execute the `sweep_id`." keywords: ["Sweeps", "AWS"] --- diff --git a/support/models/articles/cannot-link-artifact-to-registry-from-p.mdx b/support/models/articles/cannot-link-artifact-to-registry-from-p.mdx index 8700f356ea..277abe92c3 100644 --- a/support/models/articles/cannot-link-artifact-to-registry-from-p.mdx +++ b/support/models/articles/cannot-link-artifact-to-registry-from-p.mdx @@ -1,5 +1,6 @@ --- title: "Why can't I link my artifact to the registry?" +description: "Resolve the W&B Registry error caused by trying to link an artifact logged with a personal entity instead of a team entity." keywords: ["Artifacts"] --- diff --git a/support/models/articles/commerror-run-does-not-exist-during-swee.mdx b/support/models/articles/commerror-run-does-not-exist-during-swee.mdx index 51e3f4c953..0ae94e14e1 100644 --- a/support/models/articles/commerror-run-does-not-exist-during-swee.mdx +++ b/support/models/articles/commerror-run-does-not-exist-during-swee.mdx @@ -1,5 +1,6 @@ --- title: "How do I fix `CommError, Run does not exist` during a sweep?" +description: "Learn how to fix `CommError, Run does not exist` during a sweep in W&B." keywords: ["Sweeps", "Runs"] --- diff --git a/support/models/articles/cuda-out-of-memory-during-a-sweep.mdx b/support/models/articles/cuda-out-of-memory-during-a-sweep.mdx index f089ee38e6..3b3cc9a80e 100644 --- a/support/models/articles/cuda-out-of-memory-during-a-sweep.mdx +++ b/support/models/articles/cuda-out-of-memory-during-a-sweep.mdx @@ -1,5 +1,6 @@ --- title: "How do I fix `Cuda out of memory` during a sweep?" +description: "Learn how to fix `Cuda out of memory` during a sweep in W&B: If you see `Cuda out of memory` during a sweep, refactor your code to use process-based execution." keywords: ["Sweeps", "Run Crashes"] --- diff --git a/support/models/articles/do-environment-variables-overwrite-the-p.mdx b/support/models/articles/do-environment-variables-overwrite-the-p.mdx index 5eba02d8d5..5201b90b31 100644 --- a/support/models/articles/do-environment-variables-overwrite-the-p.mdx +++ b/support/models/articles/do-environment-variables-overwrite-the-p.mdx @@ -1,5 +1,6 @@ --- title: "Do environment variables overwrite the parameters passed to wandb.init()?" +description: "Arguments passed to `wandb.init` override environment variables." keywords: ["Environment Variables"] --- diff --git a/support/models/articles/do-i-need-to-provide-values-for-all-hype.mdx b/support/models/articles/do-i-need-to-provide-values-for-all-hype.mdx index 53a3893b79..af4a5a8b4b 100644 --- a/support/models/articles/do-i-need-to-provide-values-for-all-hype.mdx +++ b/support/models/articles/do-i-need-to-provide-values-for-all-hype.mdx @@ -1,5 +1,6 @@ --- title: "Do I need to provide values for all hyperparameters as part of the W&B Sweep. Can I set defaults?" +description: "Access hyperparameter names and values from the sweep configuration using `(run.config())`, which acts like a dictionary." keywords: ["Sweeps"] --- diff --git a/support/models/articles/do-run-finished-alerts-work-in-notebooks.mdx b/support/models/articles/do-run-finished-alerts-work-in-notebooks.mdx index 10c3398867..4505048c56 100644 --- a/support/models/articles/do-run-finished-alerts-work-in-notebooks.mdx +++ b/support/models/articles/do-run-finished-alerts-work-in-notebooks.mdx @@ -1,5 +1,6 @@ --- title: "Do 'Run Finished' alerts work in notebooks?" +description: "Do 'Run Finished' alerts work in notebooks: a common question and answer for W&B users." keywords: ["Alerts", "Notebooks"] --- diff --git a/support/models/articles/do-you-have-a-bug-bounty-program.mdx b/support/models/articles/do-you-have-a-bug-bounty-program.mdx index 80b812ed9c..bdb10db6d4 100644 --- a/support/models/articles/do-you-have-a-bug-bounty-program.mdx +++ b/support/models/articles/do-you-have-a-bug-bounty-program.mdx @@ -1,5 +1,6 @@ --- title: "Do you have a bug bounty program?" +description: "Do you have a bug bounty program: a common question and answer for W&B users." keywords: ["Security"] --- diff --git a/support/models/articles/does-logging-block-my-training.mdx b/support/models/articles/does-logging-block-my-training.mdx index a0ce8941a7..d2430f2921 100644 --- a/support/models/articles/does-logging-block-my-training.mdx +++ b/support/models/articles/does-logging-block-my-training.mdx @@ -1,5 +1,6 @@ --- title: "Does logging block my training?" +description: "Does logging block your training: a common question and answer for W&B users." keywords: ["Experiments", "Logs"] --- diff --git a/support/models/articles/does-the-wb-client-support-python-2.mdx b/support/models/articles/does-the-wb-client-support-python-2.mdx index 1713962010..7c7e0f743c 100644 --- a/support/models/articles/does-the-wb-client-support-python-2.mdx +++ b/support/models/articles/does-the-wb-client-support-python-2.mdx @@ -1,5 +1,6 @@ --- title: "Does the W&B client support Python 2?" +description: "The W&B client library supported both Python 2.7 and Python 3 through version 0.10." keywords: ["Python"] --- diff --git a/support/models/articles/does-the-wb-client-support-python-35.mdx b/support/models/articles/does-the-wb-client-support-python-35.mdx index 6b295da883..e13e4fc914 100644 --- a/support/models/articles/does-the-wb-client-support-python-35.mdx +++ b/support/models/articles/does-the-wb-client-support-python-35.mdx @@ -1,5 +1,6 @@ --- title: "Does the W&B client support Python 3.5?" +description: "The W&B client library supported Python 3.5 until version 0.11." keywords: ["Python"] --- diff --git a/support/models/articles/does-this-only-work-for-python.mdx b/support/models/articles/does-this-only-work-for-python.mdx index 48ddfa242a..639f22e82d 100644 --- a/support/models/articles/does-this-only-work-for-python.mdx +++ b/support/models/articles/does-this-only-work-for-python.mdx @@ -1,5 +1,6 @@ --- title: "Does this only work for Python?" +description: "The library supports Python 2.7 and later, as well as Python 3.6 and later." keywords: ["Python"] --- diff --git a/support/models/articles/does-wb-support-sso-for-multi-tenant.mdx b/support/models/articles/does-wb-support-sso-for-multi-tenant.mdx index 74a9144649..b8c0bb4b6f 100644 --- a/support/models/articles/does-wb-support-sso-for-multi-tenant.mdx +++ b/support/models/articles/does-wb-support-sso-for-multi-tenant.mdx @@ -1,5 +1,6 @@ --- title: "Does W&B support SSO for Multi-tenant?" +description: "W&B supports Single Sign-On (SSO) for the Multi-tenant offering through Auth0." keywords: ["Security"] --- diff --git a/support/models/articles/does-wb-use-the-multiprocessing-library.mdx b/support/models/articles/does-wb-use-the-multiprocessing-library.mdx index afb9e9927b..5bda206622 100644 --- a/support/models/articles/does-wb-use-the-multiprocessing-library.mdx +++ b/support/models/articles/does-wb-use-the-multiprocessing-library.mdx @@ -1,5 +1,6 @@ --- title: "Does W&B use the `multiprocessing` library?" +description: "Does W&B use the `multiprocessing` library: a common question and answer for W&B users." keywords: ["Experiments"] --- diff --git a/support/models/articles/does-your-tool-track-or-store-training-d.mdx b/support/models/articles/does-your-tool-track-or-store-training-d.mdx index c363cb4053..1d0b0446eb 100644 --- a/support/models/articles/does-your-tool-track-or-store-training-d.mdx +++ b/support/models/articles/does-your-tool-track-or-store-training-d.mdx @@ -1,5 +1,6 @@ --- title: "Does your tool track or store training data?" +description: "Pass a SHA or unique identifier to `wandb.Run.config.update(...)` to associate a dataset with a training run." keywords: ["Experiments"] --- diff --git a/support/models/articles/embedding-reports.mdx b/support/models/articles/embedding-reports.mdx index ff14285a4c..8d1fc5a834 100644 --- a/support/models/articles/embedding-reports.mdx +++ b/support/models/articles/embedding-reports.mdx @@ -1,5 +1,6 @@ --- title: "Embedding Reports" +description: "Embed W&B reports in external websites and tools to share live experiment results, charts, and analyses." keywords: ["Reports"] --- diff --git a/support/models/articles/enterprise-license-not-recognized.mdx b/support/models/articles/enterprise-license-not-recognized.mdx index 1dc711c1b6..3516bf4871 100644 --- a/support/models/articles/enterprise-license-not-recognized.mdx +++ b/support/models/articles/enterprise-license-not-recognized.mdx @@ -1,5 +1,6 @@ --- title: "Why is my enterprise license not recognized?" +description: "Resolve the \"enterprise license not recognized\" error in self-managed W&B deployments." keywords: ["Administrator"] --- diff --git a/support/models/articles/filter-and-delete-unwanted-reports.mdx b/support/models/articles/filter-and-delete-unwanted-reports.mdx index 5788cf6d51..1f635771f8 100644 --- a/support/models/articles/filter-and-delete-unwanted-reports.mdx +++ b/support/models/articles/filter-and-delete-unwanted-reports.mdx @@ -1,5 +1,6 @@ --- title: "Filter and delete unwanted reports" +description: "Filter and delete unwanted W&B reports from your project to keep your reports list organized." keywords: ["Reports"] --- diff --git a/support/models/articles/how-can-i-access-the-data-logged-to-my-r.mdx b/support/models/articles/how-can-i-access-the-data-logged-to-my-r.mdx index 8ed0360ac3..506180dc79 100644 --- a/support/models/articles/how-can-i-access-the-data-logged-to-my-r.mdx +++ b/support/models/articles/how-can-i-access-the-data-logged-to-my-r.mdx @@ -1,5 +1,6 @@ --- title: "How can I access the data logged to my runs directly and programmatically?" +description: "Learn how to access the data logged to your runs directly and programmatically in W&B." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-can-i-be-removed-from-a-team.mdx b/support/models/articles/how-can-i-be-removed-from-a-team.mdx index 5d0618ad10..00ff9324d0 100644 --- a/support/models/articles/how-can-i-be-removed-from-a-team.mdx +++ b/support/models/articles/how-can-i-be-removed-from-a-team.mdx @@ -1,5 +1,6 @@ --- title: "How can I be removed from a team?" +description: "Learn how to be removed from a team in W&B: A team admin can remove you from a team from the Users tab of the team settings." keywords: ["Administrator", "Team Management"] --- diff --git a/support/models/articles/how-can-i-change-how-frequently-to-log-s.mdx b/support/models/articles/how-can-i-change-how-frequently-to-log-s.mdx index 549d23a4de..ecf1357f02 100644 --- a/support/models/articles/how-can-i-change-how-frequently-to-log-s.mdx +++ b/support/models/articles/how-can-i-change-how-frequently-to-log-s.mdx @@ -1,5 +1,6 @@ --- title: "How can I change how frequently to log system metrics?" +description: "Learn how to change how frequently to log system metrics in W&B: To configure the frequency to log system metrics, set `_stats_sampling_interval` to a..." keywords: ["Metrics", "Runs"] --- diff --git a/support/models/articles/how-can-i-change-my-account-from-corpora.mdx b/support/models/articles/how-can-i-change-my-account-from-corpora.mdx index d3c5e5e121..0a07a34e40 100644 --- a/support/models/articles/how-can-i-change-my-account-from-corpora.mdx +++ b/support/models/articles/how-can-i-change-my-account-from-corpora.mdx @@ -1,5 +1,6 @@ --- title: "How can I change my account from corporate to academic?" +description: "Learn how to change your W&B account from corporate to academic in W&B." keywords: ["Administrator", "Academic", "User Management"] --- diff --git a/support/models/articles/how-can-i-change-the-colors-of-each-run-.mdx b/support/models/articles/how-can-i-change-the-colors-of-each-run-.mdx index ecd5c9dad3..087b75aef2 100644 --- a/support/models/articles/how-can-i-change-the-colors-of-each-run-.mdx +++ b/support/models/articles/how-can-i-change-the-colors-of-each-run-.mdx @@ -1,5 +1,6 @@ --- title: "How can I change the colors of each run in the same group?" +description: "Learn how to change the colors of each run in the same group in W&B: Changing the colors of individual runs within a group is not possible." keywords: ["Runs", "Workspaces"] --- diff --git a/support/models/articles/how-can-i-change-the-directory-my-sweep-.mdx b/support/models/articles/how-can-i-change-the-directory-my-sweep-.mdx index de900dbd52..8d8f48bc72 100644 --- a/support/models/articles/how-can-i-change-the-directory-my-sweep-.mdx +++ b/support/models/articles/how-can-i-change-the-directory-my-sweep-.mdx @@ -1,5 +1,6 @@ --- title: "How can I change the directory my sweep logs to locally?" +description: "Learn how to change the directory your sweep logs to locally in W&B: Set the logging directory for W&B run data by configuring the environment variable..." keywords: ["Sweeps"] --- 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 bafc601382..84e3aedbcb 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 @@ -1,5 +1,6 @@ --- title: "How can I change the privacy of my project?" +description: "Learn how to change the privacy of your project in W&B: To change a project's privacy (visibility): 1." keywords: ["Privacy", "Projects"] --- diff --git a/support/models/articles/how-can-i-compare-images-or-media-across.mdx b/support/models/articles/how-can-i-compare-images-or-media-across.mdx index 088cf72072..79268f7f8a 100644 --- a/support/models/articles/how-can-i-compare-images-or-media-across.mdx +++ b/support/models/articles/how-can-i-compare-images-or-media-across.mdx @@ -1,5 +1,6 @@ --- title: "How can I compare images or media across epochs or steps?" +description: "Learn how to compare images or media across epochs or steps in W&B: Expand the image panel and use the step slider to navigate through images from different..." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-can-i-configure-the-name-of-the-run-.mdx b/support/models/articles/how-can-i-configure-the-name-of-the-run-.mdx index b99722e261..b7e6032646 100644 --- a/support/models/articles/how-can-i-configure-the-name-of-the-run-.mdx +++ b/support/models/articles/how-can-i-configure-the-name-of-the-run-.mdx @@ -1,5 +1,6 @@ --- title: "How can I configure the name of the run in my training code?" +description: "Learn how to configure the name of the run in your training code in W&B." keywords: ["Experiments"] featured: true --- diff --git a/support/models/articles/how-can-i-define-the-local-location-for-.mdx b/support/models/articles/how-can-i-define-the-local-location-for-.mdx index 90a4f30041..76cd335f2f 100644 --- a/support/models/articles/how-can-i-define-the-local-location-for-.mdx +++ b/support/models/articles/how-can-i-define-the-local-location-for-.mdx @@ -1,5 +1,6 @@ --- title: "How can I define the local location for `wandb` files?" +description: "Learn how to define the local location for `wandb` files in W&B: - `WANDB_DIR=` or `wandb.init(dir=)`: Controls the location of the `wandb` folder created..." keywords: ["Environment Variables", "Experiments"] --- diff --git a/support/models/articles/how-can-i-delete-multiple-runs-in-bulk-i.mdx b/support/models/articles/how-can-i-delete-multiple-runs-in-bulk-i.mdx index 88ab904206..53d614ad18 100644 --- a/support/models/articles/how-can-i-delete-multiple-runs-in-bulk-i.mdx +++ b/support/models/articles/how-can-i-delete-multiple-runs-in-bulk-i.mdx @@ -1,5 +1,6 @@ --- title: "How can I delete multiple runs in bulk instead of one at a time?" +description: "Learn how to delete multiple runs in bulk instead of one at a time in W&B." keywords: ["Projects", "Runs"] --- diff --git a/support/models/articles/how-can-i-delete-my-user-account.mdx b/support/models/articles/how-can-i-delete-my-user-account.mdx index 2bfaa8fd69..fbe79331e0 100644 --- a/support/models/articles/how-can-i-delete-my-user-account.mdx +++ b/support/models/articles/how-can-i-delete-my-user-account.mdx @@ -1,5 +1,6 @@ --- title: "How can I delete my user account?" +description: "Learn how to delete your W&B user account in W&B: Delete your user account by clicking Delete account in your user settings." keywords: ["User Management"] --- diff --git a/support/models/articles/how-can-i-disable-logging-of-system-metr.mdx b/support/models/articles/how-can-i-disable-logging-of-system-metr.mdx index 45a5ea779d..713f4412fe 100644 --- a/support/models/articles/how-can-i-disable-logging-of-system-metr.mdx +++ b/support/models/articles/how-can-i-disable-logging-of-system-metr.mdx @@ -1,5 +1,6 @@ --- title: "How can I disable logging of system metrics to W&B?" +description: "Learn how to disable logging of system metrics to W&B in W&B: To disable logging of system metrics, set `_disable_stats` to `True`:" keywords: ["Metrics", "Runs"] --- diff --git a/support/models/articles/how-can-i-fetch-these-version-ids-and-et.mdx b/support/models/articles/how-can-i-fetch-these-version-ids-and-et.mdx index d738ed0727..3f8d674b9d 100644 --- a/support/models/articles/how-can-i-fetch-these-version-ids-and-et.mdx +++ b/support/models/articles/how-can-i-fetch-these-version-ids-and-et.mdx @@ -1,5 +1,6 @@ --- title: "How can I fetch these Version IDs and ETags in W&B?" +description: "Learn how to fetch these Version IDs and ETags in W&B: If an artifact reference is logged with W&B and versioning is enabled on the buckets, the version IDs..." keywords: ["Artifacts"] --- diff --git a/support/models/articles/how-can-i-find-the-artifacts-logged-or-c.mdx b/support/models/articles/how-can-i-find-the-artifacts-logged-or-c.mdx index 27463e6fb3..edf6b01a34 100644 --- a/support/models/articles/how-can-i-find-the-artifacts-logged-or-c.mdx +++ b/support/models/articles/how-can-i-find-the-artifacts-logged-or-c.mdx @@ -1,5 +1,6 @@ --- title: "How can I find the artifacts logged or consumed by a run? How can I find the runs that produced or consumed an artifact?" +description: "Find the artifacts logged or consumed by a W&B run, and find the runs that produced or consumed a given artifact." keywords: ["Artifacts"] --- diff --git a/support/models/articles/how-can-i-fix-an-error-like-attributeerr.mdx b/support/models/articles/how-can-i-fix-an-error-like-attributeerr.mdx index 974a593172..37ec6d407d 100644 --- a/support/models/articles/how-can-i-fix-an-error-like-attributeerr.mdx +++ b/support/models/articles/how-can-i-fix-an-error-like-attributeerr.mdx @@ -1,5 +1,6 @@ --- title: "How can I fix an error like `AttributeError: module 'wandb' has no attribute ...`?" +description: "Learn how to fix an error like `AttributeError: module 'wandb' has no attribute ...` in W&B." keywords: ["Run Crashes"] --- diff --git a/support/models/articles/how-can-i-log-a-metric-that-doesnt-chang.mdx b/support/models/articles/how-can-i-log-a-metric-that-doesnt-chang.mdx index 9c924c5bac..d81608695d 100644 --- a/support/models/articles/how-can-i-log-a-metric-that-doesnt-chang.mdx +++ b/support/models/articles/how-can-i-log-a-metric-that-doesnt-chang.mdx @@ -1,5 +1,6 @@ --- title: "How can I log a metric that doesn't change over time such as a final evaluation accuracy?" +description: "Learn how to log a metric that doesn't change over time such as a final evaluation accuracy in W&B." keywords: ["Runs"] --- diff --git a/support/models/articles/how-can-i-log-additional-metrics-after-a.mdx b/support/models/articles/how-can-i-log-additional-metrics-after-a.mdx index f0bb11be5a..b4121d8ae7 100644 --- a/support/models/articles/how-can-i-log-additional-metrics-after-a.mdx +++ b/support/models/articles/how-can-i-log-additional-metrics-after-a.mdx @@ -1,5 +1,6 @@ --- title: "How can I log additional metrics after a run completes?" +description: "Learn how to log additional metrics after a run completes in W&B: There are several ways to manage experiments." keywords: ["Runs", "Metrics"] --- diff --git a/support/models/articles/how-can-i-log-in-to-wb-server.mdx b/support/models/articles/how-can-i-log-in-to-wb-server.mdx index 5075160ba0..198b0fecf2 100644 --- a/support/models/articles/how-can-i-log-in-to-wb-server.mdx +++ b/support/models/articles/how-can-i-log-in-to-wb-server.mdx @@ -1,5 +1,6 @@ --- title: "How can I log in to W&B Server?" +description: "Log in to W&B Server by setting the `WANDB_BASE_URL` environment variable to your Server URL or configuring it in the SDK settings." keywords: ["User Management"] --- diff --git a/support/models/articles/how-can-i-organize-my-logged-charts-and-.mdx b/support/models/articles/how-can-i-organize-my-logged-charts-and-.mdx index 5d002d8280..47d10d8a7a 100644 --- a/support/models/articles/how-can-i-organize-my-logged-charts-and-.mdx +++ b/support/models/articles/how-can-i-organize-my-logged-charts-and-.mdx @@ -1,5 +1,6 @@ --- title: "How can I organize my logged charts and media in the W&B UI?" +description: "Learn how to organize your logged charts and media in W&B: The `/` character separates logged panels in the W&B UI." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-can-i-overwrite-the-logs-from-previo.mdx b/support/models/articles/how-can-i-overwrite-the-logs-from-previo.mdx index 9985be3356..4b9fa0803d 100644 --- a/support/models/articles/how-can-i-overwrite-the-logs-from-previo.mdx +++ b/support/models/articles/how-can-i-overwrite-the-logs-from-previo.mdx @@ -1,5 +1,6 @@ --- title: "How can I overwrite the logs from previous steps?" +description: "Learn how to overwrite the logs from previous steps in W&B: To overwrite logs from previous steps, use forking and rewind." keywords: ["Logs", "Metrics"] --- diff --git a/support/models/articles/how-can-i-regain-access-to-my-account-if.mdx b/support/models/articles/how-can-i-regain-access-to-my-account-if.mdx index 3f22e774f8..efab239ef8 100644 --- a/support/models/articles/how-can-i-regain-access-to-my-account-if.mdx +++ b/support/models/articles/how-can-i-regain-access-to-my-account-if.mdx @@ -1,5 +1,6 @@ --- title: "How can I regain access to my account if I cannot receive a password reset email?" +description: "Learn how to regain access to your W&B account when you cannot receive a password reset email in W&B." keywords: ["User Management"] --- diff --git a/support/models/articles/how-can-i-remove-projects-from-a-team-sp.mdx b/support/models/articles/how-can-i-remove-projects-from-a-team-sp.mdx index f4952bffe4..3b72160433 100644 --- a/support/models/articles/how-can-i-remove-projects-from-a-team-sp.mdx +++ b/support/models/articles/how-can-i-remove-projects-from-a-team-sp.mdx @@ -1,5 +1,6 @@ --- title: "How can I remove projects from a team space without admin privileges?" +description: "Learn how to remove projects from a team space without admin privileges in W&B." keywords: ["Administrator"] --- diff --git a/support/models/articles/how-can-i-resolve-login-issues-with-my-a.mdx b/support/models/articles/how-can-i-resolve-login-issues-with-my-a.mdx index de5ba4e796..024c729fc0 100644 --- a/support/models/articles/how-can-i-resolve-login-issues-with-my-a.mdx +++ b/support/models/articles/how-can-i-resolve-login-issues-with-my-a.mdx @@ -1,5 +1,6 @@ --- title: "How can I resolve login issues with my account?" +description: "Resolve W&B login issues by verifying access, checking your API key, confirming the correct account, and reviewing the login URL." keywords: ["User Management"] --- diff --git a/support/models/articles/how-can-i-resolve-the-filestream-rate-li.mdx b/support/models/articles/how-can-i-resolve-the-filestream-rate-li.mdx index 696ffbfa48..5cb7c028c4 100644 --- a/support/models/articles/how-can-i-resolve-the-filestream-rate-li.mdx +++ b/support/models/articles/how-can-i-resolve-the-filestream-rate-li.mdx @@ -1,5 +1,6 @@ --- title: "How can I resolve the Filestream rate limit exceeded error?" +description: "Learn how to resolve the Filestream rate limit exceeded error in W&B: To resolve the \"Filestream rate limit exceeded\" error in W&B, follow these steps:..." keywords: ["Connectivity", "Outage"] --- diff --git a/support/models/articles/how-can-i-resume-a-sweep-using-python-co.mdx b/support/models/articles/how-can-i-resume-a-sweep-using-python-co.mdx index 5e0239bc2a..9349510ec0 100644 --- a/support/models/articles/how-can-i-resume-a-sweep-using-python-co.mdx +++ b/support/models/articles/how-can-i-resume-a-sweep-using-python-co.mdx @@ -1,5 +1,6 @@ --- title: "How can I resume a sweep using Python code?" +description: "Learn how to resume a sweep using Python code in W&B: To resume a sweep, pass the `sweep_id` to the `wandb.agent()` function." keywords: ["Sweeps", "Python"] --- diff --git a/support/models/articles/how-can-i-rotate-or-revoke-access.mdx b/support/models/articles/how-can-i-rotate-or-revoke-access.mdx index d17ff42a13..340b39ec7a 100644 --- a/support/models/articles/how-can-i-rotate-or-revoke-access.mdx +++ b/support/models/articles/how-can-i-rotate-or-revoke-access.mdx @@ -1,5 +1,6 @@ --- title: "How can I rotate or revoke access?" +description: "Learn how to rotate or revoke access in W&B: Personal and service account keys can be rotated or revoked." keywords: ["Administrator", "Security"] --- diff --git a/support/models/articles/how-can-i-save-the-git-commit-associated.mdx b/support/models/articles/how-can-i-save-the-git-commit-associated.mdx index 86eef891fc..46e12bc10f 100644 --- a/support/models/articles/how-can-i-save-the-git-commit-associated.mdx +++ b/support/models/articles/how-can-i-save-the-git-commit-associated.mdx @@ -1,5 +1,6 @@ --- title: "How can I save the git commit associated with my run?" +description: "Learn how to save the git commit associated with your run in W&B: When `wandb.init` is invoked, the system automatically collects git information, including..." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-can-i-see-files-that-do-not-appear-i.mdx b/support/models/articles/how-can-i-see-files-that-do-not-appear-i.mdx index acb667700f..7417710045 100644 --- a/support/models/articles/how-can-i-see-files-that-do-not-appear-i.mdx +++ b/support/models/articles/how-can-i-see-files-that-do-not-appear-i.mdx @@ -1,5 +1,6 @@ --- title: "How can I see files that do not appear in the Files tab?" +description: "Learn how to see files that do not appear in the Files tab in W&B: The Files tab shows a maximum of 10,000 files." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-can-i-see-the-bytes-stored-bytes-tra.mdx b/support/models/articles/how-can-i-see-the-bytes-stored-bytes-tra.mdx index ee34380432..1133c2574a 100644 --- a/support/models/articles/how-can-i-see-the-bytes-stored-bytes-tra.mdx +++ b/support/models/articles/how-can-i-see-the-bytes-stored-bytes-tra.mdx @@ -1,5 +1,6 @@ --- title: "How can I see the bytes stored, bytes tracked and tracked hours of my organization?" +description: "Learn how to see the bytes stored, bytes tracked and tracked hours of your organization in W&B." keywords: ["Administrator"] --- diff --git a/support/models/articles/how-can-i-send-run-alerts-to-microsoft-t.mdx b/support/models/articles/how-can-i-send-run-alerts-to-microsoft-t.mdx index ef6a99e069..46e5635183 100644 --- a/support/models/articles/how-can-i-send-run-alerts-to-microsoft-t.mdx +++ b/support/models/articles/how-can-i-send-run-alerts-to-microsoft-t.mdx @@ -1,5 +1,6 @@ --- title: "How can I send run alerts to Microsoft Teams?" +description: "Learn how to send run alerts to Microsoft Teams in W&B: To receive W&B alerts in Teams, follow these steps: - Set up an email address for your Teams channel." keywords: ["Alerts"] --- diff --git a/support/models/articles/how-can-i-use-wandb-with-multiprocessing.mdx b/support/models/articles/how-can-i-use-wandb-with-multiprocessing.mdx index 8af9abde09..d55fda6bb1 100644 --- a/support/models/articles/how-can-i-use-wandb-with-multiprocessing.mdx +++ b/support/models/articles/how-can-i-use-wandb-with-multiprocessing.mdx @@ -1,5 +1,6 @@ --- title: "How can I use wandb with multiprocessing, e.g. distributed training?" +description: "Learn how to use wandb with multiprocessing, e.g. distributed training in W&B." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-do-i-add-plotly-or-bokeh-charts-into.mdx b/support/models/articles/how-do-i-add-plotly-or-bokeh-charts-into.mdx index 536cc49d8a..7c1ced0741 100644 --- a/support/models/articles/how-do-i-add-plotly-or-bokeh-charts-into.mdx +++ b/support/models/articles/how-do-i-add-plotly-or-bokeh-charts-into.mdx @@ -1,5 +1,6 @@ --- title: "How do I add Plotly or Bokeh Charts into Tables?" +description: "Learn how to add Plotly or Bokeh Charts into Tables in W&B: Direct integration of Plotly or Bokeh figures into tables is not supported." keywords: ["Experiments", "Tables", "Charts"] --- diff --git a/support/models/articles/how-do-i-best-log-models-from-runs-in-a-.mdx b/support/models/articles/how-do-i-best-log-models-from-runs-in-a-.mdx index 2ba96b82d1..879eee2b83 100644 --- a/support/models/articles/how-do-i-best-log-models-from-runs-in-a-.mdx +++ b/support/models/articles/how-do-i-best-log-models-from-runs-in-a-.mdx @@ -1,5 +1,6 @@ --- title: "How do I best log models from runs in a sweep?" +description: "Learn how to best log models from runs in a sweep in W&B: One effective approach for logging models in a sweep involves creating a model artifact for the sweep." keywords: ["Artifacts", "Sweeps"] --- diff --git a/support/models/articles/how-do-i-cancel-my-subscription.mdx b/support/models/articles/how-do-i-cancel-my-subscription.mdx index b148ef3d56..d0af75dabd 100644 --- a/support/models/articles/how-do-i-cancel-my-subscription.mdx +++ b/support/models/articles/how-do-i-cancel-my-subscription.mdx @@ -1,5 +1,6 @@ --- title: "How do I cancel my subscription?" +description: "Cancel your W&B subscription by contacting the W&B support team at support@wandb.com." keywords: ["Administrator"] --- diff --git a/support/models/articles/how-do-i-change-my-billing-address.mdx b/support/models/articles/how-do-i-change-my-billing-address.mdx index d10ac818d1..cf5f6c05b1 100644 --- a/support/models/articles/how-do-i-change-my-billing-address.mdx +++ b/support/models/articles/how-do-i-change-my-billing-address.mdx @@ -1,5 +1,6 @@ --- title: "How do I change my billing address?" +description: "Learn how to change your billing address in W&B: To change the billing address, contact the support team (support@wandb.com)." keywords: ["Administrator", "Billing"] --- diff --git a/support/models/articles/how-do-i-deal-with-network-issues.mdx b/support/models/articles/how-do-i-deal-with-network-issues.mdx index dd299f78c3..bdf64c10ec 100644 --- a/support/models/articles/how-do-i-deal-with-network-issues.mdx +++ b/support/models/articles/how-do-i-deal-with-network-issues.mdx @@ -1,5 +1,6 @@ --- title: "How do I deal with network issues?" +description: "Learn how to deal with network issues in W&B: If you encounter SSL or network errors, such as `wandb: Network error (ConnectionError), entering retry loop`,..." keywords: ["Connectivity"] --- diff --git a/support/models/articles/how-do-i-delete-a-panel-grid.mdx b/support/models/articles/how-do-i-delete-a-panel-grid.mdx index 9af1823b05..f0fc1e9a74 100644 --- a/support/models/articles/how-do-i-delete-a-panel-grid.mdx +++ b/support/models/articles/how-do-i-delete-a-panel-grid.mdx @@ -1,5 +1,6 @@ --- title: "How do I delete a panel grid?" +description: "Learn how to delete a panel grid in W&B: Select the panel grid and press delete or backspace." keywords: ["Reports", "Wysiwyg"] --- diff --git a/support/models/articles/how-do-i-delete-a-team-from-my-account.mdx b/support/models/articles/how-do-i-delete-a-team-from-my-account.mdx index 5d075e6537..f403f3fea0 100644 --- a/support/models/articles/how-do-i-delete-a-team-from-my-account.mdx +++ b/support/models/articles/how-do-i-delete-a-team-from-my-account.mdx @@ -1,5 +1,6 @@ --- title: "How do I delete a team from my account?" +description: "Delete a team from your W&B account by accessing team settings as an admin and choosing the delete option." keywords: ["Administrator", "Team Management"] --- diff --git a/support/models/articles/how-do-i-delete-my-organization-account.mdx b/support/models/articles/how-do-i-delete-my-organization-account.mdx index aeca258af8..f399b7ac7e 100644 --- a/support/models/articles/how-do-i-delete-my-organization-account.mdx +++ b/support/models/articles/how-do-i-delete-my-organization-account.mdx @@ -1,5 +1,6 @@ --- title: "How do I delete my organization account?" +description: "Learn how to delete your W&B organization account in W&B: To delete an organization account, follow these steps, contact the support team (support@wandb.com)." keywords: ["Administrator"] --- diff --git a/support/models/articles/how-do-i-downgrade-my-subscription-plan.mdx b/support/models/articles/how-do-i-downgrade-my-subscription-plan.mdx index 33f571fa72..faf659ca60 100644 --- a/support/models/articles/how-do-i-downgrade-my-subscription-plan.mdx +++ b/support/models/articles/how-do-i-downgrade-my-subscription-plan.mdx @@ -1,5 +1,6 @@ --- title: "How do I downgrade my subscription plan?" +description: "Learn how to downgrade your W&B subscription plan in W&B: To downgrade a subscription plan, contact the support team at support@wandb.com with your current..." keywords: ["Billing", "Administrator"] --- diff --git a/support/models/articles/how-do-i-enable-code-logging-with-sweeps.mdx b/support/models/articles/how-do-i-enable-code-logging-with-sweeps.mdx index 433e5bc205..6545e604b0 100644 --- a/support/models/articles/how-do-i-enable-code-logging-with-sweeps.mdx +++ b/support/models/articles/how-do-i-enable-code-logging-with-sweeps.mdx @@ -1,5 +1,6 @@ --- title: "How do I enable code logging with Sweeps?" +description: "Learn how to enable code logging with Sweeps in W&B: To enable code logging for sweeps, add `wandb.log_code()` after initializing the W&B Run." keywords: ["Sweeps"] --- diff --git a/support/models/articles/how-do-i-export-a-list-of-users-from-my-.mdx b/support/models/articles/how-do-i-export-a-list-of-users-from-my-.mdx index 09c787e707..aa7b84dee0 100644 --- a/support/models/articles/how-do-i-export-a-list-of-users-from-my-.mdx +++ b/support/models/articles/how-do-i-export-a-list-of-users-from-my-.mdx @@ -1,5 +1,6 @@ --- title: "How do I export a list of users from my W&B Organisation?" +description: "Export a list of users from your W&B organization for auditing, reporting, or migration purposes." keywords: ["Administrator", "User Management"] --- diff --git a/support/models/articles/how-do-i-find-an-artifact-from-the-best-.mdx b/support/models/articles/how-do-i-find-an-artifact-from-the-best-.mdx index 839dcaefa2..297130d3d0 100644 --- a/support/models/articles/how-do-i-find-an-artifact-from-the-best-.mdx +++ b/support/models/articles/how-do-i-find-an-artifact-from-the-best-.mdx @@ -1,5 +1,6 @@ --- title: "How do I find an artifact from the best run in a sweep?" +description: "Learn how to find an artifact from the best run in a sweep in W&B: To retrieve artifacts from the best performing run in a sweep, use the following code:" keywords: ["Artifacts"] --- diff --git a/support/models/articles/how-do-i-find-my-api-key.mdx b/support/models/articles/how-do-i-find-my-api-key.mdx index 70de3b1d34..443a0a8e11 100644 --- a/support/models/articles/how-do-i-find-my-api-key.mdx +++ b/support/models/articles/how-do-i-find-my-api-key.mdx @@ -1,5 +1,6 @@ --- title: "How do I find my API key?" +description: "Find your W&B API key in your User Settings page so you can authenticate the W&B SDK and CLI." keywords: ["Security", "User Management"] --- diff --git a/support/models/articles/how-do-i-fix-invalid-authentication-401-.mdx b/support/models/articles/how-do-i-fix-invalid-authentication-401-.mdx index b232c7dc0f..cf3cb916f0 100644 --- a/support/models/articles/how-do-i-fix-invalid-authentication-401-.mdx +++ b/support/models/articles/how-do-i-fix-invalid-authentication-401-.mdx @@ -1,5 +1,6 @@ --- title: "How do I fix Invalid Authentication (401) errors with W&B Inference?" +description: "Fix Invalid Authentication (401) errors with W&B Inference, typically caused by incorrect API credentials or project entity." keywords: ["Inference"] --- diff --git a/support/models/articles/how-do-i-fix-server-errors-500-503-with-.mdx b/support/models/articles/how-do-i-fix-server-errors-500-503-with-.mdx index bfafd84b6a..6f28e44a7a 100644 --- a/support/models/articles/how-do-i-fix-server-errors-500-503-with-.mdx +++ b/support/models/articles/how-do-i-fix-server-errors-500-503-with-.mdx @@ -1,5 +1,6 @@ --- title: "How do I fix server errors (500, 503) with W&B Inference?" +description: "Fix server errors (500, 503) with W&B Inference. These errors indicate temporary issues with the inference service that usually clear with a retry." keywords: ["Inference"] --- diff --git a/support/models/articles/how-do-i-fix-the-error-resumemust-but-ru.mdx b/support/models/articles/how-do-i-fix-the-error-resumemust-but-ru.mdx index db11660d22..ccc8d71898 100644 --- a/support/models/articles/how-do-i-fix-the-error-resumemust-but-ru.mdx +++ b/support/models/articles/how-do-i-fix-the-error-resumemust-but-ru.mdx @@ -1,5 +1,6 @@ --- title: "How do I fix the error `resume='must' but run () doesn't exist`?" +description: "Learn how to fix the error `resume='must' but run () doesn't exist` in W&B." keywords: ["Resuming", "Runs"] --- diff --git a/support/models/articles/how-do-i-fix-the-overflows-maximum-value.mdx b/support/models/articles/how-do-i-fix-the-overflows-maximum-value.mdx index f8650fcee7..e50e6a4573 100644 --- a/support/models/articles/how-do-i-fix-the-overflows-maximum-value.mdx +++ b/support/models/articles/how-do-i-fix-the-overflows-maximum-value.mdx @@ -1,5 +1,6 @@ --- title: "How do I fix the 'overflows maximum values of a signed 64 bits integer' error?" +description: "Learn how to fix the 'overflows maximum values of a signed 64 bits integer' error in W&B." keywords: ["Workspaces"] --- diff --git a/support/models/articles/how-do-i-get-added-to-a-team-on-wb.mdx b/support/models/articles/how-do-i-get-added-to-a-team-on-wb.mdx index 8d93063e31..34a9dc7c6e 100644 --- a/support/models/articles/how-do-i-get-added-to-a-team-on-wb.mdx +++ b/support/models/articles/how-do-i-get-added-to-a-team-on-wb.mdx @@ -1,5 +1,6 @@ --- title: "How do I get added to a team on W&B?" +description: "Learn how to get added to a team on W&B in W&B: To join a team, follow these steps: - Contact a team admin or someone with administrative privileges to..." keywords: ["Administrator", "Team Management"] --- diff --git a/support/models/articles/how-do-i-get-the-random-run-name-in-my-s.mdx b/support/models/articles/how-do-i-get-the-random-run-name-in-my-s.mdx index 4259fcbe6c..e046643b1e 100644 --- a/support/models/articles/how-do-i-get-the-random-run-name-in-my-s.mdx +++ b/support/models/articles/how-do-i-get-the-random-run-name-in-my-s.mdx @@ -1,5 +1,6 @@ --- title: "How do I get the random run name in my script?" +description: "Learn how to get the random run name in your script in W&B: Call a run object's `.save()` method to save the current run." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-do-i-handle-the-failed-to-query-for-.mdx b/support/models/articles/how-do-i-handle-the-failed-to-query-for-.mdx index 09c8b3d7ec..b81aa38152 100644 --- a/support/models/articles/how-do-i-handle-the-failed-to-query-for-.mdx +++ b/support/models/articles/how-do-i-handle-the-failed-to-query-for-.mdx @@ -1,5 +1,6 @@ --- title: "How do I handle the 'Failed to query for notebook' error?" +description: "Learn how to handle the 'Failed to query for notebook' error in W&B: If you encounter the error message `\"Failed to query for notebook name, you can set it..." keywords: ["Notebooks", "Environment Variables"] --- diff --git a/support/models/articles/how-do-i-insert-a-table.mdx b/support/models/articles/how-do-i-insert-a-table.mdx index 06402dd060..a4d749d659 100644 --- a/support/models/articles/how-do-i-insert-a-table.mdx +++ b/support/models/articles/how-do-i-insert-a-table.mdx @@ -1,5 +1,6 @@ --- title: "How do I insert a table?" +description: "Learn how to insert a table in W&B: Tables remain the only feature from Markdown without a direct WYSIWYG equivalent." keywords: ["Reports", "Wysiwyg", "Tables"] --- diff --git a/support/models/articles/how-do-i-install-the-wandb-python-librar.mdx b/support/models/articles/how-do-i-install-the-wandb-python-librar.mdx index 1c2268f64d..6608c97e3d 100644 --- a/support/models/articles/how-do-i-install-the-wandb-python-librar.mdx +++ b/support/models/articles/how-do-i-install-the-wandb-python-librar.mdx @@ -1,5 +1,6 @@ --- title: "How do I install the wandb Python library in environments without gcc?" +description: "Learn how to install the wandb Python library in environments without gcc in W&B." keywords: ["Python"] --- diff --git a/support/models/articles/how-do-i-kill-a-job-with-wandb.mdx b/support/models/articles/how-do-i-kill-a-job-with-wandb.mdx index 0324b4f5fc..34cf899859 100644 --- a/support/models/articles/how-do-i-kill-a-job-with-wandb.mdx +++ b/support/models/articles/how-do-i-kill-a-job-with-wandb.mdx @@ -1,5 +1,6 @@ --- title: "How do I kill a job with wandb?" +description: "Learn how to kill a job with wandb in W&B: Press `Ctrl+D` on the keyboard to stop a script instrumented with W&B." keywords: ["Run Crashes"] --- diff --git a/support/models/articles/how-do-i-launch-multiple-runs-from-one-s.mdx b/support/models/articles/how-do-i-launch-multiple-runs-from-one-s.mdx index b8cc506dfc..cdf11ff9a7 100644 --- a/support/models/articles/how-do-i-launch-multiple-runs-from-one-s.mdx +++ b/support/models/articles/how-do-i-launch-multiple-runs-from-one-s.mdx @@ -1,5 +1,6 @@ --- title: "How do I launch multiple runs from one script?" +description: "Learn how to launch multiple runs from one script in W&B: Finish previous runs before starting new runs to log multiple runs within a single script." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-do-i-log-a-list-of-values.mdx b/support/models/articles/how-do-i-log-a-list-of-values.mdx index 8664538560..26c90ea0ea 100644 --- a/support/models/articles/how-do-i-log-a-list-of-values.mdx +++ b/support/models/articles/how-do-i-log-a-list-of-values.mdx @@ -1,5 +1,6 @@ --- title: "How do I log a list of values?" +description: "Learn how to log a list of values in W&B: These examples show logging losses a couple of different ways using `wandb.Run.log()`." keywords: ["Logs", "Experiments"] --- diff --git a/support/models/articles/how-do-i-log-an-artifact-to-an-existing-.mdx b/support/models/articles/how-do-i-log-an-artifact-to-an-existing-.mdx index 7f6543047d..1648a88cb7 100644 --- a/support/models/articles/how-do-i-log-an-artifact-to-an-existing-.mdx +++ b/support/models/articles/how-do-i-log-an-artifact-to-an-existing-.mdx @@ -1,5 +1,6 @@ --- title: "How do I log an artifact to an existing run?" +description: "Learn how to log an artifact to an existing run in W&B: Occasionally, it is necessary to mark an artifact as the output of a previously logged run." keywords: ["Artifacts"] --- diff --git a/support/models/articles/how-do-i-log-runs-launched-by-continuous.mdx b/support/models/articles/how-do-i-log-runs-launched-by-continuous.mdx index f66b4d169c..f14ddc02d6 100644 --- a/support/models/articles/how-do-i-log-runs-launched-by-continuous.mdx +++ b/support/models/articles/how-do-i-log-runs-launched-by-continuous.mdx @@ -1,5 +1,6 @@ --- title: "How do I log runs launched by continuous integration or internal tools?" +description: "Learn how to log runs launched by continuous integration or internal tools in W&B." keywords: ["Runs", "Logs"] --- diff --git a/support/models/articles/how-do-i-log-to-the-right-wandb-user-on-.mdx b/support/models/articles/how-do-i-log-to-the-right-wandb-user-on-.mdx index a17e16c781..ed02ecbf65 100644 --- a/support/models/articles/how-do-i-log-to-the-right-wandb-user-on-.mdx +++ b/support/models/articles/how-do-i-log-to-the-right-wandb-user-on-.mdx @@ -1,5 +1,6 @@ --- title: "How do I log to the right wandb user on a shared machine?" +description: "Learn how to log to the right wandb user on a shared machine in W&B: When using a shared machine, ensure that runs log to the correct WandB account by..." keywords: ["Logs"] --- diff --git a/support/models/articles/how-do-i-plot-multiple-lines-on-a-plot-w.mdx b/support/models/articles/how-do-i-plot-multiple-lines-on-a-plot-w.mdx index 053cbea69e..e7cb1c8181 100644 --- a/support/models/articles/how-do-i-plot-multiple-lines-on-a-plot-w.mdx +++ b/support/models/articles/how-do-i-plot-multiple-lines-on-a-plot-w.mdx @@ -1,5 +1,6 @@ --- title: "How do I plot multiple lines on a plot with a legend?" +description: "Learn how to plot multiple lines on a plot with a legend in W&B: Create a multi-line custom chart with `wandb.plot.line_series()`." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-do-i-programmatically-access-the-hum.mdx b/support/models/articles/how-do-i-programmatically-access-the-hum.mdx index 8467c226a8..dcfeb264e3 100644 --- a/support/models/articles/how-do-i-programmatically-access-the-hum.mdx +++ b/support/models/articles/how-do-i-programmatically-access-the-hum.mdx @@ -1,5 +1,6 @@ --- title: "How do I programmatically access the human-readable run name?" +description: "Learn how to programmatically access the human-readable run name in W&B." keywords: ["Experiments"] --- diff --git a/support/models/articles/how-do-i-rename-a-project.mdx b/support/models/articles/how-do-i-rename-a-project.mdx index e76963ed3a..2c7be8953f 100644 --- a/support/models/articles/how-do-i-rename-a-project.mdx +++ b/support/models/articles/how-do-i-rename-a-project.mdx @@ -1,5 +1,6 @@ --- title: "How do I rename a project?" +description: "Learn how to rename a project in W&B: To rename a project: - Navigate to the Project overview." keywords: ["Projects"] --- diff --git a/support/models/articles/how-do-i-renew-my-expired-license.mdx b/support/models/articles/how-do-i-renew-my-expired-license.mdx index 658ae130a3..767d8236c8 100644 --- a/support/models/articles/how-do-i-renew-my-expired-license.mdx +++ b/support/models/articles/how-do-i-renew-my-expired-license.mdx @@ -1,5 +1,6 @@ --- title: "How do I renew my expired license?" +description: "Renew an expired W&B license by contacting the W&B support team at support@wandb.com for assistance with the renewal process." keywords: ["Administrator"] --- diff --git a/support/models/articles/how-do-i-request-the-complete-deletion-o.mdx b/support/models/articles/how-do-i-request-the-complete-deletion-o.mdx index b7c4c67183..fdfa1f535f 100644 --- a/support/models/articles/how-do-i-request-the-complete-deletion-o.mdx +++ b/support/models/articles/how-do-i-request-the-complete-deletion-o.mdx @@ -1,5 +1,6 @@ --- title: "How do I request the complete deletion of my W&B account?" +description: "Request the complete deletion of your W&B account, including all data and resources, by contacting W&B support." keywords: ["User Management"] --- diff --git a/support/models/articles/how-do-i-resolve-a-run-initialization-ti.mdx b/support/models/articles/how-do-i-resolve-a-run-initialization-ti.mdx index d21daf9b97..49210b89b2 100644 --- a/support/models/articles/how-do-i-resolve-a-run-initialization-ti.mdx +++ b/support/models/articles/how-do-i-resolve-a-run-initialization-ti.mdx @@ -1,5 +1,6 @@ --- title: "How do I resolve a run initialization timeout error in wandb?" +description: "Learn how to resolve a run initialization timeout error in wandb in W&B." keywords: ["Connectivity", "Run Crashes"] --- diff --git a/support/models/articles/how-do-i-resolve-permission-errors-when-.mdx b/support/models/articles/how-do-i-resolve-permission-errors-when-.mdx index 2d0fbccbd1..9c409bcc1d 100644 --- a/support/models/articles/how-do-i-resolve-permission-errors-when-.mdx +++ b/support/models/articles/how-do-i-resolve-permission-errors-when-.mdx @@ -1,5 +1,6 @@ --- title: "How do I resolve permission errors when logging a run?" +description: "Learn how to resolve permission errors when logging a run in W&B: To resolve permission errors when logging a run to a W&B entity, follow these steps: -..." keywords: ["Runs", "Security"] --- diff --git a/support/models/articles/how-do-i-save-code.mdx b/support/models/articles/how-do-i-save-code.mdx index dd8d53c30a..8d31ced3d4 100644 --- a/support/models/articles/how-do-i-save-code.mdx +++ b/support/models/articles/how-do-i-save-code.mdx @@ -1,5 +1,6 @@ --- title: "How do I save code?‌" +description: "Learn how to save code?‌ in W&B: Use `save_code=True` in `wandb.init` to save the main script or notebook that launches the run." keywords: ["Artifacts"] --- diff --git a/support/models/articles/how-do-i-set-a-retention-or-expiration-p.mdx b/support/models/articles/how-do-i-set-a-retention-or-expiration-p.mdx index f56cd3062f..bd4790bf8c 100644 --- a/support/models/articles/how-do-i-set-a-retention-or-expiration-p.mdx +++ b/support/models/articles/how-do-i-set-a-retention-or-expiration-p.mdx @@ -1,5 +1,6 @@ --- title: "How do I set a retention or expiration policy on my artifact?" +description: "Learn how to set a retention or expiration policy on your artifact in W&B." keywords: ["Artifacts"] --- diff --git a/support/models/articles/how-do-i-silence-wb-info-messages.mdx b/support/models/articles/how-do-i-silence-wb-info-messages.mdx index 1c8f06301e..57df04afd6 100644 --- a/support/models/articles/how-do-i-silence-wb-info-messages.mdx +++ b/support/models/articles/how-do-i-silence-wb-info-messages.mdx @@ -1,5 +1,6 @@ --- title: "How do I silence W&B info messages?" +description: "Learn how to silence W&B info messages in W&B: To suppress log messages in your notebook such as this: Set the log level to `logging.ERROR` to only show..." keywords: ["Notebooks", "Environment Variables"] --- diff --git a/support/models/articles/how-do-i-stop-wandb-from-writing-to-my-t.mdx b/support/models/articles/how-do-i-stop-wandb-from-writing-to-my-t.mdx index cb6084d793..bae662411b 100644 --- a/support/models/articles/how-do-i-stop-wandb-from-writing-to-my-t.mdx +++ b/support/models/articles/how-do-i-stop-wandb-from-writing-to-my-t.mdx @@ -1,5 +1,6 @@ --- title: "How do I stop wandb from writing to my terminal or my Jupyter notebook output?" +description: "Learn how to stop wandb from writing to your terminal or your Jupyter notebook output in W&B." keywords: ["Environment Variables"] --- diff --git a/support/models/articles/how-do-i-switch-between-accounts-on-the-.mdx b/support/models/articles/how-do-i-switch-between-accounts-on-the-.mdx index 317e01d96c..5335d1dd4d 100644 --- a/support/models/articles/how-do-i-switch-between-accounts-on-the-.mdx +++ b/support/models/articles/how-do-i-switch-between-accounts-on-the-.mdx @@ -1,5 +1,6 @@ --- title: "How do I switch between accounts on the same machine?" +description: "Learn how to switch between accounts on the same machine in W&B: To manage two W&B accounts from the same machine, store both API keys in a file." keywords: ["Environment Variables"] --- diff --git a/support/models/articles/how-do-i-turn-off-logging.mdx b/support/models/articles/how-do-i-turn-off-logging.mdx index aeded7773d..ce4ed95e33 100644 --- a/support/models/articles/how-do-i-turn-off-logging.mdx +++ b/support/models/articles/how-do-i-turn-off-logging.mdx @@ -1,5 +1,6 @@ --- title: "How do I turn off logging?" +description: "Learn how to turn off logging in W&B: The command `wandb offline` sets the environment variable `WANDB_MODE=offline`, preventing data from syncing to the..." keywords: ["Logs"] --- diff --git a/support/models/articles/how-do-i-use-custom-cli-commands-with-sw.mdx b/support/models/articles/how-do-i-use-custom-cli-commands-with-sw.mdx index 85fb68f797..e3c8adfc96 100644 --- a/support/models/articles/how-do-i-use-custom-cli-commands-with-sw.mdx +++ b/support/models/articles/how-do-i-use-custom-cli-commands-with-sw.mdx @@ -1,5 +1,6 @@ --- title: "How do I use custom CLI commands with sweeps?" +description: "Learn how to use custom CLI commands with sweeps in W&B: You can use W&B Sweeps with custom CLI commands if training configuration passes command-line..." keywords: ["Sweeps"] featured: true --- diff --git a/support/models/articles/how-do-i-use-the-resume-parameter-when-r.mdx b/support/models/articles/how-do-i-use-the-resume-parameter-when-r.mdx index 6eb0bc8cdc..49e48ef533 100644 --- a/support/models/articles/how-do-i-use-the-resume-parameter-when-r.mdx +++ b/support/models/articles/how-do-i-use-the-resume-parameter-when-r.mdx @@ -1,5 +1,6 @@ --- title: "How do I use the resume parameter when resuming a run in W&B?" +description: "Learn how to use the resume parameter when resuming a run in W&B: To use the `resume` parameter in W&B , set the `resume` argument in `wandb.init()` with..." keywords: ["Resuming"] --- diff --git a/support/models/articles/how-do-we-update-our-payment-method.mdx b/support/models/articles/how-do-we-update-our-payment-method.mdx index da27e826da..cccc11d5ad 100644 --- a/support/models/articles/how-do-we-update-our-payment-method.mdx +++ b/support/models/articles/how-do-we-update-our-payment-method.mdx @@ -1,5 +1,6 @@ --- title: "How do we update our payment method?" +description: "Learn how to update our payment method in W&B: To update your payment method, follow these steps: 1." keywords: ["Billing"] --- diff --git a/support/models/articles/how-do-you-delete-a-custom-chart-preset.mdx b/support/models/articles/how-do-you-delete-a-custom-chart-preset.mdx index 9b7e9bb30c..fbb33c6339 100644 --- a/support/models/articles/how-do-you-delete-a-custom-chart-preset.mdx +++ b/support/models/articles/how-do-you-delete-a-custom-chart-preset.mdx @@ -1,5 +1,6 @@ --- title: "How do you delete a custom chart preset?" +description: "Learn how to delete a custom chart preset in W&B: Access the custom chart editor." keywords: ["Charts"] --- diff --git a/support/models/articles/how-do-you-show-a-step-slider-in-a-custo.mdx b/support/models/articles/how-do-you-show-a-step-slider-in-a-custo.mdx index 65e85049f0..a9b7d0eb29 100644 --- a/support/models/articles/how-do-you-show-a-step-slider-in-a-custo.mdx +++ b/support/models/articles/how-do-you-show-a-step-slider-in-a-custo.mdx @@ -1,5 +1,6 @@ --- title: "How do you show a 'step slider' in a custom chart?" +description: "Learn how to show a 'step slider' in a custom chart in W&B: Enable this option on the \"Other settings\" page of the custom chart editor." keywords: ["Charts"] --- diff --git a/support/models/articles/how-does-someone-without-an-account-see-.mdx b/support/models/articles/how-does-someone-without-an-account-see-.mdx index fb49c363ba..f7a315dcd9 100644 --- a/support/models/articles/how-does-someone-without-an-account-see-.mdx +++ b/support/models/articles/how-does-someone-without-an-account-see-.mdx @@ -1,5 +1,6 @@ --- title: "How does someone without an account see run results?" +description: "If someone runs the script with `anonymous=\"allow\"`: 1." keywords: ["Anonymous"] --- diff --git a/support/models/articles/how-does-wandb-stream-logs-and-writes-to.mdx b/support/models/articles/how-does-wandb-stream-logs-and-writes-to.mdx index dc103d2bcd..9fd4528c49 100644 --- a/support/models/articles/how-does-wandb-stream-logs-and-writes-to.mdx +++ b/support/models/articles/how-does-wandb-stream-logs-and-writes-to.mdx @@ -1,5 +1,6 @@ --- title: "How does wandb stream logs and writes to disk?" +description: "W&B queues events in memory and writes them to disk asynchronously to manage failures and support the `WANDB_MODE=offline` configuration, al" keywords: ["Environment Variables"] --- diff --git a/support/models/articles/how-is-wb-different-from-tensorboard.mdx b/support/models/articles/how-is-wb-different-from-tensorboard.mdx index 9e5d08b6e2..084380e379 100644 --- a/support/models/articles/how-is-wb-different-from-tensorboard.mdx +++ b/support/models/articles/how-is-wb-different-from-tensorboard.mdx @@ -1,5 +1,6 @@ --- title: "How is W&B different from TensorBoard?" +description: "W&B integrates with TensorBoard and improves experiment tracking tools." keywords: ["Tensorboard"] --- diff --git a/support/models/articles/how-many-runs-can-i-create-per-project.mdx b/support/models/articles/how-many-runs-can-i-create-per-project.mdx index e6b4149933..fd81be1530 100644 --- a/support/models/articles/how-many-runs-can-i-create-per-project.mdx +++ b/support/models/articles/how-many-runs-can-i-create-per-project.mdx @@ -1,5 +1,6 @@ --- title: "How many runs can I create per project?" +description: "Limit each project to approximately 10,000 runs for optimal performance." keywords: ["Projects", "Runs"] --- diff --git a/support/models/articles/how-much-storage-does-each-artifact-vers.mdx b/support/models/articles/how-much-storage-does-each-artifact-vers.mdx index 2fab931acb..46f2f800d0 100644 --- a/support/models/articles/how-much-storage-does-each-artifact-vers.mdx +++ b/support/models/articles/how-much-storage-does-each-artifact-vers.mdx @@ -1,5 +1,6 @@ --- title: "How much storage does each artifact version use?" +description: "Only files that change between two artifact versions incur storage costs." keywords: ["Artifacts", "Storage"] --- diff --git a/support/models/articles/how-often-are-system-metrics-collected.mdx b/support/models/articles/how-often-are-system-metrics-collected.mdx index 828e2144fe..8d63d44084 100644 --- a/support/models/articles/how-often-are-system-metrics-collected.mdx +++ b/support/models/articles/how-often-are-system-metrics-collected.mdx @@ -1,5 +1,6 @@ --- title: "How often are system metrics collected?" +description: "How often are system metrics collected: a quick reference for W&B users." keywords: ["Metrics"] --- diff --git a/support/models/articles/how-should-i-run-sweeps-on-slurm.mdx b/support/models/articles/how-should-i-run-sweeps-on-slurm.mdx index d1e8ead611..fbdfa207b8 100644 --- a/support/models/articles/how-should-i-run-sweeps-on-slurm.mdx +++ b/support/models/articles/how-should-i-run-sweeps-on-slurm.mdx @@ -1,5 +1,6 @@ --- title: "How should I run sweeps on SLURM?" +description: "When using sweeps with the SLURM scheduling system, run `wandb agent --count 1 SWEEP_ID` in each scheduled job." keywords: ["Sweeps"] --- diff --git a/support/models/articles/how-to-get-multiple-charts-with-differen.mdx b/support/models/articles/how-to-get-multiple-charts-with-differen.mdx index ae49a8834b..4d93adef96 100644 --- a/support/models/articles/how-to-get-multiple-charts-with-differen.mdx +++ b/support/models/articles/how-to-get-multiple-charts-with-differen.mdx @@ -1,5 +1,6 @@ --- title: "How to get multiple charts with different selected runs?" +description: "How to get multiple charts with different selected runs: a quick reference for W&B users." keywords: ["Reports"] --- diff --git a/support/models/articles/i-converted-my-report-to-wysiwyg-but-wan.mdx b/support/models/articles/i-converted-my-report-to-wysiwyg-but-wan.mdx index 16a343a85f..f8dfe2ffa8 100644 --- a/support/models/articles/i-converted-my-report-to-wysiwyg-but-wan.mdx +++ b/support/models/articles/i-converted-my-report-to-wysiwyg-but-wan.mdx @@ -1,5 +1,6 @@ --- title: "I converted my report to WYSIWYG but want to revert back to Markdown" +description: "If the report conversion occurred through the message at the top, click the red \"Revert\" button to restore the prior state." keywords: ["Reports", "Wysiwyg"] --- diff --git a/support/models/articles/i-didnt-name-my-run-where-is-the-run-nam.mdx b/support/models/articles/i-didnt-name-my-run-where-is-the-run-nam.mdx index db0eef4aff..9b504dba0e 100644 --- a/support/models/articles/i-didnt-name-my-run-where-is-the-run-nam.mdx +++ b/support/models/articles/i-didnt-name-my-run-where-is-the-run-nam.mdx @@ -1,5 +1,6 @@ --- title: "I didn't name my run. Where is the run name coming from?" +description: "If a run is not explicitly named, W&B assigns a random name to identify it in your project." keywords: ["Experiments"] --- diff --git a/support/models/articles/if-i-am-the-admin-of-my-local-instance-h.mdx b/support/models/articles/if-i-am-the-admin-of-my-local-instance-h.mdx index 48879363ad..aecdcfff7e 100644 --- a/support/models/articles/if-i-am-the-admin-of-my-local-instance-h.mdx +++ b/support/models/articles/if-i-am-the-admin-of-my-local-instance-h.mdx @@ -1,5 +1,6 @@ --- title: "If I am the admin of my local instance, how should I manage it?" +description: "If you are the admin for your instance, review the User Management section for instructions on adding users and creating teams." keywords: ["Administrator"] --- diff --git a/support/models/articles/if-wandb-crashes-will-it-possibly-crash-.mdx b/support/models/articles/if-wandb-crashes-will-it-possibly-crash-.mdx index 6f32865899..aac41c85d9 100644 --- a/support/models/articles/if-wandb-crashes-will-it-possibly-crash-.mdx +++ b/support/models/articles/if-wandb-crashes-will-it-possibly-crash-.mdx @@ -1,5 +1,6 @@ --- title: "If wandb crashes, will it possibly crash my training run?" +description: "It is critical to avoid interference with training runs." keywords: ["Run Crashes"] --- diff --git a/support/models/articles/incorporating-latex.mdx b/support/models/articles/incorporating-latex.mdx index 3ffeec18b1..dd02f1999f 100644 --- a/support/models/articles/incorporating-latex.mdx +++ b/support/models/articles/incorporating-latex.mdx @@ -1,5 +1,6 @@ --- title: "Incorporating LaTeX" +description: "Incorporating LaTeX. A common question and answer for W&B users." keywords: ["Reports"] --- diff --git a/support/models/articles/initstarterror-error-communicating-with-.mdx b/support/models/articles/initstarterror-error-communicating-with-.mdx index 3bb19c4176..49f6b735ea 100644 --- a/support/models/articles/initstarterror-error-communicating-with-.mdx +++ b/support/models/articles/initstarterror-error-communicating-with-.mdx @@ -1,5 +1,6 @@ --- title: "InitStartError: Error communicating with wandb process" +description: "This error indicates that the library encounters an issue launching the process that synchronizes data to the server." keywords: ["Experiments", "Run Crashes"] --- diff --git a/support/models/articles/is-it-possible-to-add-the-same-service-a.mdx b/support/models/articles/is-it-possible-to-add-the-same-service-a.mdx index a61fcd4564..4302d69d20 100644 --- a/support/models/articles/is-it-possible-to-add-the-same-service-a.mdx +++ b/support/models/articles/is-it-possible-to-add-the-same-service-a.mdx @@ -1,5 +1,6 @@ --- title: "Is it possible to add the same service account to multiple teams?" +description: "A service account cannot be added to multiple teams in W&B." keywords: ["Administrator", "Team Management"] --- diff --git a/support/models/articles/is-it-possible-to-change-the-group-assig.mdx b/support/models/articles/is-it-possible-to-change-the-group-assig.mdx index 2ce70d2f0c..f2f3512313 100644 --- a/support/models/articles/is-it-possible-to-change-the-group-assig.mdx +++ b/support/models/articles/is-it-possible-to-change-the-group-assig.mdx @@ -1,5 +1,6 @@ --- title: "Is it possible to change the group assigned to a run after completion?" +description: "You can change the group assigned to a completed run using the API." keywords: ["Runs"] --- diff --git a/support/models/articles/is-it-possible-to-change-the-username.mdx b/support/models/articles/is-it-possible-to-change-the-username.mdx index a96fb6054f..9d20c5609d 100644 --- a/support/models/articles/is-it-possible-to-change-the-username.mdx +++ b/support/models/articles/is-it-possible-to-change-the-username.mdx @@ -1,5 +1,6 @@ --- title: "Is it possible to change the username?" +description: "Changing the username after account creation is not possible." keywords: ["Administrator", "User Management"] --- diff --git a/support/models/articles/is-it-possible-to-create-a-new-account-w.mdx b/support/models/articles/is-it-possible-to-create-a-new-account-w.mdx index 3ef5d2de30..8c629e1542 100644 --- a/support/models/articles/is-it-possible-to-create-a-new-account-w.mdx +++ b/support/models/articles/is-it-possible-to-create-a-new-account-w.mdx @@ -1,5 +1,6 @@ --- title: "Is it possible to create a new account with an email that was previously used for a deleted account?" +description: "A new account can use an email previously associated with a deleted account." keywords: ["User Management"] --- diff --git a/support/models/articles/is-it-possible-to-move-a-run-from-one-pr.mdx b/support/models/articles/is-it-possible-to-move-a-run-from-one-pr.mdx index ec13c71d8d..4334bd998d 100644 --- a/support/models/articles/is-it-possible-to-move-a-run-from-one-pr.mdx +++ b/support/models/articles/is-it-possible-to-move-a-run-from-one-pr.mdx @@ -1,5 +1,6 @@ --- title: "Is it possible to move a run from one project to another?" +description: "You can move a run from one project to another by following these steps: - Navigate to the project page with the run to be moved." keywords: ["Runs"] --- diff --git a/support/models/articles/is-it-possible-to-plot-the-max-of-a-metr.mdx b/support/models/articles/is-it-possible-to-plot-the-max-of-a-metr.mdx index 43dd61a68e..896f0de866 100644 --- a/support/models/articles/is-it-possible-to-plot-the-max-of-a-metr.mdx +++ b/support/models/articles/is-it-possible-to-plot-the-max-of-a-metr.mdx @@ -1,5 +1,6 @@ --- title: "Is it possible to plot the max of a metric rather than plot step by step?" +description: "Whether it is possible to plot the max of a metric rather than plot step by step in W&B and how to do it." keywords: ["Metrics"] --- diff --git a/support/models/articles/is-it-possible-to-recover-an-artifact-af.mdx b/support/models/articles/is-it-possible-to-recover-an-artifact-af.mdx index 5c6a0e0c57..409d57f01b 100644 --- a/support/models/articles/is-it-possible-to-recover-an-artifact-af.mdx +++ b/support/models/articles/is-it-possible-to-recover-an-artifact-af.mdx @@ -1,5 +1,6 @@ --- title: "Is it possible to recover an artifact after it has been deleted with a run?" +description: "When deleting a run, a prompt asks whether to delete the associated artifacts." keywords: ["Artifacts"] --- diff --git a/support/models/articles/is-it-possible-to-save-metrics-offline-a.mdx b/support/models/articles/is-it-possible-to-save-metrics-offline-a.mdx index baaf89c96f..2ffc29ab9a 100644 --- a/support/models/articles/is-it-possible-to-save-metrics-offline-a.mdx +++ b/support/models/articles/is-it-possible-to-save-metrics-offline-a.mdx @@ -1,5 +1,6 @@ --- title: "Is it possible to save metrics offline and sync them to W&B later?" +description: "By default, `wandb.init` starts a process that syncs metrics in real time to the cloud." keywords: ["Experiments", "Environment Variables", "Metrics"] featured: true --- diff --git a/support/models/articles/is-there-a-dark-mode.mdx b/support/models/articles/is-there-a-dark-mode.mdx index 1598480141..e038d8c3b8 100644 --- a/support/models/articles/is-there-a-dark-mode.mdx +++ b/support/models/articles/is-there-a-dark-mode.mdx @@ -1,5 +1,6 @@ --- title: "Is there a dark mode?" +description: "Dark mode is in beta and not optimized for accessibility. To enable dark mode: 1." keywords: ["Workspaces"] --- diff --git a/support/models/articles/is-there-a-monthly-subscription-option-f.mdx b/support/models/articles/is-there-a-monthly-subscription-option-f.mdx index 995138f122..2ffc9540a1 100644 --- a/support/models/articles/is-there-a-monthly-subscription-option-f.mdx +++ b/support/models/articles/is-there-a-monthly-subscription-option-f.mdx @@ -1,5 +1,6 @@ --- title: "Is there a monthly subscription option for the teams plan?" +description: "The Teams plan does not offer a monthly subscription option. This subscription is billed annually." keywords: ["Administrator", "Billing", "Team Management"] --- diff --git a/support/models/articles/is-there-a-way-to-add-extra-values-to-a-.mdx b/support/models/articles/is-there-a-way-to-add-extra-values-to-a-.mdx index 73ec158bd8..8a6f28ec8b 100644 --- a/support/models/articles/is-there-a-way-to-add-extra-values-to-a-.mdx +++ b/support/models/articles/is-there-a-way-to-add-extra-values-to-a-.mdx @@ -1,5 +1,6 @@ --- title: "Is there a way to add extra values to a sweep, or do I need to start a new one?" +description: "Once a W&B Sweep starts, you cannot change the Sweep configuration." keywords: ["Sweeps"] --- diff --git a/support/models/articles/is-there-a-way-to-add-more-seats.mdx b/support/models/articles/is-there-a-way-to-add-more-seats.mdx index 3ed9ef4881..0b5cd07a5f 100644 --- a/support/models/articles/is-there-a-way-to-add-more-seats.mdx +++ b/support/models/articles/is-there-a-way-to-add-more-seats.mdx @@ -1,5 +1,6 @@ --- title: "Is there a way to add more seats?" +description: "To add more seats to an account, follow these steps: - Contact the Account Executive or support team (support@wandb.com) for assistance." keywords: ["Administrator", "User Management"] --- diff --git a/support/models/articles/is-there-a-wb-outage.mdx b/support/models/articles/is-there-a-wb-outage.mdx index 174be0adb2..6ed2e4d24a 100644 --- a/support/models/articles/is-there-a-wb-outage.mdx +++ b/support/models/articles/is-there-a-wb-outage.mdx @@ -1,5 +1,6 @@ --- title: "Is there a W&B outage?" +description: "Check if the W&B Multi-tenant Cloud at wandb.ai is experiencing an outage by visiting the W&B status page." keywords: ["Connectivity", "Outage"] --- diff --git a/support/models/articles/is-there-an-anaconda-package-for-weights.mdx b/support/models/articles/is-there-an-anaconda-package-for-weights.mdx index 844f03761b..a2b0b17447 100644 --- a/support/models/articles/is-there-an-anaconda-package-for-weights.mdx +++ b/support/models/articles/is-there-an-anaconda-package-for-weights.mdx @@ -1,5 +1,6 @@ --- title: "Is there an anaconda package for Weights and Biases?" +description: "There is an anaconda package that is installable using either `pip` or `conda`." keywords: ["Python"] --- diff --git a/support/models/articles/my-report-is-running-slowly-after-the-ch.mdx b/support/models/articles/my-report-is-running-slowly-after-the-ch.mdx index ba343a1c21..6036c16f18 100644 --- a/support/models/articles/my-report-is-running-slowly-after-the-ch.mdx +++ b/support/models/articles/my-report-is-running-slowly-after-the-ch.mdx @@ -1,5 +1,6 @@ --- title: "My report is running slowly after the change to WYSIWYG" +description: "Performance issues may arise on older hardware or with very large reports." keywords: ["Reports", "Wysiwyg"] --- diff --git a/support/models/articles/my-report-looks-different-after-converti.mdx b/support/models/articles/my-report-looks-different-after-converti.mdx index 331f733ea7..e338435337 100644 --- a/support/models/articles/my-report-looks-different-after-converti.mdx +++ b/support/models/articles/my-report-looks-different-after-converti.mdx @@ -1,5 +1,6 @@ --- title: "My report looks different after converting from Markdown." +description: "The goal is to maintain the original appearance after transitioning to WYSIWYG, but the conversion process is not flawless." keywords: ["Reports", "Wysiwyg"] --- diff --git a/support/models/articles/my-runs-state-is-crashed-on-the-ui-but-i.mdx b/support/models/articles/my-runs-state-is-crashed-on-the-ui-but-i.mdx index a861978e8b..d03723b828 100644 --- a/support/models/articles/my-runs-state-is-crashed-on-the-ui-but-i.mdx +++ b/support/models/articles/my-runs-state-is-crashed-on-the-ui-but-i.mdx @@ -1,5 +1,6 @@ --- title: "My run's state is `crashed` on the UI but is still running on my machine. What do I do to get my data back?" +description: "You likely lost connection to your machine during training. Recover data by running [`wandb sync [PATH_TO_RUN]`](/models/ref/cli/wandb-sync)." keywords: ["Experiments", "Run Crashes"] --- diff --git a/support/models/articles/on-a-local-instance-which-files-should-i.mdx b/support/models/articles/on-a-local-instance-which-files-should-i.mdx index 4933ff5c89..14bd50a43d 100644 --- a/support/models/articles/on-a-local-instance-which-files-should-i.mdx +++ b/support/models/articles/on-a-local-instance-which-files-should-i.mdx @@ -1,5 +1,6 @@ --- title: "On a local instance, which files should I check when I have issues?" +description: "Which files to check when troubleshooting issues on a self-hosted W&B local instance, such as logs and configuration." keywords: ["Administrator"] --- diff --git a/support/models/articles/optimizing-multiple-metrics.mdx b/support/models/articles/optimizing-multiple-metrics.mdx index b055fe1868..26f471aa9a 100644 --- a/support/models/articles/optimizing-multiple-metrics.mdx +++ b/support/models/articles/optimizing-multiple-metrics.mdx @@ -1,5 +1,6 @@ --- title: "Optimizing multiple metrics" +description: "To optimize multiple metrics in a single run, use a weighted sum of the individual metrics." keywords: ["Sweeps", "Metrics"] --- diff --git a/support/models/articles/process-hangs-when-using-hydra-with-wan.mdx b/support/models/articles/process-hangs-when-using-hydra-with-wan.mdx index d5bcc974bd..c6aa0dc03d 100644 --- a/support/models/articles/process-hangs-when-using-hydra-with-wan.mdx +++ b/support/models/articles/process-hangs-when-using-hydra-with-wan.mdx @@ -1,5 +1,6 @@ --- title: "Why does my process hang when using Hydra with W&B?" +description: "If your process hangs when started with Hydra, this is likely caused by a multiprocessing conflict between Hydra and W&B." keywords: ["Experiments", "Run Crashes"] --- diff --git a/support/models/articles/rate-limit-exceeded-on-metric-logging.mdx b/support/models/articles/rate-limit-exceeded-on-metric-logging.mdx index d405bd9c5d..923f8d502f 100644 --- a/support/models/articles/rate-limit-exceeded-on-metric-logging.mdx +++ b/support/models/articles/rate-limit-exceeded-on-metric-logging.mdx @@ -1,5 +1,6 @@ --- title: "How do I fix `Rate limit exceeded` errors when logging metrics?" +description: "Learn how to fix `Rate limit exceeded` errors when logging metrics in W&B." keywords: ["Metrics", "Experiments"] --- diff --git a/support/models/articles/refreshing-data.mdx b/support/models/articles/refreshing-data.mdx index 8f3c9b545f..0053683a1c 100644 --- a/support/models/articles/refreshing-data.mdx +++ b/support/models/articles/refreshing-data.mdx @@ -1,5 +1,6 @@ --- title: "Refreshing data" +description: "Workspaces automatically load updated data. Auto-refresh does not apply to reports." keywords: ["Reports", "Workspaces"] --- diff --git a/support/models/articles/service-account-unauthorized-or-runs-no.mdx b/support/models/articles/service-account-unauthorized-or-runs-no.mdx index 4c92155062..cabbca773c 100644 --- a/support/models/articles/service-account-unauthorized-or-runs-no.mdx +++ b/support/models/articles/service-account-unauthorized-or-runs-no.mdx @@ -1,5 +1,6 @@ --- title: "How do I fix service account errors like `Unauthorized` or missing runs?" +description: "Learn how to fix service account errors like `Unauthorized` or missing runs in W&B." keywords: ["Administrator", "Security"] --- diff --git a/support/models/articles/training-hangs-with-distributed-trainin.mdx b/support/models/articles/training-hangs-with-distributed-trainin.mdx index 1d67208cd8..9f5d9fbaae 100644 --- a/support/models/articles/training-hangs-with-distributed-trainin.mdx +++ b/support/models/articles/training-hangs-with-distributed-trainin.mdx @@ -1,5 +1,6 @@ --- title: "Why does my training hang with distributed training?" +description: "There are two common reasons training hangs when using W&B with distributed training: 1." keywords: ["Experiments", "Run Crashes"] --- diff --git a/support/models/articles/upload-a-csv-to-a-report.mdx b/support/models/articles/upload-a-csv-to-a-report.mdx index 6be71ba050..cf9abcc2c6 100644 --- a/support/models/articles/upload-a-csv-to-a-report.mdx +++ b/support/models/articles/upload-a-csv-to-a-report.mdx @@ -1,5 +1,6 @@ --- title: "Upload a CSV to a report" +description: "Upload a CSV file to a W&B report by loading it as a `wandb.Table` in Python and logging it to a run." keywords: ["Reports"] --- diff --git a/support/models/articles/upload-an-image-to-a-report.mdx b/support/models/articles/upload-an-image-to-a-report.mdx index 2ea3d8dd7a..3f8e179671 100644 --- a/support/models/articles/upload-an-image-to-a-report.mdx +++ b/support/models/articles/upload-an-image-to-a-report.mdx @@ -1,5 +1,6 @@ --- title: "Upload an image to a report" +description: "Upload an image to a W&B report by adding it from the report editor or logging it as a `wandb.Image` to a run." keywords: ["Reports"] --- diff --git a/support/models/articles/using-artifacts-with-multiple-architectu.mdx b/support/models/articles/using-artifacts-with-multiple-architectu.mdx index e8a1b1e253..806012fae6 100644 --- a/support/models/articles/using-artifacts-with-multiple-architectu.mdx +++ b/support/models/articles/using-artifacts-with-multiple-architectu.mdx @@ -1,5 +1,6 @@ --- title: "Using artifacts with multiple architectures and runs?" +description: "There are various methods to version a model. Artifacts provide a tool for model versioning tailored to specific needs." keywords: ["Artifacts"] --- diff --git a/support/models/articles/what-are-features-that-are-not-available.mdx b/support/models/articles/what-are-features-that-are-not-available.mdx index bf55bc7a67..9c6686ede2 100644 --- a/support/models/articles/what-are-features-that-are-not-available.mdx +++ b/support/models/articles/what-are-features-that-are-not-available.mdx @@ -1,5 +1,6 @@ --- title: "What are features that are not available to anonymous users?" +description: "No persistent data: Runs save for 7 days in an anonymous account." keywords: ["Anonymous"] --- diff --git a/support/models/articles/what-are-the-best-practices-for-handling.mdx b/support/models/articles/what-are-the-best-practices-for-handling.mdx index 8a2a6d3946..35e97b7960 100644 --- a/support/models/articles/what-are-the-best-practices-for-handling.mdx +++ b/support/models/articles/what-are-the-best-practices-for-handling.mdx @@ -1,5 +1,6 @@ --- title: "What are the best practices for handling W&B Inference errors?" +description: "Follow these best practices to handle W&B Inference errors gracefully and maintain reliable applications." keywords: ["Inference"] --- diff --git a/support/models/articles/what-does-wandbinit-do-to-my-training-pr.mdx b/support/models/articles/what-does-wandbinit-do-to-my-training-pr.mdx index 48a9ed0edb..ff8b65b938 100644 --- a/support/models/articles/what-does-wandbinit-do-to-my-training-pr.mdx +++ b/support/models/articles/what-does-wandbinit-do-to-my-training-pr.mdx @@ -1,5 +1,6 @@ --- title: "What does wandb.init do to my training process?" +description: "When `wandb.init()` runs in a training script, an API call creates a run object on the servers." keywords: ["Environment Variables", "Experiments"] featured: true --- diff --git a/support/models/articles/what-formula-do-you-use-for-your-smoothi.mdx b/support/models/articles/what-formula-do-you-use-for-your-smoothi.mdx index a1d6cb441b..19f860fc09 100644 --- a/support/models/articles/what-formula-do-you-use-for-your-smoothi.mdx +++ b/support/models/articles/what-formula-do-you-use-for-your-smoothi.mdx @@ -1,5 +1,6 @@ --- title: "What formula do you use for your smoothing algorithm?" +description: "The exponential moving average formula aligns with the one used in TensorBoard." keywords: ["Tensorboard"] --- diff --git a/support/models/articles/what-happens-if-i-edit-my-python-files-w.mdx b/support/models/articles/what-happens-if-i-edit-my-python-files-w.mdx index ba0d491789..212c65a0dc 100644 --- a/support/models/articles/what-happens-if-i-edit-my-python-files-w.mdx +++ b/support/models/articles/what-happens-if-i-edit-my-python-files-w.mdx @@ -1,5 +1,6 @@ --- title: "What happens if I edit my Python files while a sweep is running?" +description: "While a sweep is running: - If the `train.py` script which the sweep uses changes, the sweep continues to use the original `train.py` - If f" keywords: ["Sweeps"] --- diff --git a/support/models/articles/what-happens-if-i-pass-a-class-attribute.mdx b/support/models/articles/what-happens-if-i-pass-a-class-attribute.mdx index 939c44492d..5e274a4ca2 100644 --- a/support/models/articles/what-happens-if-i-pass-a-class-attribute.mdx +++ b/support/models/articles/what-happens-if-i-pass-a-class-attribute.mdx @@ -1,5 +1,6 @@ --- title: "What happens if I pass a class attribute into wandb.Run.log()?" +description: "Avoid passing class attributes into `wandb.Run.log()`." keywords: ["Experiments"] --- diff --git a/support/models/articles/what-happens-if-internet-connection-is-l.mdx b/support/models/articles/what-happens-if-internet-connection-is-l.mdx index eb7f290d7a..2b540541a1 100644 --- a/support/models/articles/what-happens-if-internet-connection-is-l.mdx +++ b/support/models/articles/what-happens-if-internet-connection-is-l.mdx @@ -1,5 +1,6 @@ --- title: "What happens if internet connection is lost while I'm training a model?" +description: "If the library cannot connect to the internet, it enters a retry loop and continues to attempt to stream metrics until the network is restor" keywords: ["Environment Variables", "Outage"] --- diff --git a/support/models/articles/what-happens-when-i-log-millions-of-step.mdx b/support/models/articles/what-happens-when-i-log-millions-of-step.mdx index dae0693bc2..a7e3cd00da 100644 --- a/support/models/articles/what-happens-when-i-log-millions-of-step.mdx +++ b/support/models/articles/what-happens-when-i-log-millions-of-step.mdx @@ -1,5 +1,6 @@ --- title: "What happens when I log millions of steps to W&B? How is that rendered in the browser?" +description: "The number of points sent affects the loading time of graphs in the UI." keywords: ["Experiments", "Metrics"] --- diff --git a/support/models/articles/what-if-i-want-to-integrate-wb-into-my-p.mdx b/support/models/articles/what-if-i-want-to-integrate-wb-into-my-p.mdx index 587bf76a45..081193d3a9 100644 --- a/support/models/articles/what-if-i-want-to-integrate-wb-into-my-p.mdx +++ b/support/models/articles/what-if-i-want-to-integrate-wb-into-my-p.mdx @@ -1,5 +1,6 @@ --- title: "What if I want to integrate W&B into my project, but I don't want to upload any images or media?" +description: "W&B supports projects that log only scalars by allowing explicit specification of files or data for upload." keywords: ["Experiments"] --- diff --git a/support/models/articles/what-if-i-want-to-log-some-metrics-on-ba.mdx b/support/models/articles/what-if-i-want-to-log-some-metrics-on-ba.mdx index f8fe4d5094..dbbef80db4 100644 --- a/support/models/articles/what-if-i-want-to-log-some-metrics-on-ba.mdx +++ b/support/models/articles/what-if-i-want-to-log-some-metrics-on-ba.mdx @@ -1,5 +1,6 @@ --- title: "What if I want to log some metrics on batches and some metrics only on epochs?" +description: "To log specific metrics in each batch and standardize plots, log the desired x-axis values alongside the metrics." keywords: ["Experiments", "Metrics"] --- diff --git a/support/models/articles/what-is-a-service-account-and-why-is-it-.mdx b/support/models/articles/what-is-a-service-account-and-why-is-it-.mdx index c1ff0c4ebd..6887e2b178 100644 --- a/support/models/articles/what-is-a-service-account-and-why-is-it-.mdx +++ b/support/models/articles/what-is-a-service-account-and-why-is-it-.mdx @@ -1,5 +1,6 @@ --- title: "What is a service account, and why is it useful?" +description: "A service account represents a non-human or machine identity, which can automate common tasks across teams and projects." keywords: ["Administrator"] --- diff --git a/support/models/articles/what-is-a-team-and-where-can-i-find-more.mdx b/support/models/articles/what-is-a-team-and-where-can-i-find-more.mdx index d56ced5612..049cac12bc 100644 --- a/support/models/articles/what-is-a-team-and-where-can-i-find-more.mdx +++ b/support/models/articles/what-is-a-team-and-where-can-i-find-more.mdx @@ -1,5 +1,6 @@ --- title: "What is a team and where can I find more information about it?" +description: "For additional information about teams, visit the teams section." keywords: ["Team Management"] --- diff --git a/support/models/articles/what-is-the-difference-between-log-and-s.mdx b/support/models/articles/what-is-the-difference-between-log-and-s.mdx index 04090c07d7..6e38e31499 100644 --- a/support/models/articles/what-is-the-difference-between-log-and-s.mdx +++ b/support/models/articles/what-is-the-difference-between-log-and-s.mdx @@ -1,5 +1,6 @@ --- title: "What is the difference between `.log()` and `.summary`?" +description: "The summary displays in the table, while the log saves all values for future plotting." keywords: ["Charts"] --- diff --git a/support/models/articles/what-is-the-difference-between-team-and-.mdx b/support/models/articles/what-is-the-difference-between-team-and-.mdx index aab2779a74..04996489ab 100644 --- a/support/models/articles/what-is-the-difference-between-team-and-.mdx +++ b/support/models/articles/what-is-the-difference-between-team-and-.mdx @@ -1,5 +1,6 @@ --- title: "What is the difference between team and entity? As a user - what does entity mean for me?" +description: "A team serves as a collaborative workspace for users working on the same projects." keywords: ["Team Management"] --- diff --git a/support/models/articles/what-is-the-difference-between-team-and-_2.mdx b/support/models/articles/what-is-the-difference-between-team-and-_2.mdx index 9883517eac..d39cea55fd 100644 --- a/support/models/articles/what-is-the-difference-between-team-and-_2.mdx +++ b/support/models/articles/what-is-the-difference-between-team-and-_2.mdx @@ -1,5 +1,6 @@ --- title: "What is the difference between team and organization?" +description: "A team serves as a collaborative workspace for users working on the same projects." keywords: ["Team Management", "Administrator"] --- diff --git a/support/models/articles/what-is-the-difference-between-wandbinit.mdx b/support/models/articles/what-is-the-difference-between-wandbinit.mdx index a86354a3d3..fdd1645b1f 100644 --- a/support/models/articles/what-is-the-difference-between-wandbinit.mdx +++ b/support/models/articles/what-is-the-difference-between-wandbinit.mdx @@ -1,5 +1,6 @@ --- title: "What is the difference between wandb.init modes?" +description: "These modes are available: `online` (default): The client sends data to the wandb server." keywords: ["Experiments"] --- diff --git a/support/models/articles/what-is-the-est-runs-column.mdx b/support/models/articles/what-is-the-est-runs-column.mdx index b8f5c4c897..c38276c22a 100644 --- a/support/models/articles/what-is-the-est-runs-column.mdx +++ b/support/models/articles/what-is-the-est-runs-column.mdx @@ -1,5 +1,6 @@ --- title: "What is the `Est. Runs` column?" +description: "W&B provides an estimated number of Runs generated when creating a W&B Sweep with a discrete search space." keywords: ["Sweeps", "Hyperparameter"] --- diff --git a/support/models/articles/what-really-good-functionalities-are-hid.mdx b/support/models/articles/what-really-good-functionalities-are-hid.mdx index 9600811608..fb525438ef 100644 --- a/support/models/articles/what-really-good-functionalities-are-hid.mdx +++ b/support/models/articles/what-really-good-functionalities-are-hid.mdx @@ -1,5 +1,6 @@ --- title: "What really good functionalities are hidden and where can I find those?" +description: "Some functionalities are hidden under a feature flag in the Beta Features section of a team's settings." keywords: ["Workspaces"] --- diff --git a/support/models/articles/what-type-of-roles-are-available-and-wha.mdx b/support/models/articles/what-type-of-roles-are-available-and-wha.mdx index bc4c2d6594..b29dd800c1 100644 --- a/support/models/articles/what-type-of-roles-are-available-and-wha.mdx +++ b/support/models/articles/what-type-of-roles-are-available-and-wha.mdx @@ -1,5 +1,6 @@ --- title: "What type of roles are available and what are the differences between them?" +description: "Visit the Team roles and permissions page for an overview of the available roles and permissions." keywords: ["User Management", "Team Management"] --- diff --git a/support/models/articles/when-should-i-log-to-my-personal-entity-.mdx b/support/models/articles/when-should-i-log-to-my-personal-entity-.mdx index 254ede66d8..34fe40aec9 100644 --- a/support/models/articles/when-should-i-log-to-my-personal-entity-.mdx +++ b/support/models/articles/when-should-i-log-to-my-personal-entity-.mdx @@ -1,5 +1,6 @@ --- title: "When should I log to my personal entity against my team entity?" +description: "Personal Entities are unavailable for accounts created after May 21, 2024." keywords: ["Team Management"] --- diff --git a/support/models/articles/where-are-artifacts-downloaded-and-how-c.mdx b/support/models/articles/where-are-artifacts-downloaded-and-how-c.mdx index f06775d55d..52578a65a9 100644 --- a/support/models/articles/where-are-artifacts-downloaded-and-how-c.mdx +++ b/support/models/articles/where-are-artifacts-downloaded-and-how-c.mdx @@ -1,5 +1,6 @@ --- title: "Where are artifacts downloaded, and how can I control that?" +description: "By default, artifacts download to the `artifacts/` folder." keywords: ["Artifacts", "Environment Variables"] --- diff --git a/support/models/articles/which-files-should-i-check-when-my-code-.mdx b/support/models/articles/which-files-should-i-check-when-my-code-.mdx index b64ae8e137..a97a6980de 100644 --- a/support/models/articles/which-files-should-i-check-when-my-code-.mdx +++ b/support/models/articles/which-files-should-i-check-when-my-code-.mdx @@ -1,5 +1,6 @@ --- title: "Which files should I check when my code crashes?" +description: "For the affected run, check `debug.log` and `debug-internal.log` in `wandb/run-_-/logs` in the directory where your code is running." keywords: ["Logs"] --- diff --git a/support/models/articles/who-can-create-a-team-who-can-add-or-del.mdx b/support/models/articles/who-can-create-a-team-who-can-add-or-del.mdx index 5d0756c17f..9d2e6c1240 100644 --- a/support/models/articles/who-can-create-a-team-who-can-add-or-del.mdx +++ b/support/models/articles/who-can-create-a-team-who-can-add-or-del.mdx @@ -1,5 +1,6 @@ --- title: "Who can create a team? Who can add or delete people from a team? Who can delete projects?" +description: "Refer to the link for details on roles and permissions: Team Roles and Permissions." keywords: ["Team Management"] --- diff --git a/support/models/articles/who-can-edit-and-share-reports.mdx b/support/models/articles/who-can-edit-and-share-reports.mdx index 49fb1a24e3..67fa8c837a 100644 --- a/support/models/articles/who-can-edit-and-share-reports.mdx +++ b/support/models/articles/who-can-edit-and-share-reports.mdx @@ -1,5 +1,6 @@ --- title: "Who can edit and share reports?" +description: "Reports created within an individual's private project remain visible only to that user." keywords: ["Reports"] --- diff --git a/support/models/articles/who-has-access-to-my-artifacts.mdx b/support/models/articles/who-has-access-to-my-artifacts.mdx index 26595dbc79..ecd34d7843 100644 --- a/support/models/articles/who-has-access-to-my-artifacts.mdx +++ b/support/models/articles/who-has-access-to-my-artifacts.mdx @@ -1,5 +1,6 @@ --- title: "Who has access to my artifacts?" +description: "Artifacts inherit access permissions from their parent project: In a private project, only team members can access artifacts." keywords: ["Artifacts"] --- diff --git a/support/models/articles/why-am-i-getting-insufficient-quota-erro.mdx b/support/models/articles/why-am-i-getting-insufficient-quota-erro.mdx index a0ff2fbebb..0f8969636c 100644 --- a/support/models/articles/why-am-i-getting-insufficient-quota-erro.mdx +++ b/support/models/articles/why-am-i-getting-insufficient-quota-erro.mdx @@ -1,5 +1,6 @@ --- title: "Why am I getting insufficient quota errors (402) with W&B Inference?" +description: "Insufficient quota errors (402) occur when you do not have remaining credits in your plan." keywords: ["Inference"] --- diff --git a/support/models/articles/why-am-i-getting-rate-limit-errors-429-w.mdx b/support/models/articles/why-am-i-getting-rate-limit-errors-429-w.mdx index 93189cbde2..809e4fa2f1 100644 --- a/support/models/articles/why-am-i-getting-rate-limit-errors-429-w.mdx +++ b/support/models/articles/why-am-i-getting-rate-limit-errors-429-w.mdx @@ -1,5 +1,6 @@ --- title: "Why am I getting rate limit errors (429) with W&B Inference?" +description: "Rate limit errors (429) occur when you exceed concurrency limits." keywords: ["Inference"] --- diff --git a/support/models/articles/why-am-i-seeing-fewer-data-points-than-i.mdx b/support/models/articles/why-am-i-seeing-fewer-data-points-than-i.mdx index 6dc69b0d55..8a41c08286 100644 --- a/support/models/articles/why-am-i-seeing-fewer-data-points-than-i.mdx +++ b/support/models/articles/why-am-i-seeing-fewer-data-points-than-i.mdx @@ -1,5 +1,6 @@ --- title: "Why am I seeing fewer data points than I logged?" +description: "When visualizing metrics against an X-axis other than `Step`, expect to see fewer data points." keywords: ["Experiments", "Metrics"] --- diff --git a/support/models/articles/why-are-steps-missing-from-a-csv-metric-.mdx b/support/models/articles/why-are-steps-missing-from-a-csv-metric-.mdx index 25882538d2..a4407781c3 100644 --- a/support/models/articles/why-are-steps-missing-from-a-csv-metric-.mdx +++ b/support/models/articles/why-are-steps-missing-from-a-csv-metric-.mdx @@ -1,5 +1,6 @@ --- title: "Why are steps missing from a CSV metric export?" +description: "Export limits can prevent the entire run history from being exported as a CSV or using the `run.history` API." keywords: ["Experiments", "Runs"] --- diff --git a/support/models/articles/why-cant-i-sort-or-filter-metrics-with-c.mdx b/support/models/articles/why-cant-i-sort-or-filter-metrics-with-c.mdx index 4b220f8871..48b5cabfb1 100644 --- a/support/models/articles/why-cant-i-sort-or-filter-metrics-with-c.mdx +++ b/support/models/articles/why-cant-i-sort-or-filter-metrics-with-c.mdx @@ -1,5 +1,6 @@ --- title: "Why can't I sort or filter metrics with certain characters?" +description: "Metric names in W&B must follow GraphQL naming conventions to ensure they can be properly sorted and filtered in the UI." keywords: ["Experiments", "Metrics"] --- diff --git a/support/models/articles/why-does-the-storage-meter-not-update-af.mdx b/support/models/articles/why-does-the-storage-meter-not-update-af.mdx index eae5b86868..9e4de73f60 100644 --- a/support/models/articles/why-does-the-storage-meter-not-update-af.mdx +++ b/support/models/articles/why-does-the-storage-meter-not-update-af.mdx @@ -1,5 +1,6 @@ --- title: "Why does the storage meter not update after deleting runs?" +description: "- The storage meter does not update immediately after deleting runs due to processing delays." keywords: ["Storage"] --- diff --git a/support/models/articles/why-is-a-run-marked-crashed-in-wb-when-i.mdx b/support/models/articles/why-is-a-run-marked-crashed-in-wb-when-i.mdx index 5ef1a529ee..470998f4d7 100644 --- a/support/models/articles/why-is-a-run-marked-crashed-in-wb-when-i.mdx +++ b/support/models/articles/why-is-a-run-marked-crashed-in-wb-when-i.mdx @@ -1,5 +1,6 @@ --- title: "Why is a run marked crashed in W&B when it’s training fine locally?" +description: "Why is a run marked crashed in W&B when it’s training fine locally: a common question and answer for W&B users." keywords: ["Run Crashes"] --- diff --git a/support/models/articles/why-is-nothing-showing-up-in-my-graphs.mdx b/support/models/articles/why-is-nothing-showing-up-in-my-graphs.mdx index a8303d5342..7d30c29fb2 100644 --- a/support/models/articles/why-is-nothing-showing-up-in-my-graphs.mdx +++ b/support/models/articles/why-is-nothing-showing-up-in-my-graphs.mdx @@ -1,5 +1,6 @@ --- title: "Why is nothing showing up in my graphs?" +description: "If the message \"No visualization data logged yet\" appears, the script has not executed the first `wandb.log` call." keywords: ["Experiments", "Metrics"] --- diff --git a/support/models/articles/why-is-the-same-metric-appearing-more-th.mdx b/support/models/articles/why-is-the-same-metric-appearing-more-th.mdx index 73f9a662d7..2d9a37a17e 100644 --- a/support/models/articles/why-is-the-same-metric-appearing-more-th.mdx +++ b/support/models/articles/why-is-the-same-metric-appearing-more-th.mdx @@ -1,5 +1,6 @@ --- title: "Why is the same metric appearing more than once?" +description: "When logging various data types under the same key, split them in the database." keywords: ["Experiments", "Metrics"] --- diff --git a/support/models/articles/will-wandb-slow-down-my-training.mdx b/support/models/articles/will-wandb-slow-down-my-training.mdx index 29d1e61f08..289b197239 100644 --- a/support/models/articles/will-wandb-slow-down-my-training.mdx +++ b/support/models/articles/will-wandb-slow-down-my-training.mdx @@ -1,5 +1,6 @@ --- title: "Will wandb slow down my training?" +description: "W&B has a minimal impact on training performance under normal usage conditions." keywords: ["Experiments"] --- diff --git a/support/models/articles/workspace-loads-slowly-with-many-metric.mdx b/support/models/articles/workspace-loads-slowly-with-many-metric.mdx index 349fa5ca54..d33523ad61 100644 --- a/support/models/articles/workspace-loads-slowly-with-many-metric.mdx +++ b/support/models/articles/workspace-loads-slowly-with-many-metric.mdx @@ -1,5 +1,6 @@ --- title: "Why does my workspace load slowly?" +description: "Workspaces can load slowly when a project has a large number of metrics, runs, or panels." keywords: ["Workspaces", "Metrics"] --- diff --git a/support/weave/articles/how-can-i-disable-client-information-cap.mdx b/support/weave/articles/how-can-i-disable-client-information-cap.mdx index 52ce5abc65..f3b35bb409 100644 --- a/support/weave/articles/how-can-i-disable-client-information-cap.mdx +++ b/support/weave/articles/how-can-i-disable-client-information-cap.mdx @@ -1,5 +1,6 @@ --- title: "How can I disable client information capture?" +description: "Disable client information capture in W&B Weave by setting `capture_client_info=False` on `weave.init()`." keywords: ["Client Info"] --- diff --git a/support/weave/articles/how-can-i-disable-code-capture.mdx b/support/weave/articles/how-can-i-disable-code-capture.mdx index 0b200abd13..294f170284 100644 --- a/support/weave/articles/how-can-i-disable-code-capture.mdx +++ b/support/weave/articles/how-can-i-disable-code-capture.mdx @@ -1,5 +1,6 @@ --- title: "How can I disable code capture?" +description: "Disable code capture in W&B Weave with the `capture_code=False` setting on `weave.init()` or the matching environment variable." keywords: ["Code Capture"] --- diff --git a/support/weave/articles/how-can-i-disable-system-information-cap.mdx b/support/weave/articles/how-can-i-disable-system-information-cap.mdx index b3e201e1da..eb5d5e792d 100644 --- a/support/weave/articles/how-can-i-disable-system-information-cap.mdx +++ b/support/weave/articles/how-can-i-disable-system-information-cap.mdx @@ -1,5 +1,6 @@ --- title: "How can I disable system information capture?" +description: "Disable system information capture in W&B Weave by setting `capture_system_info=False` on `weave.init()`." keywords: ["System Info"] --- diff --git a/support/weave/articles/how-do-i-render-markdown-in-the-ui.mdx b/support/weave/articles/how-do-i-render-markdown-in-the-ui.mdx index 9eb615378f..baedffdb59 100644 --- a/support/weave/articles/how-do-i-render-markdown-in-the-ui.mdx +++ b/support/weave/articles/how-do-i-render-markdown-in-the-ui.mdx @@ -1,5 +1,6 @@ --- title: "How do I render Markdown in the UI?" +description: "Render Markdown content in the W&B Weave UI by wrapping strings with `weave.Markdown(...)` before publishing them." keywords: ["UI Rendering"] --- diff --git a/support/weave/articles/how-do-i-render-python-datetime-values-i.mdx b/support/weave/articles/how-do-i-render-python-datetime-values-i.mdx index 33358f2efc..1973bc9c95 100644 --- a/support/weave/articles/how-do-i-render-python-datetime-values-i.mdx +++ b/support/weave/articles/how-do-i-render-python-datetime-values-i.mdx @@ -1,5 +1,6 @@ --- title: "How do I render Python datetime values in the UI?" +description: "Render Python datetime values as timestamps in the W&B Weave UI by publishing timezone-aware `datetime.datetime` objects." keywords: ["UI Rendering"] --- diff --git a/support/weave/articles/how-is-weave-data-ingestion-calculated.mdx b/support/weave/articles/how-is-weave-data-ingestion-calculated.mdx index b88cbb60fa..06b4c5b802 100644 --- a/support/weave/articles/how-is-weave-data-ingestion-calculated.mdx +++ b/support/weave/articles/how-is-weave-data-ingestion-calculated.mdx @@ -1,5 +1,6 @@ --- title: "How is Weave data ingestion calculated?" +description: "How W&B Weave data ingestion is calculated, including which trace metadata, inputs, outputs, and logged data count toward usage." keywords: ["Data Capture"] --- diff --git a/support/weave/articles/long-eval-clean-up-times.mdx b/support/weave/articles/long-eval-clean-up-times.mdx index bcadfddbf3..1a72603ec5 100644 --- a/support/weave/articles/long-eval-clean-up-times.mdx +++ b/support/weave/articles/long-eval-clean-up-times.mdx @@ -1,5 +1,6 @@ --- title: "Long eval clean up times" +description: "Reduce long W&B Weave evaluation cleanup times when running evaluations on large datasets by combining recommended methods." keywords: ["Performance", "Evaluation"] --- diff --git a/support/weave/articles/os-errors-too-many-open-files.mdx b/support/weave/articles/os-errors-too-many-open-files.mdx index cd5f13c5bc..9fa90bd658 100644 --- a/support/weave/articles/os-errors-too-many-open-files.mdx +++ b/support/weave/articles/os-errors-too-many-open-files.mdx @@ -1,5 +1,6 @@ --- title: "OS errors - Too many open files" +description: "Fix the \"Too many open files\" OS error when running W&B Weave with large image datasets and PIL image processing." keywords: ["Performance"] --- diff --git a/support/weave/articles/server-response-caching.mdx b/support/weave/articles/server-response-caching.mdx index 4e39000f4b..a863c1c177 100644 --- a/support/weave/articles/server-response-caching.mdx +++ b/support/weave/articles/server-response-caching.mdx @@ -1,5 +1,6 @@ --- title: "Server response caching" +description: "Enable W&B Weave server response caching to improve performance for repeated queries and limited network bandwidth." keywords: ["Performance"] --- diff --git a/support/weave/articles/trace-data-is-truncated.mdx b/support/weave/articles/trace-data-is-truncated.mdx index 44218da776..af765b3a6e 100644 --- a/support/weave/articles/trace-data-is-truncated.mdx +++ b/support/weave/articles/trace-data-is-truncated.mdx @@ -1,5 +1,6 @@ --- title: "Trace data is truncated" +description: "Fix truncated trace data in the W&B Weave UI by serializing custom Python objects into a Weave-compatible format." keywords: ["Trace Data"] --- diff --git a/support/weave/articles/trace-data-loss-in-worker-processes.mdx b/support/weave/articles/trace-data-loss-in-worker-processes.mdx index f8a77ee3ca..d9110ef4b1 100644 --- a/support/weave/articles/trace-data-loss-in-worker-processes.mdx +++ b/support/weave/articles/trace-data-loss-in-worker-processes.mdx @@ -1,5 +1,6 @@ --- title: "Trace data loss in worker processes" +description: "Prevent W&B Weave trace data loss when using multiprocessing, task queues, or worker processes such as Celery." keywords: ["Trace Data", "Performance"] --- diff --git a/support/weave/articles/trace-pages-load-slowly.mdx b/support/weave/articles/trace-pages-load-slowly.mdx index decedc3b6e..83bfd29d7f 100644 --- a/support/weave/articles/trace-pages-load-slowly.mdx +++ b/support/weave/articles/trace-pages-load-slowly.mdx @@ -1,5 +1,6 @@ --- title: "Trace pages load slowly" +description: "Speed up W&B Weave trace pages that load slowly by reducing the number of rows displayed via the UI or query parameters." keywords: ["Trace Data"] --- diff --git a/support/weave/articles/weave-call-does-not-raise-exceptions.mdx b/support/weave/articles/weave-call-does-not-raise-exceptions.mdx index 7d94ff57c0..f3bfeac29c 100644 --- a/support/weave/articles/weave-call-does-not-raise-exceptions.mdx +++ b/support/weave/articles/weave-call-does-not-raise-exceptions.mdx @@ -1,5 +1,6 @@ --- title: "Why doesn't `.call()` raise exceptions?" +description: "Why W&B Weave's `.call()` method captures exceptions on `call.exception` instead of raising them, and how to opt in to raising." keywords: ["Trace Data"] --- diff --git a/support/weave/articles/what-information-does-weave-capture-for.mdx b/support/weave/articles/what-information-does-weave-capture-for.mdx index 7233f202eb..f37cf4eae1 100644 --- a/support/weave/articles/what-information-does-weave-capture-for.mdx +++ b/support/weave/articles/what-information-does-weave-capture-for.mdx @@ -1,5 +1,6 @@ --- title: "What information does Weave capture for a function?" +description: "What W&B Weave captures for tracked Ops, including inputs, outputs, code, system info, and call metadata." keywords: ["Data Capture", "Code Capture", "Client Info", "System Info"] --- diff --git a/support/weave/articles/what-is-pairwise-evaluation-and-how-do-i.mdx b/support/weave/articles/what-is-pairwise-evaluation-and-how-do-i.mdx index 7017ade1fc..f13cc6308f 100644 --- a/support/weave/articles/what-is-pairwise-evaluation-and-how-do-i.mdx +++ b/support/weave/articles/what-is-pairwise-evaluation-and-how-do-i.mdx @@ -1,5 +1,6 @@ --- title: "What is pairwise evaluation and how do I do it?" +description: "How to set up pairwise evaluation in W&B Weave to compare models head-to-head instead of using absolute scoring." keywords: ["Evaluation"] --- diff --git a/support/weave/articles/will-weave-affect-my-function-s-executio.mdx b/support/weave/articles/will-weave-affect-my-function-s-executio.mdx index 362c7ce83c..816abb6177 100644 --- a/support/weave/articles/will-weave-affect-my-function-s-executio.mdx +++ b/support/weave/articles/will-weave-affect-my-function-s-executio.mdx @@ -1,5 +1,6 @@ --- title: "Will Weave affect my function's execution speed?" +description: "How W&B Weave minimizes overhead on your function execution speed by uploading trace data on a background thread." keywords: ["Performance"] --- diff --git a/training/ref-link-api.mdx b/training/ref-link-api.mdx index f32b62aa30..2eec3d904a 100644 --- a/training/ref-link-api.mdx +++ b/training/ref-link-api.mdx @@ -1,4 +1,5 @@ --- title: "API Reference" +description: "Browse the W&B Training API reference for submitting reinforcement learning and supervised fine-tuning jobs." url: "/training/api-reference" --- diff --git a/weave/details/support-weave.mdx b/weave/details/support-weave.mdx index 62fde8721b..4a68ed8c7f 100644 --- a/weave/details/support-weave.mdx +++ b/weave/details/support-weave.mdx @@ -1,4 +1,5 @@ --- title: "Support: Weave" +description: "Browse W&B Weave support articles covering tracing, evaluations, data ingestion, performance, and troubleshooting." url: "/support/weave" --- \ No newline at end of file diff --git a/weave/ref-link-python.mdx b/weave/ref-link-python.mdx index 8b58b6e7b6..c686cc7dae 100644 --- a/weave/ref-link-python.mdx +++ b/weave/ref-link-python.mdx @@ -1,4 +1,5 @@ --- title: "Python SDK" +description: "Browse the W&B Weave Python SDK reference for tracing, evaluations, scorers, datasets, and feedback APIs." url: "/weave/reference/python-sdk" --- diff --git a/weave/ref-link-service-api.mdx b/weave/ref-link-service-api.mdx index 508138eaa6..e2b047bdb9 100644 --- a/weave/ref-link-service-api.mdx +++ b/weave/ref-link-service-api.mdx @@ -1,4 +1,5 @@ --- title: "Service API" +description: "Browse the W&B Weave Service API reference for managing calls, objects, files, and datasets through HTTP endpoints." url: "/weave/reference/service-api" --- diff --git a/weave/ref-link-typescript.mdx b/weave/ref-link-typescript.mdx index 9bb769b7d2..6a3a032942 100644 --- a/weave/ref-link-typescript.mdx +++ b/weave/ref-link-typescript.mdx @@ -1,4 +1,5 @@ --- title: "TypeScript SDK" +description: "Browse the W&B Weave TypeScript SDK reference including classes, functions, interfaces, and type aliases." url: "/weave/reference/typescript-sdk" --- From cd4e1881033d55afbfe13889da8307230e042b45 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 1 May 2026 00:27:38 +0000 Subject: [PATCH 2/2] chore: regenerate support tag pages --- support.mdx | 8 +- support/inference/tags/administrator.mdx | 2 +- .../inference/tags/authentication-access.mdx | 6 +- support/inference/tags/billing.mdx | 2 +- support/inference/tags/quotas-rate-limits.mdx | 4 +- support/inference/tags/server-errors.mdx | 4 +- support/models.mdx | 8 +- support/models/tags/academic.mdx | 4 +- support/models/tags/administrator.mdx | 48 ++++++------ support/models/tags/alerts.mdx | 4 +- support/models/tags/anonymous.mdx | 4 +- support/models/tags/artifacts.mdx | 28 +++---- support/models/tags/aws.mdx | 4 +- support/models/tags/billing.mdx | 6 +- support/models/tags/charts.mdx | 8 +- support/models/tags/connectivity.mdx | 6 +- support/models/tags/environment-variables.mdx | 24 +++--- support/models/tags/experiments.mdx | 78 +++++++++---------- support/models/tags/hyperparameter.mdx | 6 +- support/models/tags/inference.mdx | 10 +-- support/models/tags/logs.mdx | 14 ++-- support/models/tags/metrics.mdx | 38 ++++----- support/models/tags/notebooks.mdx | 6 +- support/models/tags/outage.mdx | 4 +- support/models/tags/privacy.mdx | 4 +- support/models/tags/projects.mdx | 6 +- support/models/tags/python.mdx | 12 +-- support/models/tags/reports.mdx | 30 +++---- support/models/tags/resuming.mdx | 4 +- support/models/tags/run-crashes.mdx | 20 ++--- support/models/tags/runs.mdx | 34 ++++---- support/models/tags/security.mdx | 14 ++-- support/models/tags/storage.mdx | 4 +- support/models/tags/sweeps.mdx | 38 ++++----- support/models/tags/tables.mdx | 4 +- support/models/tags/team-management.mdx | 16 ++-- support/models/tags/tensorboard.mdx | 4 +- support/models/tags/user-management.mdx | 22 +++--- support/models/tags/workspaces.mdx | 12 +-- support/models/tags/wysiwyg.mdx | 10 +-- support/weave/tags/client-info.mdx | 4 +- support/weave/tags/code-capture.mdx | 4 +- support/weave/tags/data-capture.mdx | 4 +- support/weave/tags/evaluation.mdx | 4 +- support/weave/tags/performance.mdx | 10 +-- support/weave/tags/system-info.mdx | 4 +- support/weave/tags/trace-data.mdx | 8 +- support/weave/tags/ui-rendering.mdx | 4 +- 48 files changed, 301 insertions(+), 301 deletions(-) diff --git a/support.mdx b/support.mdx index 2f6245053e..70f5260d30 100644 --- a/support.mdx +++ b/support.mdx @@ -42,22 +42,22 @@ and the W&B community. ### W&B Models - At the beginning of the training script, call wandb.init with an experiment name. For example: wandb.init(name="my_aweso ... + Learn how to configure the name of the run in your training code in W&B. [Experiments](/support/models/tags/experiments) - You can use W&B Sweeps with custom CLI commands if training configuration passes command-line arguments. In the example ... + Learn how to use custom CLI commands with sweeps in W&B: You can use W&B Sweeps with custom CLI commands if training configuration passes command-line... [Sweeps](/support/models/tags/sweeps) - By default, wandb.init starts a process that syncs metrics in real time to the cloud. For offline use, set two environme ... + By default, `wandb.init` starts a process that syncs metrics in real time to the cloud. [Experiments](/support/models/tags/experiments) [Environment Variables](/support/models/tags/environment-variables) [Metrics](/support/models/tags/metrics) - When wandb.init() runs in a training script, an API call creates a run object on the servers. A new process starts to st ... + When `wandb.init()` runs in a training script, an API call creates a run object on the servers. [Environment Variables](/support/models/tags/environment-variables) [Experiments](/support/models/tags/experiments) diff --git a/support/inference/tags/administrator.mdx b/support/inference/tags/administrator.mdx index ecdc4ad5ca..9b179d3449 100644 --- a/support/inference/tags/administrator.mdx +++ b/support/inference/tags/administrator.mdx @@ -6,5 +6,5 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - A 403 error with the message "The inference gateway is not enabled for your organization" means your organization doesn' ... + Resolve the W&B Inference 403 error returned when the inference gateway is not enabled for your organization. diff --git a/support/inference/tags/authentication-access.mdx b/support/inference/tags/authentication-access.mdx index d41d09a1e7..42b75505f5 100644 --- a/support/inference/tags/authentication-access.mdx +++ b/support/inference/tags/authentication-access.mdx @@ -6,11 +6,11 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - A 401 error with the message "Authentication failed" means your authentication credentials are incorrect or your W&B pro ... + Resolve the W&B Inference 401 "Authentication failed" error caused by incorrect API credentials, project entity, or project name. - A 403 error with the message "Country, region, or territory not supported" means you're accessing W&B Inference from an ... + Resolve the W&B Inference 403 error returned when accessing the API from a country, region, or territory that is not supported. - A 403 error with the message "The inference gateway is not enabled for your organization" means your organization doesn' ... + Resolve the W&B Inference 403 error returned when the inference gateway is not enabled for your organization. diff --git a/support/inference/tags/billing.mdx b/support/inference/tags/billing.mdx index dbd2d29057..16d2ed19ff 100644 --- a/support/inference/tags/billing.mdx +++ b/support/inference/tags/billing.mdx @@ -6,5 +6,5 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - A 402 error with the message "You exceeded your current quota, please check your plan and billing details" means you've ... + Resolve the W&B Inference 402 quota error caused by running out of credits or hitting your monthly spending cap. diff --git a/support/inference/tags/quotas-rate-limits.mdx b/support/inference/tags/quotas-rate-limits.mdx index 00c17aad9f..2a943a5c83 100644 --- a/support/inference/tags/quotas-rate-limits.mdx +++ b/support/inference/tags/quotas-rate-limits.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - A 402 error with the message "You exceeded your current quota, please check your plan and billing details" means you've ... + Resolve the W&B Inference 402 quota error caused by running out of credits or hitting your monthly spending cap. - A 429 error with the message "Concurrency limit reached for requests" means you're sending too many concurrent requests ... + Resolve the W&B Inference 429 error returned when you exceed the concurrency limit for parallel API requests. diff --git a/support/inference/tags/server-errors.mdx b/support/inference/tags/server-errors.mdx index 58b4942b16..0a38b08edb 100644 --- a/support/inference/tags/server-errors.mdx +++ b/support/inference/tags/server-errors.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - A 500 error with the message "The server had an error while processing your request" indicates an internal server error ... + Resolve the W&B Inference 500 internal server error, a transient issue that usually clears with a retry. - A 503 error with the message "The engine is currently overloaded, please try again later" means the W&B Inference server ... + Resolve the W&B Inference 503 "engine overloaded" error returned during periods of high traffic on the API. diff --git a/support/models.mdx b/support/models.mdx index b6be37d00d..752f9b449b 100644 --- a/support/models.mdx +++ b/support/models.mdx @@ -7,22 +7,22 @@ template: "scripts/knowledgebase-nav/templates/support_product_index.mdx.j2" ## Featured articles - At the beginning of the training script, call wandb.init with an experiment name. For example: wandb.init(name="my_aweso ... + Learn how to configure the name of the run in your training code in W&B. [Experiments](/support/models/tags/experiments) - You can use W&B Sweeps with custom CLI commands if training configuration passes command-line arguments. In the example ... + Learn how to use custom CLI commands with sweeps in W&B: You can use W&B Sweeps with custom CLI commands if training configuration passes command-line... [Sweeps](/support/models/tags/sweeps) - By default, wandb.init starts a process that syncs metrics in real time to the cloud. For offline use, set two environme ... + By default, `wandb.init` starts a process that syncs metrics in real time to the cloud. [Experiments](/support/models/tags/experiments) [Environment Variables](/support/models/tags/environment-variables) [Metrics](/support/models/tags/metrics) - When wandb.init() runs in a training script, an API call creates a run object on the servers. A new process starts to st ... + When `wandb.init()` runs in a training script, an API call creates a run object on the servers. [Environment Variables](/support/models/tags/environment-variables) [Experiments](/support/models/tags/experiments) diff --git a/support/models/tags/academic.mdx b/support/models/tags/academic.mdx index 4bca19ed43..966f9000de 100644 --- a/support/models/tags/academic.mdx +++ b/support/models/tags/academic.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Students can apply for an academic plan by following these steps: Visit the Pricing page on the wandb.com. Apply for the ... + Students can apply for an academic plan by following these steps: - Visit the Pricing page on the wandb.com. - To change an account from corporate to academic in W&B, follow these steps: 1. Link your academic email: Access account ... + Learn how to change your W&B account from corporate to academic in W&B. diff --git a/support/models/tags/administrator.mdx b/support/models/tags/administrator.mdx index 409c801eb6..6fdbfc5059 100644 --- a/support/models/tags/administrator.mdx +++ b/support/models/tags/administrator.mdx @@ -6,77 +6,77 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Students can apply for an academic plan by following these steps: Visit the Pricing page on the wandb.com. Apply for the ... + Students can apply for an academic plan by following these steps: - Visit the Pricing page on the wandb.com. - By default, W&B does not log dataset examples. By default, W&B logs code and system metrics. Two methods exist to turn o ... + Configure W&B to only log metrics by disabling code and dataset capture with environment variables such as `WANDB_DISABLE_CODE`. - A team admin can remove you from a team from the Users tab of the team settings. + Learn how to be removed from a team in W&B: A team admin can remove you from a team from the Users tab of the team settings. - To change an account from corporate to academic in W&B, follow these steps: 1. Link your academic email: Access account ... + Learn how to change your W&B account from corporate to academic in W&B. - To remove projects from a team space without admin privileges, follow these options: Request that a current admin remove ... + Learn how to remove projects from a team space without admin privileges in W&B. - Personal and service account keys can be rotated or revoked. Create a new API key or service account user, then reconfig ... + Learn how to rotate or revoke access in W&B: Personal and service account keys can be rotated or revoked. - View the bytes stored, bytes tracked, and tracked hours for your organization within organization settings: 1. Navigate ... + Learn how to see the bytes stored, bytes tracked and tracked hours of your organization in W&B. - Contact the support team (support@wandb.com). Provide the organization name, email associated with the account, and user ... + Cancel your W&B subscription by contacting the W&B support team at support@wandb.com. - To change the billing address, contact the support team (support@wandb.com). + Learn how to change your billing address in W&B: To change the billing address, contact the support team (support@wandb.com). - To delete a team from an account: Access team settings as an admin. Click the Delete button at the bottom of the page. + Delete a team from your W&B account by accessing team settings as an admin and choosing the delete option. - To delete an organization account, follow these steps, contact the support team (support@wandb.com). + Learn how to delete your W&B organization account in W&B: To delete an organization account, follow these steps, contact the support team (support@wandb.com). - To downgrade a subscription plan, contact the support team at support@wandb.com with your current plan details and the d ... + Learn how to downgrade your W&B subscription plan in W&B: To downgrade a subscription plan, contact the support team at support@wandb.com with your current... - To export a list of users from a W&B organization, an admin uses the SCIM API with the following code: Modify the script ... + Export a list of users from your W&B organization for auditing, reporting, or migration purposes. - Here are common service account issues and their solutions: "Unauthorized" errors Verify the API key is correctly set an ... + Learn how to fix service account errors like `Unauthorized` or missing runs in W&B. - To join a team, follow these steps: Contact a team admin or someone with administrative privileges to request an invite. ... + Learn how to get added to a team on W&B in W&B: To join a team, follow these steps: - Contact a team admin or someone with administrative privileges to... - To renew an expired license, contact the support team at support@wandb.com for assistance with the renewal process and t ... + Renew an expired W&B license by contacting the W&B support team at support@wandb.com for assistance with the renewal process. - If you are the admin for your instance, review the User Management section for instructions on adding users and creating ... + If you are the admin for your instance, review the User Management section for instructions on adding users and creating teams. - A service account cannot be added to multiple teams in W&B. Each service account is tied to a specific team. + A service account cannot be added to multiple teams in W&B. - Changing the username after account creation is not possible. Create a new account with the desired username instead. + Changing the username after account creation is not possible. The Teams plan does not offer a monthly subscription option. This subscription is billed annually. - To add more seats to an account, follow these steps: Contact the Account Executive or support team (support@wandb.com) f ... + To add more seats to an account, follow these steps: - Contact the Account Executive or support team (support@wandb.com) for assistance. - Check the Debug Bundle. An admin can retrieve it from the /system-admin page by selecting the W&B icon in the top right ... + Which files to check when troubleshooting issues on a self-hosted W&B local instance, such as logs and configuration. - A service account represents a non-human or machine identity, which can automate common tasks across teams and projects. ... + A service account represents a non-human or machine identity, which can automate common tasks across teams and projects. - A team serves as a collaborative workspace for users working on the same projects. An organization functions as a higher ... + A team serves as a collaborative workspace for users working on the same projects. - If your enterprise license is not recognized or features are not available after setting the license, check the followin ... + Resolve the "enterprise license not recognized" error in self-managed W&B deployments. diff --git a/support/models/tags/alerts.mdx b/support/models/tags/alerts.mdx index 9f16e1b659..0dbb8855bb 100644 --- a/support/models/tags/alerts.mdx +++ b/support/models/tags/alerts.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - No. Run Finished alerts (activated with the Run Finished setting in User Settings) operate only with Python scripts and ... + Do 'Run Finished' alerts work in notebooks: a common question and answer for W&B users. - To receive W&B alerts in Teams, follow these steps: Set up an email address for your Teams channel. Create an email addr ... + Learn how to send run alerts to Microsoft Teams in W&B: To receive W&B alerts in Teams, follow these steps: - Set up an email address for your Teams channel. diff --git a/support/models/tags/anonymous.mdx b/support/models/tags/anonymous.mdx index 264b7a157d..35c8fa1324 100644 --- a/support/models/tags/anonymous.mdx +++ b/support/models/tags/anonymous.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - If someone runs the script with anonymous="allow": 1. Auto-create temporary account: W&B checks for a signed-in account. ... + If someone runs the script with `anonymous="allow"`: 1. - No persistent data: Runs save for 7 days in an anonymous account. Claim anonymous run data by saving it to a real accoun ... + No persistent data: Runs save for 7 days in an anonymous account. diff --git a/support/models/tags/artifacts.mdx b/support/models/tags/artifacts.mdx index 2c9bd54302..0e45dd6149 100644 --- a/support/models/tags/artifacts.mdx +++ b/support/models/tags/artifacts.mdx @@ -6,44 +6,44 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Use wandb.init(mode="disabled") or set WANDB_MODE=disabled to configure W&B as a no-operation (NOOP) for testing purpose ... + Use `wandb.init(mode="disabled")` or set `WANDB_MODE=disabled` to configure W&B as a no-operation (NOOP) for testing purposes. - If an artifact reference is logged with W&B and versioning is enabled on the buckets, the version IDs appear in the Amaz ... + Learn how to fetch these Version IDs and ETags in W&B: If an artifact reference is logged with W&B and versioning is enabled on the buckets, the version IDs... - W&B tracks artifacts logged by each run and those used by each run to construct an artifact graph. This graph is a bipar ... + Find the artifacts logged or consumed by a W&B run, and find the runs that produced or consumed a given artifact. - One effective approach for logging models in a sweep involves creating a model artifact for the sweep. Each version repr ... + Learn how to best log models from runs in a sweep in W&B: One effective approach for logging models in a sweep involves creating a model artifact for the sweep. - To retrieve artifacts from the best performing run in a sweep, use the following code: + Learn how to find an artifact from the best run in a sweep in W&B: To retrieve artifacts from the best performing run in a sweep, use the following code: - Occasionally, it is necessary to mark an artifact as the output of a previously logged run. In this case, reinitialize t ... + Learn how to log an artifact to an existing run in W&B: Occasionally, it is necessary to mark an artifact as the output of a previously logged run. - Use save_code=True in wandb.init to save the main script or notebook that launches the run. To save all code for a run, ... + Learn how to save code?‌ in W&B: Use `save_code=True` in `wandb.init` to save the main script or notebook that launches the run. - To manage artifacts that contain sensitive data or to schedule the deletion of artifact versions, set a TTL (time-to-liv ... + Learn how to set a retention or expiration policy on your artifact in W&B. - Only files that change between two artifact versions incur storage costs. Consider an image artifact named animals that ... + Only files that change between two artifact versions incur storage costs. - When deleting a run, a prompt asks whether to delete the associated artifacts. Choosing this option permanently removes ... + When deleting a run, a prompt asks whether to delete the associated artifacts. - There are various methods to version a model. Artifacts provide a tool for model versioning tailored to specific needs. ... + There are various methods to version a model. Artifacts provide a tool for model versioning tailored to specific needs. - By default, artifacts download to the artifacts/ folder. To change the location: Pass it to wandb.Artifact().download: S ... + By default, artifacts download to the `artifacts/` folder. - Artifacts inherit access permissions from their parent project: In a private project, only team members can access artif ... + Artifacts inherit access permissions from their parent project: In a private project, only team members can access artifacts. - If you cannot link an artifact to a W&B Registry, the most common cause is that the artifact was logged with a personal ... + Resolve the W&B Registry error caused by trying to link an artifact logged with a personal entity instead of a team entity. diff --git a/support/models/tags/aws.mdx b/support/models/tags/aws.mdx index b178ff7095..d9d0986e5b 100644 --- a/support/models/tags/aws.mdx +++ b/support/models/tags/aws.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - To authenticate W&B, complete the following steps: create a requirements.txt file if using a built-in Amazon SageMaker e ... + To authenticate W&B, complete the following steps: create a `requirements.txt` file if using a built-in Amazon SageMaker estimator. - To publish the sweep_id so that any W&B Sweep agent can access it, implement a method for these agents to read and execu ... + To publish the `sweep_id` so that any W&B Sweep agent can access it, implement a method for these agents to read and execute the `sweep_id`. diff --git a/support/models/tags/billing.mdx b/support/models/tags/billing.mdx index 6b6fdb766d..92657793a5 100644 --- a/support/models/tags/billing.mdx +++ b/support/models/tags/billing.mdx @@ -6,13 +6,13 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - To change the billing address, contact the support team (support@wandb.com). + Learn how to change your billing address in W&B: To change the billing address, contact the support team (support@wandb.com). - To downgrade a subscription plan, contact the support team at support@wandb.com with your current plan details and the d ... + Learn how to downgrade your W&B subscription plan in W&B: To downgrade a subscription plan, contact the support team at support@wandb.com with your current... - To update your payment method, follow these steps: 1. Go to your profile page: First, navigate to your user profile page ... + Learn how to update our payment method in W&B: To update your payment method, follow these steps: 1. The Teams plan does not offer a monthly subscription option. This subscription is billed annually. diff --git a/support/models/tags/charts.mdx b/support/models/tags/charts.mdx index 8d90bbebcd..17145cd096 100644 --- a/support/models/tags/charts.mdx +++ b/support/models/tags/charts.mdx @@ -6,14 +6,14 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Direct integration of Plotly or Bokeh figures into tables is not supported. Instead, export the figures to HTML and incl ... + Learn how to add Plotly or Bokeh Charts into Tables in W&B: Direct integration of Plotly or Bokeh figures into tables is not supported. - Access the custom chart editor. Click on the currently selected chart type to open a menu displaying all presets. Hover ... + Learn how to delete a custom chart preset in W&B: Access the custom chart editor. - Enable this option on the "Other settings" page of the custom chart editor. Changing the query to use a historyTable ins ... + Learn how to show a 'step slider' in a custom chart in W&B: Enable this option on the "Other settings" page of the custom chart editor. - The summary displays in the table, while the log saves all values for future plotting. For instance, call run.log() when ... + The summary displays in the table, while the log saves all values for future plotting. diff --git a/support/models/tags/connectivity.mdx b/support/models/tags/connectivity.mdx index 740acd480a..d722510ed9 100644 --- a/support/models/tags/connectivity.mdx +++ b/support/models/tags/connectivity.mdx @@ -6,13 +6,13 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - To resolve the "Filestream rate limit exceeded" error in W&B, follow these steps: Optimize logging: Reduce logging frequ ... + Learn how to resolve the Filestream rate limit exceeded error in W&B: To resolve the "Filestream rate limit exceeded" error in W&B, follow these steps:... - If you encounter SSL or network errors, such as wandb: Network error (ConnectionError), entering retry loop, use the fol ... + Learn how to deal with network issues in W&B: If you encounter SSL or network errors, such as `wandb: Network error (ConnectionError), entering retry loop`,... - To resolve a run initialization timeout error, follow these steps: Retry initialization: Attempt to restart the run. Che ... + Learn how to resolve a run initialization timeout error in wandb in W&B. Check if the W&B Multi-tenant Cloud at wandb.ai is experiencing an outage by visiting the W&B status page. diff --git a/support/models/tags/environment-variables.mdx b/support/models/tags/environment-variables.mdx index 4ae803357c..8d12675616 100644 --- a/support/models/tags/environment-variables.mdx +++ b/support/models/tags/environment-variables.mdx @@ -6,38 +6,38 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - If training occurs on an offline machine, use the following steps to upload results to the servers: 1. Set the environme ... + If training occurs on an offline machine, use the following steps to upload results to the servers: 1. - Arguments passed to wandb.init override environment variables. To set a default directory other than the system default ... + Arguments passed to `wandb.init` override environment variables. - WANDB_DIR= or wandb.init(dir= ): Controls the location of the wandb folder created for your training script. Defaults to ... + Learn how to define the local location for `wandb` files in W&B: - `WANDB_DIR=` or `wandb.init(dir=)`: Controls the location of the `wandb` folder created... - If you encounter the error message "Failed to query for notebook name, you can set it manually with the WANDB_NOTEBOOK_N ... + Learn how to handle the 'Failed to query for notebook' error in W&B: If you encounter the error message `"Failed to query for notebook name, you can set it... - To suppress log messages in your notebook such as this: Set the log level to logging.ERROR to only show errors, suppress ... + Learn how to silence W&B info messages in W&B: To suppress log messages in your notebook such as this: Set the log level to `logging.ERROR` to only show... - Set the environment variable WANDB_SILENT to true. + Learn how to stop wandb from writing to your terminal or your Jupyter notebook output in W&B. - To manage two W&B accounts from the same machine, store both API keys in a file. Use the following code in your reposito ... + Learn how to switch between accounts on the same machine in W&B: To manage two W&B accounts from the same machine, store both API keys in a file. - W&B queues events in memory and writes them to disk asynchronously to manage failures and support the WANDB_MODE=offline ... + W&B queues events in memory and writes them to disk asynchronously to manage failures and support the `WANDB_MODE=offline` configuration, al - By default, wandb.init starts a process that syncs metrics in real time to the cloud. For offline use, set two environme ... + By default, `wandb.init` starts a process that syncs metrics in real time to the cloud. - When wandb.init() runs in a training script, an API call creates a run object on the servers. A new process starts to st ... + When `wandb.init()` runs in a training script, an API call creates a run object on the servers. - If the library cannot connect to the internet, it enters a retry loop and continues to attempt to stream metrics until t ... + If the library cannot connect to the internet, it enters a retry loop and continues to attempt to stream metrics until the network is restor - By default, artifacts download to the artifacts/ folder. To change the location: Pass it to wandb.Artifact().download: S ... + By default, artifacts download to the `artifacts/` folder. diff --git a/support/models/tags/experiments.mdx b/support/models/tags/experiments.mdx index 55099a165d..57d01d18bb 100644 --- a/support/models/tags/experiments.mdx +++ b/support/models/tags/experiments.mdx @@ -6,119 +6,119 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Yes. To overwrite the run name with the run ID, use the following code snippet: + Set a W&B run name to the run ID by overriding the run name with the ID after `wandb.init()`. - For example, I want to log training accuracy per batch and validation accuracy per epoch. Yes, log indices like batch an ... + Log metrics in W&B on two different time scales such as per-batch training accuracy and per-epoch validation accuracy. - If training occurs on an offline machine, use the following steps to upload results to the servers: 1. Set the environme ... + If training occurs on an offline machine, use the following steps to upload results to the servers: 1. - Yes, W&B uses the multiprocessing library. An error message like the following indicates a possible issue: To resolve th ... + Does W&B use the `multiprocessing` library: a common question and answer for W&B users. - "Is the logging function lazy? I don't want to depend on the network to send results to your servers while executing loc ... + Does logging block your training: a common question and answer for W&B users. - Pass a SHA or unique identifier to wandb.Run.config.update(...) to associate a dataset with a training run. W&B stores n ... + Pass a SHA or unique identifier to `wandb.Run.config.update(...)` to associate a dataset with a training run. - The history object tracks metrics logged with wandb.log. Access the history object using the API: + Learn how to access the data logged to your runs directly and programmatically in W&B. - Expand the image panel and use the step slider to navigate through images from different steps. This process facilitates ... + Learn how to compare images or media across epochs or steps in W&B: Expand the image panel and use the step slider to navigate through images from different... - At the beginning of the training script, call wandb.init with an experiment name. For example: wandb.init(name="my_aweso ... + Learn how to configure the name of the run in your training code in W&B. - WANDB_DIR= or wandb.init(dir= ): Controls the location of the wandb folder created for your training script. Defaults to ... + Learn how to define the local location for `wandb` files in W&B: - `WANDB_DIR=` or `wandb.init(dir=)`: Controls the location of the `wandb` folder created... - The / character separates logged panels in the W&B UI. By default, the segment of the logged item's name before the / de ... + Learn how to organize your logged charts and media in W&B: The `/` character separates logged panels in the W&B UI. - When wandb.init is invoked, the system automatically collects git information, including the remote repository link and ... + Learn how to save the git commit associated with your run in W&B: When `wandb.init` is invoked, the system automatically collects git information, including... - The Files tab shows a maximum of 10,000 files. To download all files, use the public API: + Learn how to see files that do not appear in the Files tab in W&B: The Files tab shows a maximum of 10,000 files. - If a training program uses multiple processes, structure the program to avoid making wandb method calls from processes w ... + Learn how to use wandb with multiprocessing, e.g. distributed training in W&B. - Direct integration of Plotly or Bokeh figures into tables is not supported. Instead, export the figures to HTML and incl ... + Learn how to add Plotly or Bokeh Charts into Tables in W&B: Direct integration of Plotly or Bokeh figures into tables is not supported. - If you receive an HTTP 429 Rate limit exceeded error when calling wandb.log(), you are exceeding the rate limit quota fo ... + Learn how to fix `Rate limit exceeded` errors when logging metrics in W&B. - Call a run object's .save() method to save the current run. Retrieve the name using the run object's name attribute. + Learn how to get the random run name in your script in W&B: Call a run object's `.save()` method to save the current run. - Finish previous runs before starting new runs to log multiple runs within a single script. The recommended way to do thi ... + Learn how to launch multiple runs from one script in W&B: Finish previous runs before starting new runs to log multiple runs within a single script. - These examples show logging losses a couple of different ways using wandb.Run.log(). For more, see the documentation on ... + Learn how to log a list of values in W&B: These examples show logging losses a couple of different ways using `wandb.Run.log()`. - Create a multi-line custom chart with wandb.plot.line_series(). Navigate to the project page to view the line chart. To ... + Learn how to plot multiple lines on a plot with a legend in W&B: Create a multi-line custom chart with `wandb.plot.line_series()`. - The .name attribute of a wandb.Run is accessible as follows: + Learn how to programmatically access the human-readable run name in W&B. - If a run is not explicitly named, W&B assigns a random name to identify it in your project. Examples of random names are ... + If a run is not explicitly named, W&B assigns a random name to identify it in your project. - This error indicates that the library encounters an issue launching the process that synchronizes data to the server. Th ... + This error indicates that the library encounters an issue launching the process that synchronizes data to the server. - By default, wandb.init starts a process that syncs metrics in real time to the cloud. For offline use, set two environme ... + By default, `wandb.init` starts a process that syncs metrics in real time to the cloud. - You likely lost connection to your machine during training. Recover data by running wandb sync PATH_TO_RUN (/models/ref/ ... + You likely lost connection to your machine during training. Recover data by running [`wandb sync [PATH_TO_RUN]`](/models/ref/cli/wandb-sync). - When wandb.init() runs in a training script, an API call creates a run object on the servers. A new process starts to st ... + When `wandb.init()` runs in a training script, an API call creates a run object on the servers. - Avoid passing class attributes into wandb.Run.log(). Attributes may change before the network call executes. When storin ... + Avoid passing class attributes into `wandb.Run.log()`. - The number of points sent affects the loading time of graphs in the UI. For lines exceeding 1,000 points, the backend sa ... + The number of points sent affects the loading time of graphs in the UI. - W&B supports projects that log only scalars by allowing explicit specification of files or data for upload. Refer to thi ... + W&B supports projects that log only scalars by allowing explicit specification of files or data for upload. - To log specific metrics in each batch and standardize plots, log the desired x-axis values alongside the metrics. In the ... + To log specific metrics in each batch and standardize plots, log the desired x-axis values alongside the metrics. - These modes are available: online (default): The client sends data to the wandb server. offline: The client stores data ... + These modes are available: `online` (default): The client sends data to the wandb server. - When visualizing metrics against an X-axis other than Step, expect to see fewer data points. Metrics must log at the sam ... + When visualizing metrics against an X-axis other than `Step`, expect to see fewer data points. - Export limits can prevent the entire run history from being exported as a CSV or using the run.history API. To access th ... + Export limits can prevent the entire run history from being exported as a CSV or using the `run.history` API. - Metric names in W&B must follow GraphQL naming conventions to ensure they can be properly sorted and filtered in the UI. ... + Metric names in W&B must follow GraphQL naming conventions to ensure they can be properly sorted and filtered in the UI. - If your process hangs when started with Hydra, this is likely caused by a multiprocessing conflict between Hydra and W&B ... + If your process hangs when started with Hydra, this is likely caused by a multiprocessing conflict between Hydra and W&B. - There are two common reasons training hangs when using W&B with distributed training: 1. Hanging at the beginning of tra ... + There are two common reasons training hangs when using W&B with distributed training: 1. - If the message "No visualization data logged yet" appears, the script has not executed the first wandb.log call. This si ... + If the message "No visualization data logged yet" appears, the script has not executed the first `wandb.log` call. - When logging various data types under the same key, split them in the database. This results in multiple entries of the ... + When logging various data types under the same key, split them in the database. - W&B has a minimal impact on training performance under normal usage conditions. Normal use includes logging at a rate of ... + W&B has a minimal impact on training performance under normal usage conditions. diff --git a/support/models/tags/hyperparameter.mdx b/support/models/tags/hyperparameter.mdx index 2d61906a1b..712484b2ae 100644 --- a/support/models/tags/hyperparameter.mdx +++ b/support/models/tags/hyperparameter.mdx @@ -6,11 +6,11 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Set unique tags with wandb.init(tags='your_tag'). This allows efficient filtering of project runs by selecting the corre ... + Set unique tags with `wandb.init(tags='your_tag')`. - If a grid search completes but some W&B Runs need re-execution due to crashes, delete the specific W&B Runs to re-run. T ... + If a grid search completes but some W&B Runs need re-execution due to crashes, delete the specific W&B Runs to re-run. - W&B provides an estimated number of Runs generated when creating a W&B Sweep with a discrete search space. This total re ... + W&B provides an estimated number of Runs generated when creating a W&B Sweep with a discrete search space. diff --git a/support/models/tags/inference.mdx b/support/models/tags/inference.mdx index 1a82e79092..2bbe8c82b7 100644 --- a/support/models/tags/inference.mdx +++ b/support/models/tags/inference.mdx @@ -6,17 +6,17 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - A 401 Invalid Authentication error means your API key is invalid or your W&B project entity/name is incorrect. Verify yo ... + Fix Invalid Authentication (401) errors with W&B Inference, typically caused by incorrect API credentials or project entity. - Server errors indicate temporary issues with the W&B Inference service. Error types 500 - Internal Server Error Message: ... + Fix server errors (500, 503) with W&B Inference. These errors indicate temporary issues with the inference service that usually clear with a retry. - Follow these best practices to handle W&B Inference errors gracefully and maintain reliable applications. 1. Always impl ... + Follow these best practices to handle W&B Inference errors gracefully and maintain reliable applications. - Insufficient quota errors (402) occur when you do not have remaining credits in your plan. Error: "You exceeded your cur ... + Insufficient quota errors (402) occur when you do not have remaining credits in your plan. - Rate limit errors (429) occur when you exceed concurrency limits. Error: "Concurrency limit reached for requests" Soluti ... + Rate limit errors (429) occur when you exceed concurrency limits. diff --git a/support/models/tags/logs.mdx b/support/models/tags/logs.mdx index 783c233fe9..082cb55f3c 100644 --- a/support/models/tags/logs.mdx +++ b/support/models/tags/logs.mdx @@ -6,23 +6,23 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - "Is the logging function lazy? I don't want to depend on the network to send results to your servers while executing loc ... + Does logging block your training: a common question and answer for W&B users. - To overwrite logs from previous steps, use forking and rewind. + Learn how to overwrite the logs from previous steps in W&B: To overwrite logs from previous steps, use forking and rewind. - These examples show logging losses a couple of different ways using wandb.Run.log(). For more, see the documentation on ... + Learn how to log a list of values in W&B: These examples show logging losses a couple of different ways using `wandb.Run.log()`. - To launch automated tests or internal tools that log to W&B, create a Service Account on the team settings page. This ac ... + Learn how to log runs launched by continuous integration or internal tools in W&B. - When using a shared machine, ensure that runs log to the correct WandB account by setting the WANDB_API_KEY environment ... + Learn how to log to the right wandb user on a shared machine in W&B: When using a shared machine, ensure that runs log to the correct WandB account by... - The command wandb offline sets the environment variable WANDB_MODE=offline, preventing data from syncing to the remote W ... + Learn how to turn off logging in W&B: The command `wandb offline` sets the environment variable `WANDB_MODE=offline`, preventing data from syncing to the... - For the affected run, check debug.log and debug-internal.log in wandb/run- _ - /logs in the directory where your code is ... + For the affected run, check `debug.log` and `debug-internal.log` in `wandb/run-_-/logs` in the directory where your code is running. diff --git a/support/models/tags/metrics.mdx b/support/models/tags/metrics.mdx index 3c92261b69..e1944da47f 100644 --- a/support/models/tags/metrics.mdx +++ b/support/models/tags/metrics.mdx @@ -6,59 +6,59 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - By default, W&B does not log dataset examples. By default, W&B logs code and system metrics. Two methods exist to turn o ... + Configure W&B to only log metrics by disabling code and dataset capture with environment variables such as `WANDB_DISABLE_CODE`. - For example, I want to log training accuracy per batch and validation accuracy per epoch. Yes, log indices like batch an ... + Log metrics in W&B on two different time scales such as per-batch training accuracy and per-epoch validation accuracy. - To configure the frequency to log system metrics, set _stats_sampling_interval to a number of seconds, expressed as a fl ... + Learn how to change how frequently to log system metrics in W&B: To configure the frequency to log system metrics, set `_stats_sampling_interval` to a... - To disable logging of system metrics, set _disable_stats to True: + Learn how to disable logging of system metrics to W&B in W&B: To disable logging of system metrics, set `_disable_stats` to `True`: - There are several ways to manage experiments. For complex workflows, use multiple runs and set the group parameters in w ... + Learn how to log additional metrics after a run completes in W&B: There are several ways to manage experiments. - To overwrite logs from previous steps, use forking and rewind. + Learn how to overwrite the logs from previous steps in W&B: To overwrite logs from previous steps, use forking and rewind. - If you receive an HTTP 429 Rate limit exceeded error when calling wandb.log(), you are exceeding the rate limit quota fo ... + Learn how to fix `Rate limit exceeded` errors when logging metrics in W&B. - The following error usually occurs when you do not log the metric that you are optimizing: To fix this, make sure you ar ... + Fix the `anaconda 400 error` during a W&B sweep by logging the metric specified in your sweep configuration. - Metrics collect by default every 10 seconds. For higher resolution metrics, email contact@wandb.com. + How often are system metrics collected: a quick reference for W&B users. - Create a scatter plot of the metric. Open the Edit menu and select Annotations. From there, plot the running maximum of ... + Whether it is possible to plot the max of a metric rather than plot step by step in W&B and how to do it. - By default, wandb.init starts a process that syncs metrics in real time to the cloud. For offline use, set two environme ... + By default, `wandb.init` starts a process that syncs metrics in real time to the cloud. - To optimize multiple metrics in a single run, use a weighted sum of the individual metrics. Log the new combined metric ... + To optimize multiple metrics in a single run, use a weighted sum of the individual metrics. - The number of points sent affects the loading time of graphs in the UI. For lines exceeding 1,000 points, the backend sa ... + The number of points sent affects the loading time of graphs in the UI. - To log specific metrics in each batch and standardize plots, log the desired x-axis values alongside the metrics. In the ... + To log specific metrics in each batch and standardize plots, log the desired x-axis values alongside the metrics. - When visualizing metrics against an X-axis other than Step, expect to see fewer data points. Metrics must log at the sam ... + When visualizing metrics against an X-axis other than `Step`, expect to see fewer data points. - Metric names in W&B must follow GraphQL naming conventions to ensure they can be properly sorted and filtered in the UI. ... + Metric names in W&B must follow GraphQL naming conventions to ensure they can be properly sorted and filtered in the UI. - Workspaces can load slowly when a project has a large number of metrics, runs, or panels. Here are common causes and fix ... + Workspaces can load slowly when a project has a large number of metrics, runs, or panels. - If the message "No visualization data logged yet" appears, the script has not executed the first wandb.log call. This si ... + If the message "No visualization data logged yet" appears, the script has not executed the first `wandb.log` call. - When logging various data types under the same key, split them in the database. This results in multiple entries of the ... + When logging various data types under the same key, split them in the database. diff --git a/support/models/tags/notebooks.mdx b/support/models/tags/notebooks.mdx index cb8117eb7a..ba2612e0e8 100644 --- a/support/models/tags/notebooks.mdx +++ b/support/models/tags/notebooks.mdx @@ -6,11 +6,11 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - No. Run Finished alerts (activated with the Run Finished setting in User Settings) operate only with Python scripts and ... + Do 'Run Finished' alerts work in notebooks: a common question and answer for W&B users. - If you encounter the error message "Failed to query for notebook name, you can set it manually with the WANDB_NOTEBOOK_N ... + Learn how to handle the 'Failed to query for notebook' error in W&B: If you encounter the error message `"Failed to query for notebook name, you can set it... - To suppress log messages in your notebook such as this: Set the log level to logging.ERROR to only show errors, suppress ... + Learn how to silence W&B info messages in W&B: To suppress log messages in your notebook such as this: Set the log level to `logging.ERROR` to only show... diff --git a/support/models/tags/outage.mdx b/support/models/tags/outage.mdx index f7fb6e331a..39e244ec67 100644 --- a/support/models/tags/outage.mdx +++ b/support/models/tags/outage.mdx @@ -6,11 +6,11 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - To resolve the "Filestream rate limit exceeded" error in W&B, follow these steps: Optimize logging: Reduce logging frequ ... + Learn how to resolve the Filestream rate limit exceeded error in W&B: To resolve the "Filestream rate limit exceeded" error in W&B, follow these steps:... Check if the W&B Multi-tenant Cloud at wandb.ai is experiencing an outage by visiting the W&B status page. - If the library cannot connect to the internet, it enters a retry loop and continues to attempt to stream metrics until t ... + If the library cannot connect to the internet, it enters a retry loop and continues to attempt to stream metrics until the network is restor diff --git a/support/models/tags/privacy.mdx b/support/models/tags/privacy.mdx index fdc935f65d..d3c8375288 100644 --- a/support/models/tags/privacy.mdx +++ b/support/models/tags/privacy.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Key engineers and support staff at W&B access logged values for debugging purposes with user permission. All data stores ... + Key engineers and support staff at W&B access logged values for debugging purposes with user permission. - To change a project's privacy (visibility): 1. In the W&B App, from any page in the project, click Overview in the proje ... + Learn how to change the privacy of your project in W&B: To change a project's privacy (visibility): 1. diff --git a/support/models/tags/projects.mdx b/support/models/tags/projects.mdx index 4ce54e7d82..268a323f86 100644 --- a/support/models/tags/projects.mdx +++ b/support/models/tags/projects.mdx @@ -6,13 +6,13 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - To change a project's privacy (visibility): 1. In the W&B App, from any page in the project, click Overview in the proje ... + Learn how to change the privacy of your project in W&B: To change a project's privacy (visibility): 1. - Use the public API to delete multiple runs in a single operation: + Learn how to delete multiple runs in bulk instead of one at a time in W&B. - To rename a project: Navigate to the Project overview. Click on Edit Project. Note: If the project name is protected, su ... + Learn how to rename a project in W&B: To rename a project: - Navigate to the Project overview. Limit each project to approximately 10,000 runs for optimal performance. diff --git a/support/models/tags/python.mdx b/support/models/tags/python.mdx index 6be49e7f61..ea583a68a4 100644 --- a/support/models/tags/python.mdx +++ b/support/models/tags/python.mdx @@ -6,20 +6,20 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - The W&B client library supported both Python 2.7 and Python 3 through version 0.10. Support for Python 2.7 discontinued ... + The W&B client library supported both Python 2.7 and Python 3 through version 0.10. - The W&B client library supported Python 3.5 until version 0.11. Support for Python 3.5 ended with version 0.12, which al ... + The W&B client library supported Python 3.5 until version 0.11. - The library supports Python 2.7 and later, as well as Python 3.6 and later. The architecture facilitates integration wit ... + The library supports Python 2.7 and later, as well as Python 3.6 and later. - To resume a sweep, pass the sweep_id to the wandb.agent() function. + Learn how to resume a sweep using Python code in W&B: To resume a sweep, pass the `sweep_id` to the `wandb.agent()` function. - If an error occurs when installing wandb that states: Install psutil directly from a pre-built wheel. Determine your Pyt ... + Learn how to install the wandb Python library in environments without gcc in W&B. - There is an anaconda package that is installable using either pip or conda. For conda, obtain the package from the conda ... + There is an anaconda package that is installable using either `pip` or `conda`. diff --git a/support/models/tags/reports.mdx b/support/models/tags/reports.mdx index a587d1d471..74d03fc28f 100644 --- a/support/models/tags/reports.mdx +++ b/support/models/tags/reports.mdx @@ -6,47 +6,47 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Accurately credit all contributors in your report by adding multiple authors. To add multiple authors, click on the + ic ... + Add multiple authors to a W&B report so all contributors are credited, using the author dropdown next to the author name. - Yes. Type "/mark" anywhere in the document and press enter to insert a Markdown block. This allows editing with Markdown ... + Use Markdown formatting in W&B reports for headings, lists, links, and other rich text content. - You can share your report by embedding it. Click the Share button at the top right of your report, then copy the embedde ... + Embed W&B reports in external websites and tools to share live experiment results, charts, and analyses. - Use the search bar to filter the reports list. Select an unwanted report to delete it individually, or select all report ... + Filter and delete unwanted W&B reports from your project to keep your reports list organized. - Select the panel grid and press delete or backspace. Click the drag handle in the top-right corner to select the panel g ... + Learn how to delete a panel grid in W&B: Select the panel grid and press delete or backspace. - Tables remain the only feature from Markdown without a direct WYSIWYG equivalent. To add a table, insert a Markdown bloc ... + Learn how to insert a table in W&B: Tables remain the only feature from Markdown without a direct WYSIWYG equivalent. - With W&B Reports, follow these steps: 1. Create multiple panel grids. 2. Apply filters to select the desired run sets fo ... + How to get multiple charts with different selected runs: a quick reference for W&B users. - If the report conversion occurred through the message at the top, click the red "Revert" button to restore the prior sta ... + If the report conversion occurred through the message at the top, click the red "Revert" button to restore the prior state. - LaTeX integrates seamlessly into reports. To add LaTeX, create a new report and begin typing in the rich text area to wr ... + Incorporating LaTeX. A common question and answer for W&B users. - Performance issues may arise on older hardware or with very large reports. To mitigate this, collapse sections of the re ... + Performance issues may arise on older hardware or with very large reports. - The goal is to maintain the original appearance after transitioning to WYSIWYG, but the conversion process is not flawle ... + The goal is to maintain the original appearance after transitioning to WYSIWYG, but the conversion process is not flawless. - Workspaces automatically load updated data. Auto-refresh does not apply to reports. Reload the page to refresh report da ... + Workspaces automatically load updated data. Auto-refresh does not apply to reports. - To upload a CSV to a report, use the wandb.Table format. Load the CSV in your Python script and log it as a wandb.Table ... + Upload a CSV file to a W&B report by loading it as a `wandb.Table` in Python and logging it to a run. - Press / on a new line, scroll to the Image option, and drag and drop an image into the report. + Upload an image to a W&B report by adding it from the report editor or logging it as a `wandb.Image` to a run. - Reports created within an individual's private project remain visible only to that user. The user can share their projec ... + Reports created within an individual's private project remain visible only to that user. diff --git a/support/models/tags/resuming.mdx b/support/models/tags/resuming.mdx index f70eddd754..6a1d0562a7 100644 --- a/support/models/tags/resuming.mdx +++ b/support/models/tags/resuming.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - If you encounter the error resume='must' but run ( ) doesn't exist, the run you are attempting to resume does not exist ... + Learn how to fix the error `resume='must' but run () doesn't exist` in W&B. - To use the resume parameter in W&B , set the resume argument in wandb.init() with entity, project, and id specified. The ... + Learn how to use the resume parameter when resuming a run in W&B: To use the `resume` parameter in W&B , set the `resume` argument in `wandb.init()` with... diff --git a/support/models/tags/run-crashes.mdx b/support/models/tags/run-crashes.mdx index 2605cdaae8..81f4b2d85e 100644 --- a/support/models/tags/run-crashes.mdx +++ b/support/models/tags/run-crashes.mdx @@ -6,32 +6,32 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - If you encounter an error like AttributeError: module 'wandb' has no attribute 'init' or AttributeError: module 'wandb' ... + Learn how to fix an error like `AttributeError: module 'wandb' has no attribute ...` in W&B. - If you see Cuda out of memory during a sweep, refactor your code to use process-based execution. Rewrite your code as a ... + Learn how to fix `Cuda out of memory` during a sweep in W&B: If you see `Cuda out of memory` during a sweep, refactor your code to use process-based execution. - Press Ctrl+D on the keyboard to stop a script instrumented with W&B. + Learn how to kill a job with wandb in W&B: Press `Ctrl+D` on the keyboard to stop a script instrumented with W&B. - To resolve a run initialization timeout error, follow these steps: Retry initialization: Attempt to restart the run. Che ... + Learn how to resolve a run initialization timeout error in wandb in W&B. - It is critical to avoid interference with training runs. W&B operates in a separate process, ensuring that training cont ... + It is critical to avoid interference with training runs. - This error indicates that the library encounters an issue launching the process that synchronizes data to the server. Th ... + This error indicates that the library encounters an issue launching the process that synchronizes data to the server. - You likely lost connection to your machine during training. Recover data by running wandb sync PATH_TO_RUN (/models/ref/ ... + You likely lost connection to your machine during training. Recover data by running [`wandb sync [PATH_TO_RUN]`](/models/ref/cli/wandb-sync). - If your process hangs when started with Hydra, this is likely caused by a multiprocessing conflict between Hydra and W&B ... + If your process hangs when started with Hydra, this is likely caused by a multiprocessing conflict between Hydra and W&B. - There are two common reasons training hangs when using W&B with distributed training: 1. Hanging at the beginning of tra ... + There are two common reasons training hangs when using W&B with distributed training: 1. - This indicates a connection problem. If the server loses internet access and data stops syncing to W&B, the system marks ... + Why is a run marked crashed in W&B when it’s training fine locally: a common question and answer for W&B users. diff --git a/support/models/tags/runs.mdx b/support/models/tags/runs.mdx index f7206bfd61..3125ff0646 100644 --- a/support/models/tags/runs.mdx +++ b/support/models/tags/runs.mdx @@ -6,59 +6,59 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Set unique tags with wandb.init(tags='your_tag'). This allows efficient filtering of project runs by selecting the corre ... + Set unique tags with `wandb.init(tags='your_tag')`. - Yes, you can also use tags or custom metadata to categorize runs. That can be done using the Group button which is avail ... + Yes, you can also use tags or custom metadata to categorize runs. - If a grid search completes but some W&B Runs need re-execution due to crashes, delete the specific W&B Runs to re-run. T ... + If a grid search completes but some W&B Runs need re-execution due to crashes, delete the specific W&B Runs to re-run. - A run can have multiple tags, so grouping by tags is not supported. Add a value to the config object for these runs and ... + A run can have multiple tags, so grouping by tags is not supported. Add a value to the `config` object for these runs and group by this config value instead. - To configure the frequency to log system metrics, set _stats_sampling_interval to a number of seconds, expressed as a fl ... + Learn how to change how frequently to log system metrics in W&B: To configure the frequency to log system metrics, set `_stats_sampling_interval` to a... - Changing the colors of individual runs within a group is not possible. All runs in the same group share a common color. + Learn how to change the colors of each run in the same group in W&B: Changing the colors of individual runs within a group is not possible. - Use the public API to delete multiple runs in a single operation: + Learn how to delete multiple runs in bulk instead of one at a time in W&B. - To disable logging of system metrics, set _disable_stats to True: + Learn how to disable logging of system metrics to W&B in W&B: To disable logging of system metrics, set `_disable_stats` to `True`: - Using run.log( ) updates the final accuracy correctly. By default, run.log( ) updates run.settings 'final_accuracy' , wh ... + Learn how to log a metric that doesn't change over time such as a final evaluation accuracy in W&B. - There are several ways to manage experiments. For complex workflows, use multiple runs and set the group parameters in w ... + Learn how to log additional metrics after a run completes in W&B: There are several ways to manage experiments. Learn how to recover recently deleted runs in the W&B App for up to 7 days. - If you see both CommError, Run does not exist and ERROR Error uploading during a sweep, the most likely cause is that yo ... + Learn how to fix `CommError, Run does not exist` during a sweep in W&B. - If you encounter the error resume='must' but run ( ) doesn't exist, the run you are attempting to resume does not exist ... + Learn how to fix the error `resume='must' but run () doesn't exist` in W&B. - To launch automated tests or internal tools that log to W&B, create a Service Account on the team settings page. This ac ... + Learn how to log runs launched by continuous integration or internal tools in W&B. - To resolve permission errors when logging a run to a W&B entity, follow these steps: Verify entity and project names: En ... + Learn how to resolve permission errors when logging a run in W&B: To resolve permission errors when logging a run to a W&B entity, follow these steps: -... Limit each project to approximately 10,000 runs for optimal performance. - You can change the group assigned to a completed run using the API. This feature does not appear in the web UI. Use the ... + You can change the group assigned to a completed run using the API. - You can move a run from one project to another by following these steps: Navigate to the project page with the run to be ... + You can move a run from one project to another by following these steps: - Navigate to the project page with the run to be moved. - Export limits can prevent the entire run history from being exported as a CSV or using the run.history API. To access th ... + Export limits can prevent the entire run history from being exported as a CSV or using the `run.history` API. diff --git a/support/models/tags/security.mdx b/support/models/tags/security.mdx index fd6ec898e7..dea62958c4 100644 --- a/support/models/tags/security.mdx +++ b/support/models/tags/security.mdx @@ -6,23 +6,23 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Key engineers and support staff at W&B access logged values for debugging purposes with user permission. All data stores ... + Key engineers and support staff at W&B access logged values for debugging purposes with user permission. - Weights and Biases has a bug bounty program. Access the W&B security portal for details. + Do you have a bug bounty program: a common question and answer for W&B users. - W&B supports Single Sign-On (SSO) for the Multi-tenant offering through Auth0. SSO integration is compatible with any OI ... + W&B supports Single Sign-On (SSO) for the Multi-tenant offering through Auth0. - Personal and service account keys can be rotated or revoked. Create a new API key or service account user, then reconfig ... + Learn how to rotate or revoke access in W&B: Personal and service account keys can be rotated or revoked. - import ApiKeyFind from "/snippets/_includes/api-key-find.mdx"; + Find your W&B API key in your User Settings page so you can authenticate the W&B SDK and CLI. - Here are common service account issues and their solutions: "Unauthorized" errors Verify the API key is correctly set an ... + Learn how to fix service account errors like `Unauthorized` or missing runs in W&B. - To resolve permission errors when logging a run to a W&B entity, follow these steps: Verify entity and project names: En ... + Learn how to resolve permission errors when logging a run in W&B: To resolve permission errors when logging a run to a W&B entity, follow these steps: -... diff --git a/support/models/tags/storage.mdx b/support/models/tags/storage.mdx index 86ddedf728..29b3c8bb51 100644 --- a/support/models/tags/storage.mdx +++ b/support/models/tags/storage.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Only files that change between two artifact versions incur storage costs. Consider an image artifact named animals that ... + Only files that change between two artifact versions incur storage costs. - The storage meter does not update immediately after deleting runs due to processing delays. The backend system requires ... + - The storage meter does not update immediately after deleting runs due to processing delays. diff --git a/support/models/tags/sweeps.mdx b/support/models/tags/sweeps.mdx index 1f907f0f4f..203465500f 100644 --- a/support/models/tags/sweeps.mdx +++ b/support/models/tags/sweeps.mdx @@ -6,59 +6,59 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Set unique tags with wandb.init(tags='your_tag'). This allows efficient filtering of project runs by selecting the corre ... + Set unique tags with `wandb.init(tags='your_tag')`. - If a grid search completes but some W&B Runs need re-execution due to crashes, delete the specific W&B Runs to re-run. T ... + If a grid search completes but some W&B Runs need re-execution due to crashes, delete the specific W&B Runs to re-run. - To authenticate W&B, complete the following steps: create a requirements.txt file if using a built-in Amazon SageMaker e ... + To authenticate W&B, complete the following steps: create a `requirements.txt` file if using a built-in Amazon SageMaker estimator. - Use the macro in the command section of the configuration to pass hyperparameters as boolean flags. This macro automatic ... + Use the `${args_no_boolean_flags}` macro in the command section of the configuration to pass hyperparameters as boolean flags. - To publish the sweep_id so that any W&B Sweep agent can access it, implement a method for these agents to read and execu ... + To publish the `sweep_id` so that any W&B Sweep agent can access it, implement a method for these agents to read and execute the `sweep_id`. - Access hyperparameter names and values from the sweep configuration using (run.config()), which acts like a dictionary. ... + Access hyperparameter names and values from the sweep configuration using `(run.config())`, which acts like a dictionary. - Set the logging directory for W&B run data by configuring the environment variable WANDB_DIR. For example: + Learn how to change the directory your sweep logs to locally in W&B: Set the logging directory for W&B run data by configuring the environment variable... - To resume a sweep, pass the sweep_id to the wandb.agent() function. + Learn how to resume a sweep using Python code in W&B: To resume a sweep, pass the `sweep_id` to the `wandb.agent()` function. - One effective approach for logging models in a sweep involves creating a model artifact for the sweep. Each version repr ... + Learn how to best log models from runs in a sweep in W&B: One effective approach for logging models in a sweep involves creating a model artifact for the sweep. - To enable code logging for sweeps, add wandb.log_code() after initializing the W&B Run. This action is necessary even wh ... + Learn how to enable code logging with Sweeps in W&B: To enable code logging for sweeps, add `wandb.log_code()` after initializing the W&B Run. - If you see both CommError, Run does not exist and ERROR Error uploading during a sweep, the most likely cause is that yo ... + Learn how to fix `CommError, Run does not exist` during a sweep in W&B. - If you see Cuda out of memory during a sweep, refactor your code to use process-based execution. Rewrite your code as a ... + Learn how to fix `Cuda out of memory` during a sweep in W&B: If you see `Cuda out of memory` during a sweep, refactor your code to use process-based execution. - The following error usually occurs when you do not log the metric that you are optimizing: To fix this, make sure you ar ... + Fix the `anaconda 400 error` during a W&B sweep by logging the metric specified in your sweep configuration. - You can use W&B Sweeps with custom CLI commands if training configuration passes command-line arguments. In the example ... + Learn how to use custom CLI commands with sweeps in W&B: You can use W&B Sweeps with custom CLI commands if training configuration passes command-line... - When using sweeps with the SLURM scheduling system, run wandb agent --count 1 SWEEP_ID in each scheduled job. This comma ... + When using sweeps with the SLURM scheduling system, run `wandb agent --count 1 SWEEP_ID` in each scheduled job. - Once a W&B Sweep starts, you cannot change the Sweep configuration. However, you can navigate to any table view, select ... + Once a W&B Sweep starts, you cannot change the Sweep configuration. - To optimize multiple metrics in a single run, use a weighted sum of the individual metrics. Log the new combined metric ... + To optimize multiple metrics in a single run, use a weighted sum of the individual metrics. - While a sweep is running: If the train.py script which the sweep uses changes, the sweep continues to use the original t ... + While a sweep is running: - If the `train.py` script which the sweep uses changes, the sweep continues to use the original `train.py` - If f - W&B provides an estimated number of Runs generated when creating a W&B Sweep with a discrete search space. This total re ... + W&B provides an estimated number of Runs generated when creating a W&B Sweep with a discrete search space. diff --git a/support/models/tags/tables.mdx b/support/models/tags/tables.mdx index 8cfa7957a3..b9610d4dc8 100644 --- a/support/models/tags/tables.mdx +++ b/support/models/tags/tables.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Direct integration of Plotly or Bokeh figures into tables is not supported. Instead, export the figures to HTML and incl ... + Learn how to add Plotly or Bokeh Charts into Tables in W&B: Direct integration of Plotly or Bokeh figures into tables is not supported. - Tables remain the only feature from Markdown without a direct WYSIWYG equivalent. To add a table, insert a Markdown bloc ... + Learn how to insert a table in W&B: Tables remain the only feature from Markdown without a direct WYSIWYG equivalent. diff --git a/support/models/tags/team-management.mdx b/support/models/tags/team-management.mdx index d5d7836468..b2b12e4baa 100644 --- a/support/models/tags/team-management.mdx +++ b/support/models/tags/team-management.mdx @@ -6,19 +6,19 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - By default, W&B does not log dataset examples. By default, W&B logs code and system metrics. Two methods exist to turn o ... + Configure W&B to only log metrics by disabling code and dataset capture with environment variables such as `WANDB_DISABLE_CODE`. - A team admin can remove you from a team from the Users tab of the team settings. + Learn how to be removed from a team in W&B: A team admin can remove you from a team from the Users tab of the team settings. - To delete a team from an account: Access team settings as an admin. Click the Delete button at the bottom of the page. + Delete a team from your W&B account by accessing team settings as an admin and choosing the delete option. - To join a team, follow these steps: Contact a team admin or someone with administrative privileges to request an invite. ... + Learn how to get added to a team on W&B in W&B: To join a team, follow these steps: - Contact a team admin or someone with administrative privileges to... - A service account cannot be added to multiple teams in W&B. Each service account is tied to a specific team. + A service account cannot be added to multiple teams in W&B. The Teams plan does not offer a monthly subscription option. This subscription is billed annually. @@ -27,16 +27,16 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" For additional information about teams, visit the teams section. - A team serves as a collaborative workspace for users working on the same projects. An entity represents either a usernam ... + A team serves as a collaborative workspace for users working on the same projects. - A team serves as a collaborative workspace for users working on the same projects. An organization functions as a higher ... + A team serves as a collaborative workspace for users working on the same projects. Visit the Team roles and permissions page for an overview of the available roles and permissions. - Personal Entities are unavailable for accounts created after May 21, 2024. W&B encourages all users to log new projects ... + Personal Entities are unavailable for accounts created after May 21, 2024. Refer to the link for details on roles and permissions: Team Roles and Permissions. diff --git a/support/models/tags/tensorboard.mdx b/support/models/tags/tensorboard.mdx index 37b9d179f0..7d200bbcc6 100644 --- a/support/models/tags/tensorboard.mdx +++ b/support/models/tags/tensorboard.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - W&B integrates with TensorBoard and improves experiment tracking tools. The founders created W&B to address common frust ... + W&B integrates with TensorBoard and improves experiment tracking tools. - The exponential moving average formula aligns with the one used in TensorBoard. Refer to this explanation on Stack OverF ... + The exponential moving average formula aligns with the one used in TensorBoard. diff --git a/support/models/tags/user-management.mdx b/support/models/tags/user-management.mdx index 94930136c7..605d3e70a5 100644 --- a/support/models/tags/user-management.mdx +++ b/support/models/tags/user-management.mdx @@ -6,40 +6,40 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Students can apply for an academic plan by following these steps: Visit the Pricing page on the wandb.com. Apply for the ... + Students can apply for an academic plan by following these steps: - Visit the Pricing page on the wandb.com. - To change an account from corporate to academic in W&B, follow these steps: 1. Link your academic email: Access account ... + Learn how to change your W&B account from corporate to academic in W&B. - Delete your user account by clicking Delete account in your user settings. Note that this action is irreversible and it ... + Learn how to delete your W&B user account in W&B: Delete your user account by clicking Delete account in your user settings. - Set the login URL by either of these methods: Set the environment variable WANDB_BASE_URL to the Server URL. Set the --h ... + Log in to W&B Server by setting the `WANDB_BASE_URL` environment variable to your Server URL or configuring it in the SDK settings. - To regain access to an account when unable to receive a password reset email: 1. Check Spam or Junk Folders: Ensure the ... + Learn how to regain access to your W&B account when you cannot receive a password reset email in W&B. - To resolve login issues, follow these steps: Verify access: Confirm you are using the correct email or username and chec ... + Resolve W&B login issues by verifying access, checking your API key, confirming the correct account, and reviewing the login URL. - To export a list of users from a W&B organization, an admin uses the SCIM API with the following code: Modify the script ... + Export a list of users from your W&B organization for auditing, reporting, or migration purposes. - import ApiKeyFind from "/snippets/_includes/api-key-find.mdx"; + Find your W&B API key in your User Settings page so you can authenticate the W&B SDK and CLI. - To delete a W&B account, navigate to the User settings page, scroll to the bottom, and click the Delete Account button. + Request the complete deletion of your W&B account, including all data and resources, by contacting W&B support. - Changing the username after account creation is not possible. Create a new account with the desired username instead. + Changing the username after account creation is not possible. A new account can use an email previously associated with a deleted account. - To add more seats to an account, follow these steps: Contact the Account Executive or support team (support@wandb.com) f ... + To add more seats to an account, follow these steps: - Contact the Account Executive or support team (support@wandb.com) for assistance. Visit the Team roles and permissions page for an overview of the available roles and permissions. diff --git a/support/models/tags/workspaces.mdx b/support/models/tags/workspaces.mdx index 9a01c2873c..c6fb50717f 100644 --- a/support/models/tags/workspaces.mdx +++ b/support/models/tags/workspaces.mdx @@ -6,23 +6,23 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Yes, you can also use tags or custom metadata to categorize runs. That can be done using the Group button which is avail ... + Yes, you can also use tags or custom metadata to categorize runs. - Changing the colors of individual runs within a group is not possible. All runs in the same group share a common color. + Learn how to change the colors of each run in the same group in W&B: Changing the colors of individual runs within a group is not possible. - To resolve this error, add ?workspace=clear to the end of the URL and press Enter. This action directs you to a cleared ... + Learn how to fix the 'overflows maximum values of a signed 64 bits integer' error in W&B. - Dark mode is in beta and not optimized for accessibility. To enable dark mode: 1. Go to your W&B account settings. 2. Sc ... + Dark mode is in beta and not optimized for accessibility. To enable dark mode: 1. - Workspaces automatically load updated data. Auto-refresh does not apply to reports. Reload the page to refresh report da ... + Workspaces automatically load updated data. Auto-refresh does not apply to reports. Some functionalities are hidden under a feature flag in the Beta Features section of a team's settings. - Workspaces can load slowly when a project has a large number of metrics, runs, or panels. Here are common causes and fix ... + Workspaces can load slowly when a project has a large number of metrics, runs, or panels. diff --git a/support/models/tags/wysiwyg.mdx b/support/models/tags/wysiwyg.mdx index c5e956dc1d..ad80f6dc93 100644 --- a/support/models/tags/wysiwyg.mdx +++ b/support/models/tags/wysiwyg.mdx @@ -6,17 +6,17 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Select the panel grid and press delete or backspace. Click the drag handle in the top-right corner to select the panel g ... + Learn how to delete a panel grid in W&B: Select the panel grid and press delete or backspace. - Tables remain the only feature from Markdown without a direct WYSIWYG equivalent. To add a table, insert a Markdown bloc ... + Learn how to insert a table in W&B: Tables remain the only feature from Markdown without a direct WYSIWYG equivalent. - If the report conversion occurred through the message at the top, click the red "Revert" button to restore the prior sta ... + If the report conversion occurred through the message at the top, click the red "Revert" button to restore the prior state. - Performance issues may arise on older hardware or with very large reports. To mitigate this, collapse sections of the re ... + Performance issues may arise on older hardware or with very large reports. - The goal is to maintain the original appearance after transitioning to WYSIWYG, but the conversion process is not flawle ... + The goal is to maintain the original appearance after transitioning to WYSIWYG, but the conversion process is not flawless. diff --git a/support/weave/tags/client-info.mdx b/support/weave/tags/client-info.mdx index 7921099df0..e107f1d0e2 100644 --- a/support/weave/tags/client-info.mdx +++ b/support/weave/tags/client-info.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - You can disable client information capture during Weave client initialization: weave.init("entity/project", settings= ). + Disable client information capture in W&B Weave by setting `capture_client_info=False` on `weave.init()`. - A function can be designated as a Weave Op either manually through a decorator or automatically as part of an enabled in ... + What W&B Weave captures for tracked Ops, including inputs, outputs, code, system info, and call metadata. diff --git a/support/weave/tags/code-capture.mdx b/support/weave/tags/code-capture.mdx index 08a2a74a87..e900500c1e 100644 --- a/support/weave/tags/code-capture.mdx +++ b/support/weave/tags/code-capture.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - You can disable code capture during Weave client initialization: weave.init("entity/project", settings= ). You can also ... + Disable code capture in W&B Weave with the `capture_code=False` setting on `weave.init()` or the matching environment variable. - A function can be designated as a Weave Op either manually through a decorator or automatically as part of an enabled in ... + What W&B Weave captures for tracked Ops, including inputs, outputs, code, system info, and call metadata. diff --git a/support/weave/tags/data-capture.mdx b/support/weave/tags/data-capture.mdx index bc1884eeb9..6a53b6659f 100644 --- a/support/weave/tags/data-capture.mdx +++ b/support/weave/tags/data-capture.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - We define ingested bytes as bytes that we receive, process, and store on your behalf. This includes trace metadata, LLM ... + How W&B Weave data ingestion is calculated, including which trace metadata, inputs, outputs, and logged data count toward usage. - A function can be designated as a Weave Op either manually through a decorator or automatically as part of an enabled in ... + What W&B Weave captures for tracked Ops, including inputs, outputs, code, system info, and call metadata. diff --git a/support/weave/tags/evaluation.mdx b/support/weave/tags/evaluation.mdx index 01304bcfcb..985d506529 100644 --- a/support/weave/tags/evaluation.mdx +++ b/support/weave/tags/evaluation.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - The following two methods should be used together in order to improve performance when running evaluations with large da ... + Reduce long W&B Weave evaluation cleanup times when running evaluations on large datasets by combining recommended methods. - When scoring models in a Weave evaluation, absolute value metrics (e.g. 9/10 for Model A and 8/10 for Model B) are typic ... + How to set up pairwise evaluation in W&B Weave to compare models head-to-head instead of using absolute scoring. diff --git a/support/weave/tags/performance.mdx b/support/weave/tags/performance.mdx index 3e36d75590..153058295f 100644 --- a/support/weave/tags/performance.mdx +++ b/support/weave/tags/performance.mdx @@ -6,17 +6,17 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - The following two methods should be used together in order to improve performance when running evaluations with large da ... + Reduce long W&B Weave evaluation cleanup times when running evaluations on large datasets by combining recommended methods. - Errno 24 : Too many open files This error occurs when the number of open files exceeds the limit set by your operating s ... + Fix the "Too many open files" OS error when running W&B Weave with large image datasets and PIL image processing. - Weave provides server response caching to improve performance when making repeated queries or working with limited netwo ... + Enable W&B Weave server response caching to improve performance for repeated queries and limited network bandwidth. - Weave uploads trace data in background threads to minimize impact on your application's performance. However, when using ... + Prevent W&B Weave trace data loss when using multiprocessing, task queues, or worker processes such as Celery. - The overhead of Weave logging is typically negligible compared to making a call to an LLM. To minimize Weave's impact on ... + How W&B Weave minimizes overhead on your function execution speed by uploading trace data on a background thread. diff --git a/support/weave/tags/system-info.mdx b/support/weave/tags/system-info.mdx index dd32847ba2..c61eed9871 100644 --- a/support/weave/tags/system-info.mdx +++ b/support/weave/tags/system-info.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - You can disable system information capture during Weave client initialization: weave.init("entity/project", settings= ). + Disable system information capture in W&B Weave by setting `capture_system_info=False` on `weave.init()`. - A function can be designated as a Weave Op either manually through a decorator or automatically as part of an enabled in ... + What W&B Weave captures for tracked Ops, including inputs, outputs, code, system info, and call metadata. diff --git a/support/weave/tags/trace-data.mdx b/support/weave/tags/trace-data.mdx index 18ceaf4df2..d3dab97c56 100644 --- a/support/weave/tags/trace-data.mdx +++ b/support/weave/tags/trace-data.mdx @@ -6,14 +6,14 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Sometimes, large trace data is partially cut off in the Weave UI. This problem occurs because default trace output is a ... + Fix truncated trace data in the W&B Weave UI by serializing custom Python objects into a Weave-compatible format. - Weave uploads trace data in background threads to minimize impact on your application's performance. However, when using ... + Prevent W&B Weave trace data loss when using multiprocessing, task queues, or worker processes such as Celery. - If trace pages are loading slowly, reduce the number of rows displayed to improve load time. The default value is 50. Yo ... + Speed up W&B Weave trace pages that load slowly by reducing the number of rows displayed via the UI or query parameters. - By default, Weave's .call() method captures exceptions and stores them in call.exception instead of raising them. This i ... + Why W&B Weave's `.call()` method captures exceptions on `call.exception` instead of raising them, and how to opt in to raising. diff --git a/support/weave/tags/ui-rendering.mdx b/support/weave/tags/ui-rendering.mdx index a31149294a..7e7041d8b2 100644 --- a/support/weave/tags/ui-rendering.mdx +++ b/support/weave/tags/ui-rendering.mdx @@ -6,8 +6,8 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2" --- - Wrap your string with weave.Markdown(...) before saving, and use weave.publish(...) to store it. Weave uses the object's ... + Render Markdown content in the W&B Weave UI by wrapping strings with `weave.Markdown(...)` before publishing them. - Use Python's datetime.datetime (with timezone info), and publish the object using weave.publish(...). Weave recognizes t ... + Render Python datetime values as timestamps in the W&B Weave UI by publishing timezone-aware `datetime.datetime` objects.