Skip to content

style: apply /style-guide pass to support/models/articles#2672

Open
johndmulhausen wants to merge 6 commits into
mainfrom
style-guide/support-models-articles-20260527-004241
Open

style: apply /style-guide pass to support/models/articles#2672
johndmulhausen wants to merge 6 commits into
mainfrom
style-guide/support-models-articles-20260527-004241

Conversation

@johndmulhausen
Copy link
Copy Markdown
Contributor

Summary

This PR applies the /style-guide skill (Google Developer Style Guide + CoreWeave conventions) to 182 support articles under support/models/articles/. The run was fully automated; edits are style-only and preserve technical meaning and code samples.

Files edited

  • support/models/articles/adding-multiple-authors-to-a-report.mdx
  • support/models/articles/anaconda-400-error-during-a-sweep.mdx
  • support/models/articles/best-practices-to-organize-hyperparamete.mdx
  • support/models/articles/can-i-get-an-academic-plan-as-a-student.mdx
  • support/models/articles/can-i-group-runs-without-using-the-group.mdx
  • support/models/articles/can-i-just-log-metrics-no-code-or-datase.mdx
  • support/models/articles/can-i-log-metrics-on-two-different-time-.mdx
  • support/models/articles/can-i-rerun-a-grid-search.mdx
  • support/models/articles/can-i-run-wandb-offline.mdx
  • support/models/articles/can-i-turn-off-wandb-when-testing-my-cod.mdx
  • support/models/articles/can-i-use-markdown-in-my-reports.mdx
  • support/models/articles/can-i-use-sweeps-and-sagemaker.mdx
  • support/models/articles/can-wb-team-members-see-my-data.mdx
  • support/models/articles/can-we-flag-boolean-variables-as-hyperpa.mdx
  • support/models/articles/can-you-group-runs-by-tags.mdx
  • support/models/articles/can-you-use-wb-sweeps-with-cloud-infrast.mdx
  • support/models/articles/cannot-link-artifact-to-registry-from-p.mdx
  • support/models/articles/commerror-run-does-not-exist-during-swee.mdx
  • support/models/articles/cuda-out-of-memory-during-a-sweep.mdx
  • support/models/articles/do-environment-variables-overwrite-the-p.mdx
  • support/models/articles/do-i-need-to-provide-values-for-all-hype.mdx
  • support/models/articles/do-run-finished-alerts-work-in-notebooks.mdx
  • support/models/articles/do-you-have-a-bug-bounty-program.mdx
  • support/models/articles/does-logging-block-my-training.mdx
  • support/models/articles/does-the-wb-client-support-python-2.mdx
  • support/models/articles/does-the-wb-client-support-python-35.mdx
  • support/models/articles/does-this-only-work-for-python.mdx
  • support/models/articles/does-wb-support-sso-for-multi-tenant.mdx
  • support/models/articles/does-wb-use-the-multiprocessing-library.mdx
  • support/models/articles/does-your-tool-track-or-store-training-d.mdx
  • support/models/articles/embedding-reports.mdx
  • support/models/articles/enterprise-license-not-recognized.mdx
  • support/models/articles/filter-and-delete-unwanted-reports.mdx
  • support/models/articles/how-can-i-access-the-data-logged-to-my-r.mdx
  • support/models/articles/how-can-i-be-removed-from-a-team.mdx
  • support/models/articles/how-can-i-change-my-account-from-corpora.mdx
  • support/models/articles/how-can-i-change-the-colors-of-each-run-.mdx
  • support/models/articles/how-can-i-change-the-directory-my-sweep-.mdx
  • support/models/articles/how-can-i-change-the-privacy-of-my-proje.mdx
  • support/models/articles/how-can-i-compare-images-or-media-across.mdx
  • support/models/articles/how-can-i-configure-the-name-of-the-run-.mdx
  • support/models/articles/how-can-i-define-the-local-location-for-.mdx
  • support/models/articles/how-can-i-delete-multiple-runs-in-bulk-i.mdx
  • support/models/articles/how-can-i-delete-my-user-account.mdx
  • support/models/articles/how-can-i-fetch-these-version-ids-and-et.mdx
  • support/models/articles/how-can-i-find-the-artifacts-logged-or-c.mdx
  • support/models/articles/how-can-i-fix-an-error-like-attributeerr.mdx
  • support/models/articles/how-can-i-log-a-metric-that-doesnt-chang.mdx
  • support/models/articles/how-can-i-log-additional-metrics-after-a.mdx
  • support/models/articles/how-can-i-log-in-to-wb-server.mdx
  • support/models/articles/how-can-i-organize-my-logged-charts-and-.mdx
  • support/models/articles/how-can-i-recover-deleted-runs.mdx
  • support/models/articles/how-can-i-regain-access-to-my-account-if.mdx
  • support/models/articles/how-can-i-remove-projects-from-a-team-sp.mdx
  • support/models/articles/how-can-i-resolve-login-issues-with-my-a.mdx
  • support/models/articles/how-can-i-resolve-the-filestream-rate-li.mdx
  • support/models/articles/how-can-i-resume-a-sweep-using-python-co.mdx
  • support/models/articles/how-can-i-rotate-or-revoke-access.mdx
  • support/models/articles/how-can-i-save-the-git-commit-associated.mdx
  • support/models/articles/how-can-i-see-files-that-do-not-appear-i.mdx
  • support/models/articles/how-can-i-see-the-bytes-stored-bytes-tra.mdx
  • support/models/articles/how-can-i-send-run-alerts-to-microsoft-t.mdx
  • support/models/articles/how-can-i-use-wandb-with-multiprocessing.mdx
  • support/models/articles/how-do-i-add-plotly-or-bokeh-charts-into.mdx
  • support/models/articles/how-do-i-best-log-models-from-runs-in-a-.mdx
  • support/models/articles/how-do-i-cancel-my-subscription.mdx
  • support/models/articles/how-do-i-change-my-billing-address.mdx
  • support/models/articles/how-do-i-deal-with-network-issues.mdx
  • support/models/articles/how-do-i-delete-a-panel-grid.mdx
  • support/models/articles/how-do-i-delete-a-team-from-my-account.mdx
  • support/models/articles/how-do-i-delete-my-organization-account.mdx
  • support/models/articles/how-do-i-downgrade-my-subscription-plan.mdx
  • support/models/articles/how-do-i-enable-code-logging-with-sweeps.mdx
  • support/models/articles/how-do-i-export-a-list-of-users-from-my-.mdx
  • support/models/articles/how-do-i-find-an-artifact-from-the-best-.mdx
  • support/models/articles/how-do-i-fix-invalid-authentication-401-.mdx
  • support/models/articles/how-do-i-fix-server-errors-500-503-with-.mdx
  • support/models/articles/how-do-i-fix-the-error-resumemust-but-ru.mdx
  • support/models/articles/how-do-i-fix-the-overflows-maximum-value.mdx
  • support/models/articles/how-do-i-get-added-to-a-team-on-wb.mdx
  • support/models/articles/how-do-i-handle-the-failed-to-query-for-.mdx
  • support/models/articles/how-do-i-insert-a-table.mdx
  • support/models/articles/how-do-i-install-the-wandb-python-librar.mdx
  • support/models/articles/how-do-i-kill-a-job-with-wandb.mdx
  • support/models/articles/how-do-i-launch-multiple-runs-from-one-s.mdx
  • support/models/articles/how-do-i-log-a-list-of-values.mdx
  • support/models/articles/how-do-i-log-an-artifact-to-an-existing-.mdx
  • support/models/articles/how-do-i-log-runs-launched-by-continuous.mdx
  • support/models/articles/how-do-i-log-to-the-right-wandb-user-on-.mdx
  • support/models/articles/how-do-i-plot-multiple-lines-on-a-plot-w.mdx
  • support/models/articles/how-do-i-programmatically-access-the-hum.mdx
  • support/models/articles/how-do-i-rename-a-project.mdx
  • support/models/articles/how-do-i-renew-my-expired-license.mdx
  • support/models/articles/how-do-i-request-the-complete-deletion-o.mdx
  • support/models/articles/how-do-i-resolve-a-run-initialization-ti.mdx
  • support/models/articles/how-do-i-resolve-permission-errors-when-.mdx
  • support/models/articles/how-do-i-save-code.mdx
  • support/models/articles/how-do-i-set-a-retention-or-expiration-p.mdx
  • support/models/articles/how-do-i-silence-wb-info-messages.mdx
  • support/models/articles/how-do-i-stop-wandb-from-writing-to-my-t.mdx
  • support/models/articles/how-do-i-switch-between-accounts-on-the-.mdx
  • support/models/articles/how-do-i-turn-off-logging.mdx
  • support/models/articles/how-do-i-use-custom-cli-commands-with-sw.mdx
  • support/models/articles/how-do-i-use-the-resume-parameter-when-r.mdx
  • support/models/articles/how-do-we-update-our-payment-method.mdx
  • support/models/articles/how-do-you-delete-a-custom-chart-preset.mdx
  • support/models/articles/how-do-you-show-a-step-slider-in-a-custo.mdx
  • support/models/articles/how-does-someone-without-an-account-see-.mdx
  • support/models/articles/how-does-wandb-stream-logs-and-writes-to.mdx
  • support/models/articles/how-is-wb-different-from-tensorboard.mdx
  • support/models/articles/how-many-runs-can-i-create-per-project.mdx
  • support/models/articles/how-much-storage-does-each-artifact-vers.mdx
  • support/models/articles/how-often-are-system-metrics-collected.mdx
  • support/models/articles/how-should-i-run-sweeps-on-slurm.mdx
  • support/models/articles/how-to-get-multiple-charts-with-differen.mdx
  • support/models/articles/i-converted-my-report-to-wysiwyg-but-wan.mdx
  • support/models/articles/i-didnt-name-my-run-where-is-the-run-nam.mdx
  • support/models/articles/if-i-am-the-admin-of-my-local-instance-h.mdx
  • support/models/articles/if-wandb-crashes-will-it-possibly-crash-.mdx
  • support/models/articles/incorporating-latex.mdx
  • support/models/articles/initstarterror-error-communicating-with-.mdx
  • support/models/articles/is-it-possible-to-add-the-same-service-a.mdx
  • support/models/articles/is-it-possible-to-change-the-group-assig.mdx
  • support/models/articles/is-it-possible-to-change-the-username.mdx
  • support/models/articles/is-it-possible-to-create-a-new-account-w.mdx
  • support/models/articles/is-it-possible-to-move-a-run-from-one-pr.mdx
  • support/models/articles/is-it-possible-to-plot-the-max-of-a-metr.mdx
  • support/models/articles/is-it-possible-to-recover-an-artifact-af.mdx
  • support/models/articles/is-it-possible-to-save-metrics-offline-a.mdx
  • support/models/articles/is-there-a-dark-mode.mdx
  • support/models/articles/is-there-a-monthly-subscription-option-f.mdx
  • support/models/articles/is-there-a-way-to-add-extra-values-to-a-.mdx
  • support/models/articles/is-there-a-way-to-add-more-seats.mdx
  • support/models/articles/is-there-a-wb-outage.mdx
  • support/models/articles/is-there-an-anaconda-package-for-weights.mdx
  • support/models/articles/my-report-is-running-slowly-after-the-ch.mdx
  • support/models/articles/my-report-looks-different-after-converti.mdx
  • support/models/articles/my-runs-state-is-crashed-on-the-ui-but-i.mdx
  • support/models/articles/on-a-local-instance-which-files-should-i.mdx
  • support/models/articles/optimizing-multiple-metrics.mdx
  • support/models/articles/process-hangs-when-using-hydra-with-wan.mdx
  • support/models/articles/rate-limit-exceeded-on-metric-logging.mdx
  • support/models/articles/refreshing-data.mdx
  • support/models/articles/service-account-unauthorized-or-runs-no.mdx
  • support/models/articles/training-hangs-with-distributed-trainin.mdx
  • support/models/articles/upload-a-csv-to-a-report.mdx
  • support/models/articles/upload-an-image-to-a-report.mdx
  • support/models/articles/using-artifacts-with-multiple-architectu.mdx
  • support/models/articles/what-are-features-that-are-not-available.mdx
  • support/models/articles/what-are-the-best-practices-for-handling.mdx
  • support/models/articles/what-does-wandbinit-do-to-my-training-pr.mdx
  • support/models/articles/what-formula-do-you-use-for-your-smoothi.mdx
  • support/models/articles/what-happens-if-i-edit-my-python-files-w.mdx
  • support/models/articles/what-happens-if-i-pass-a-class-attribute.mdx
  • support/models/articles/what-happens-when-i-log-millions-of-step.mdx
  • support/models/articles/what-if-i-want-to-integrate-wb-into-my-p.mdx
  • support/models/articles/what-if-i-want-to-log-some-metrics-on-ba.mdx
  • support/models/articles/what-is-a-service-account-and-why-is-it-.mdx
  • support/models/articles/what-is-a-team-and-where-can-i-find-more.mdx
  • support/models/articles/what-is-the-difference-between-log-and-s.mdx
  • support/models/articles/what-is-the-difference-between-team-and-.mdx
  • support/models/articles/what-is-the-difference-between-team-and-_2.mdx
  • support/models/articles/what-is-the-difference-between-wandbinit.mdx
  • support/models/articles/what-is-the-est-runs-column.mdx
  • support/models/articles/what-really-good-functionalities-are-hid.mdx
  • support/models/articles/when-should-i-log-to-my-personal-entity-.mdx
  • support/models/articles/where-are-artifacts-downloaded-and-how-c.mdx
  • support/models/articles/which-files-should-i-check-when-my-code-.mdx
  • support/models/articles/who-can-create-a-team-who-can-add-or-del.mdx
  • support/models/articles/who-can-edit-and-share-reports.mdx
  • support/models/articles/who-has-access-to-my-artifacts.mdx
  • support/models/articles/why-am-i-getting-insufficient-quota-erro.mdx
  • support/models/articles/why-am-i-getting-rate-limit-errors-429-w.mdx
  • support/models/articles/why-am-i-seeing-fewer-data-points-than-i.mdx
  • support/models/articles/why-are-steps-missing-from-a-csv-metric-.mdx
  • support/models/articles/why-cant-i-sort-or-filter-metrics-with-c.mdx
  • support/models/articles/why-does-the-storage-meter-not-update-af.mdx
  • support/models/articles/why-is-a-run-marked-crashed-in-wb-when-i.mdx
  • support/models/articles/why-is-nothing-showing-up-in-my-graphs.mdx
  • support/models/articles/why-is-the-same-metric-appearing-more-th.mdx
  • support/models/articles/will-wandb-slow-down-my-training.mdx
  • support/models/articles/workspace-loads-slowly-with-many-metric.mdx

Recommendations for technical review

API / SDK accuracy

  • Verify SDK signatures and idioms across multiple articles, including:
    • wandb.init(tags='your_tag') (best-practices-to-organize-hyperparamete.mdx)
    • wandb.Run.log()(...) vs. run.log({...}) (can-i-log-metrics-on-two-different-time-.mdx)
    • run.config() / wandb.Run.config() / rwandb.Run.config.setdefaults() typos and attribute-vs-call (do-i-need-to-provide-values-for-all-hype.mdx)
    • run.settings['final_accuracy'] vs. run.summary[...] (how-can-i-log-a-metric-that-doesnt-chang.mdx)
    • run.summary() vs. run.summary attribute (how-can-i-log-additional-metrics-after-a.mdx)
    • _stats_sampling_interval vs. x_stats_sampling_interval (how-often-are-system-metrics-collected.mdx)
    • _disable_stats vs. x_disable_stats prose/code mismatch (do-you-have-a-bug-bounty-program.mdx — re-check does-your-tool-track-or-store-training-d.mdx)
    • wandb.Run.config.update(...) / wandb.Run.save() vs. run.config.update(...) / run.save() (how-can-i-save-the-git-commit-associated.mdx)
    • wandb.Artifact(name="…", type="model") log-flow completeness (how-do-i-best-log-models-from-runs-in-a-.mdx)
    • wandb.agent --count 1 SWEEP_ID and function= requirement (how-can-i-resume-a-sweep-using-python-co.mdx, how-should-i-run-sweeps-on-slurm.mdx)
    • logged_by(), used_by(), logged_artifacts(), used_artifacts() return types and pagination (how-can-i-find-the-artifacts-logged-or-c.mdx, how-do-i-find-an-artifact-from-the-best-.mdx)
    • SCIM user['emails']['Value'] indexing and pagination handling (how-do-i-export-a-list-of-users-from-my-.mdx)
    • os.path.exists("~/keys.json") and json.loads(...) correctness; missing os/json imports (how-do-i-switch-between-accounts-on-the-.mdx)
    • wandb.plot.line_series(xs, ys, keys=...) legend argument (how-do-i-plot-multiple-lines-on-a-plot-w.mdx)
    • wandb.Histogram(losses) and duplicate run.log({"losses": losses}) (how-do-i-log-a-list-of-values.mdx)

Environment variables & precedence

  • Confirm canonical names/values and precedence rules:
    • WANDB_DISABLE_CODE=true, WANDB_IGNORE_GLOBS, WANDB_DIR/dir= precedence (can-i-just-log-metrics-no-code-or-datase.mdx, do-environment-variables-overwrite-the-p.mdx, how-can-i-define-the-local-location-for-.mdx)
    • WANDB_MODE=offline vs. disabled/dryrun; behavior of wandb.init(mode="disabled") with WANDB_CACHE_DIR (can-i-run-wandb-offline.mdx, can-i-turn-off-wandb-when-testing-my-cod.mdx, is-it-possible-to-save-metrics-offline-a.mdx, what-is-the-difference-between-wandbinit.mdx)
    • WANDB_SILENT/WANDB_QUIET accepted value casing and timing relative to wandb.init/wandb.login (how-do-i-silence-wb-info-messages.mdx, how-do-i-turn-off-logging.mdx)
    • WANDB_BASE_URL vs. wandb login --host precedence (how-can-i-log-in-to-wb-server.mdx)
    • WANDB_INIT_TIMEOUT, WANDB_DEBUG, WANDB_CORE_DEBUG flags and log file names (how-do-i-resolve-a-run-initialization-ti.mdx)
    • WANDB_NOTEBOOK_NAME setting timing and Jupyter %env syntax (how-do-i-log-to-the-right-wandb-user-on-.mdx)
    • WANDB_USERNAME/WANDB_USER_EMAIL service-account attribution scope (what-is-a-service-account-and-why-is-it-.mdx, is-it-possible-to-add-the-same-service-a.mdx)

UI labels and click paths

  • Verify exact UI labels and navigation against current product across reports, settings, sweeps, artifacts, custom charts, billing, team/org settings, dark mode, and run/report deletion flows. Common items include + icon (adding-multiple-authors-to-a-report.mdx), Delete Reports/Delete Account/Delete (filter-and-delete-unwanted-reports.mdx, how-can-i-delete-my-user-account.mdx, how-do-i-request-the-complete-deletion-o.mdx), Resume (can-i-rerun-a-grid-search.mdx), Edit Project (how-do-i-rename-a-project.mdx), Image panel/step slider (how-can-i-compare-images-or-media-across.mdx, how-do-you-show-a-step-slider-in-a-custo.mdx), Beta Features (what-really-good-functionalities-are-hid.mdx), and the trash/delete icon in the custom chart editor (how-do-you-delete-a-custom-chart-preset.mdx).
  • Confirm /system-admin path and Debug Bundle flow are current (how-do-i-handle-the-failed-to-query-for-.mdx).
  • Confirm User Settings / Account Settings click paths and exact labels (do-run-finished-alerts-work-in-notebooks.mdx, how-can-i-change-my-account-from-corpora.mdx).

Limits, thresholds, and retention windows

  • Validate documented numbers against current limits:
    • 10,000 runs/project recommendation (how-many-runs-can-i-create-per-project.mdx)
    • 7-day anonymous run / deleted run retention (how-does-someone-without-an-account-see-.mdx, how-can-i-recover-deleted-runs.mdx, what-are-features-that-are-not-available.mdx)
    • System metrics 10-second default sampling interval (how-often-are-system-metrics-collected.mdx)
    • 100k / 10k metric and run thresholds in /models/track/limits/ (workspace-loads-slowly-with-many-metric.mdx)
    • SDK version cutoffs for wandb.require("service"), Python 3.5/3.6/3.7+ (training-hangs-with-distributed-trainin.mdx, does-the-wb-client-support-python-35.mdx, does-the-wb-client-support-python-2.mdx, does-this-only-work-for-python.mdx)

Product naming and terminology

  • Standardize "W&B" vs. "wandb", "Multi-tenant Cloud", "Dedicated Cloud", "Self-Managed"/"W&B Server", "Azure AD" vs. "Microsoft Entra ID", "scatter plot" vs. "scatterplot", "data store" vs. "datastore", "sign in" vs. "log in", "Service Account" vs. "Service accounts", "Teams plan" capitalization, and Sweeps capitalization across affected articles.
  • Confirm whether support@wandb.com is still the correct contact across billing, license renewal, plan changes, account deletion, seat requests, organization deletion, and bug bounty (multiple articles).

Placeholder convention

  • Several articles still use inconsistent placeholders (<entity>, username/project/run_id, "your_api_key", SWEEP_ID, architecture-name:latest). Decide whether to standardize on CoreWeave bracket-uppercase placeholders ([ENTITY], [PROJECT], [RUN-ID], [SWEEP-ID]) with an explanatory sentence preceding code blocks, especially where bracket placeholders may break Python syntax inside language-tagged blocks.

Missing context, prerequisites, and verification

  • Many FAQs lack explicit prerequisites (required roles, plan tiers, authentication, prior wandb.init setup), verification steps ("what success looks like" after the procedure), and cross-links to canonical references (Sweeps, Artifacts, Reports, Inference, Public API, environment-variable list, run-naming, retention, IAM/service accounts). Consider a consistent pattern for these per CoreWeave's self-contained-pages convention.
  • Specific gaps worth adding:
    • Co-author removal, ordering, and limits (adding-multiple-authors-to-a-report.mdx)
    • Eligibility for academic plans (can-i-get-an-academic-plan-as-a-student.mdx)
    • Non-Group categorization workflow (can-i-group-runs-without-using-the-group.mdx)
    • SLURM script example and --count rationale (how-should-i-run-sweeps-on-slurm.mdx)
    • wandb.Table upload example for CSV-in-report (upload-a-csv-to-a-report.mdx)
    • Markdown table syntax / Markdown block UI in Reports (how-do-i-insert-a-table.mdx)
    • Auth0 implicit-flow currency, callback URI, and provider docs (does-wb-support-sso-for-multi-tenant.mdx)
    • Retry/backoff code consistency with prose guidance (how-do-i-fix-server-errors-500-503-with-.mdx, why-am-i-getting-rate-limit-errors-429-w.mdx)
    • SSL certificate workaround platform scope (how-do-i-deal-with-network-issues.mdx)
    • Kill-job keystroke (Ctrl+C vs. Ctrl+D) (how-do-i-kill-a-job-with-wandb.mdx)
    • Workspace ?workspace=clear behavior and overflow root cause (how-do-i-fix-the-overflows-maximum-value.mdx)
    • Self-serve vs. support-managed paths for cancellation, downgrade, billing-address changes, and seat additions (multiple billing articles)

Technical contradictions and ambiguities to resolve

  • "Can I group runs without using the Group feature" — title contradicts body that directs reader to the Group button.
  • Case-insensitive metric names paired with case-collision warning (why-is-the-same-metric-appearing-more-th.mdx).
  • "Best practices" title vs. single-tip body (best-practices-to-organize-hyperparamete.mdx).
  • "Most likely cause" framing without alternative causes for CommError, run-init timeout, and resume='must' errors.
  • "Self-Managed" admin link pointing to a multi-tenant admin doc (if-i-am-the-admin-of-my-local-instance-h.mdx).
  • Stub/redirect articles that may warrant inlining brief answers or consolidating with their link targets (how-can-i-be-removed-from-a-team.mdx, what-is-a-team-and-where-can-i-find-more.mdx, who-can-create-a-team-who-can-add-or-del.mdx).

Link target verification

  • Validate that the following anchors/paths still resolve and describe the linked behavior: /models/track/config#set-the-configuration-after-your-run-has-finished, /models/sweeps/visualize-sweep-results, /models/integrations/sagemaker, /models/track/log/distributed-training, /models/ref/python/public-api/api, /models/ref/cli/wandb-sync, /models/track/limits/, /platform/app/settings-page/teams#team-roles-and-permissions, /platform/hosting/iam/service-accounts, /platform/hosting/iam/identity_federation#external-service-accounts, wandb.me/pytorch-colab, and the TensorBoard smoothing-source permalink.

Asset issues

  • Image filename typos worth fixing: emgedding_reports.gif (embedding_reports.gif), delete_runs.gif used for "delete reports", and delete_custome_chart_preset.gif ("custome").

How to review

  • Each file's changes are style edits only. Compare side-by-side and flag any that change technical meaning.
  • Approve and merge to accept the edits, or close to reject them.

@johndmulhausen johndmulhausen requested a review from a team as a code owner May 27, 2026 04:44
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 27, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview May 27, 2026, 4:48 AM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

Knowledgebase navigation update

  • Keywords not on the allowed list: 1 distinct keyword.

Generator warnings

  • Unknown keyword TensorBoard used in support/models/articles/what-formula-do-you-use-for-your-smoothi.mdx. Add it to scripts/knowledgebase-nav/config.yaml to suppress this warning.

From workflow run 26652646414

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (216 total)

📄 Pages (215)

File Preview
models/integrations/pytorch.mdx Pytorch
snippets/kb_article_map.mdx Kb Article Map
support.mdx Support
support/models.mdx Models
support/models/articles/adding-multiple-authors-to-a-report.mdx Adding Multiple Authors To A Report
support/models/articles/anaconda-400-error-during-a-sweep.mdx Anaconda 400 Error During A Sweep
support/models/articles/best-practices-to-organize-hyperparamete.mdx Best Practices To Organize Hyperparamete
support/models/articles/can-i-get-an-academic-plan-as-a-student.mdx Can I Get An Academic Plan As A Student
support/models/articles/can-i-just-log-metrics-no-code-or-datase.mdx Can I Just Log Metrics No Code Or Datase
support/models/articles/can-i-turn-off-wandb-when-testing-my-cod.mdx Can I Turn Off Wandb When Testing My Cod
... and 205 more files
⚙️ Other (1)
File
docs.json

🗑️ Deleted (4 total)

View deleted files

📄 Pages (4)

File
support/models/articles/can-i-group-runs-without-using-the-group.mdx
support/models/articles/can-i-log-metrics-on-two-different-time-.mdx
support/models/articles/can-i-rerun-a-grid-search.mdx
support/models/articles/can-i-run-wandb-offline.mdx

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: e4912c1 at 2026-05-29 17:44:18 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-style-guide-support-models-articles-20260527-00.mintlify.app

Copy link
Copy Markdown
Contributor

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partial review because I'm seeing a pattern where Yes/No FAQs would be better rewritten as "How can I" sorts of FAQs. This would create the need for some specific redirects, of course.

---

Accurately credit all contributors in your report by adding multiple authors.
Credit all contributors in your report by adding multiple authors. This approach is useful when a report represents the work of a team rather than one person.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is artificially too imperative. Adding authors is a feature that lets you credit contributors, but we shouldn't be demanding that the report creator does it. I think we intended to have a CTA but also to use active voice and it went a bit too far here.

This article explains how to resolve an `anaconda 400 error` that occurs during a W&B sweep, so your sweep can continue optimizing as expected.

```
The following error usually occurs when you don't log the metric you're optimizing:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence pretends that the whole previous paragraph doesn't exist. Join up these two ideas. A 400 error often means <line 8>. <line 6, with 'so your....expected' removed>. Make sense?

```

Then your training code must call:
Your training code must then call:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the wandb.log call can be added into the code block in 17-21 but commented out to show what to add to fix it?

---

Set unique tags with `wandb.init(tags='your_tag')`. This allows efficient filtering of project runs by selecting the corresponding tag in a Project Page's Runs Table.
When you run many hyperparameter searches, tagging your runs makes it easier to group and find related experiments later.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When you run many hyperparameter searches, tagging your runs makes it easier to group and find related experiments later.
When you run many hyperparameter searches, tag your runs so you can group and find related experiments later.

When you run many hyperparameter searches, tagging your runs makes it easier to group and find related experiments later.

For more information on `wandb.init()`, see the [`wandb.init()` reference](/models/ref/python/functions/init).
Set unique tags with `wandb.init(tags='your_tag')`. You can then filter project runs efficiently by selecting the corresponding tag in a project page's **Runs** table.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Separate out how to set tags in your code (the point of the article) from what it lets you do in the UI later. Maybe link to the relevant UI docs.

---

Students can apply for an academic plan by following these steps:
As a student, you can apply for an academic plan in one of two ways:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this sentence was better before, even though lines 8-9 are better now.

---

Yes, you can also use tags or custom metadata to categorize runs. That can be done using the `Group` button which is available in the Workspace and Runs views of the project.
Yes, you can use tags or custom metadata to categorize runs. Use the **Group** button, available in the project's Workspace and Runs views.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider rewriting this as a stepped "How can I" procedure instead of a Yes/No answer.

---

For example, I want to log training accuracy per batch and validation accuracy per epoch.
For example, you might want to log training accuracy per batch and validation accuracy per epoch.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider rewriting this article as a How instead of a Yes/No answer.

---

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. Then, select the **Resume** button on the [Sweep list in the W&B App](/models/sweeps/visualize-sweep-results). Start new W&B Sweep agents using the new Sweep ID.
If a grid search completes but some W&B Runs crashed, delete those runs to rerun them. Then select the **Resume** button on the [Sweep list in the W&B App](/models/sweeps/visualize-sweep-results). Start new W&B Sweep agents using the new sweep ID.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider rewriting as a how-to instead of a yes/no answer.

---

If training occurs on an offline machine, use the following steps to upload results to the servers:
Yes. If you train on an offline machine, follow these steps to upload your results to W&B:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants