diff --git a/docs.json b/docs.json index 2c44e00781..e3db1b247e 100644 --- a/docs.json +++ b/docs.json @@ -671,8 +671,7 @@ ] } ] - }, - "models/support" + } ] }, { @@ -1145,6 +1144,76 @@ ] } ] + }, + { + "tab": "Support", + "icon": "/icons/cropped-reports.svg", + "pages": [ + "support/index", + "support/models_redirector", + "support/weave_redirector", + "support/inference_redirector" + ] + }, + { + "tab": "Support: W&B Models", + "hidden": true, + "pages": [ + "support/models/index", + "support/models/tags/academic", + "support/models/tags/administrator", + "support/models/tags/alerts", + "support/models/tags/anonymous", + "support/models/tags/artifacts", + "support/models/tags/aws", + "support/models/tags/billing", + "support/models/tags/charts", + "support/models/tags/connectivity", + "support/models/tags/crashing-and-hanging-runs", + "support/models/tags/environment-variables", + "support/models/tags/experiments", + "support/models/tags/hyperparameter", + "support/models/tags/inference", + "support/models/tags/logs", + "support/models/tags/metrics", + "support/models/tags/notebooks", + "support/models/tags/outage", + "support/models/tags/privacy", + "support/models/tags/projects", + "support/models/tags/python", + "support/models/tags/reports", + "support/models/tags/resuming", + "support/models/tags/runs", + "support/models/tags/security", + "support/models/tags/storage", + "support/models/tags/sweeps", + "support/models/tags/tables", + "support/models/tags/team-management", + "support/models/tags/tensorboard", + "support/models/tags/user-management", + "support/models/tags/workspaces", + "support/models/tags/wysiwyg" + ] + }, + { + "tab": "Support: W&B Weave", + "hidden": true, + "pages": [ + "support/weave/index", + "support/weave/tags/faqs", + "support/weave/tags/troubleshooting" + ] + }, + { + "tab": "Support: W&B Inference", + "hidden": true, + "pages": [ + "support/inference/index", + "support/inference/tags/administrator", + "support/inference/tags/api-errors", + "support/inference/tags/billing", + "support/inference/tags/inference" + ] } ] }, @@ -1847,8 +1916,7 @@ ] } ] - }, - "ja/models/support" + } ] }, { @@ -3035,8 +3103,7 @@ ] } ] - }, - "ko/models/support" + } ] }, { @@ -3633,7 +3700,7 @@ }, { "source": "/guides/reports/reports-faq/", - "destination": "/models/support/" + "destination": "/support/index" }, { "source": "/guides/runs/:slug*", @@ -3653,7 +3720,7 @@ }, { "source": "/guides/sweeps/faq/", - "destination": "/models/support/" + "destination": "/support/" }, { "source": "/guides/tables/:slug*", @@ -3661,23 +3728,23 @@ }, { "source": "/guides/technical-faq/admin/", - "destination": "/models/support/" + "destination": "/support/" }, { "source": "/guides/technical-faq/general/", - "destination": "/models/support/" + "destination": "/support/" }, { "source": "/guides/technical-faq/metrics-and-performance/", - "destination": "/models/support/" + "destination": "/support/" }, { "source": "/guides/technical-faq/setup/", - "destination": "/models/support/" + "destination": "/support/" }, { "source": "/guides/technical-faq/troubleshooting/", - "destination": "/models/support/" + "destination": "/support/" }, { "source": "/guides/track/:slug*", @@ -3821,7 +3888,7 @@ }, { "source": "models/support/rotate_revoke_access", - "destination": "/models/support/find_api_key" + "destination": "/support/models/articles/how-do-i-find-my-api-key" }, { "source": "/models/evaluate-models", @@ -3923,13 +3990,9 @@ "source": "/self-hosted/*", "destination": "/platform/hosting/hosting-options/self-managed" }, - { - "source": "/support/*", - "destination": "/models/support" - }, { "source": "/sweeps/faq/", - "destination": "/models/support/" + "destination": "/support/" }, { "source": "/tutorials/:slug*", diff --git a/local-links-same-tab.js b/local-links-same-tab.js new file mode 100644 index 0000000000..c25a2ea4a4 --- /dev/null +++ b/local-links-same-tab.js @@ -0,0 +1,166 @@ +/** + * local-links-same-tab.js + * + * Ensures that in-doc navigation links (e.g. sidebar "group flex" links) open in + * the same tab when they point to local paths. Links that would otherwise have + * target="_blank" are updated by removing the target attribute so the browser + * uses the default same-tab behavior. + * + * Also swaps the external-link arrow icon (top-right) to a chevron (greater-than) + * on local nav links, so users see expansion/navigation vs. leaving to an external URL. + * + * Why this exists: + * - Some UI frameworks or themes add target="_blank" to all nav links. + * - For internal docs paths (e.g. /products/sunk/index), opening in a new tab + * is usually undesirable; users expect in-site navigation to stay in the same tab. + * - The theme may show an external-link arrow on all nav items; local links should + * show a chevron instead to signal in-site navigation. + * - This script only changes links that match the "group flex" nav pattern and + * have a local href; external (http/https) links are left unchanged. + * + * How it works: + * - Runs on DOMContentLoaded and at several delayed intervals (for slow-hydrating nav). + * - Uses a MutationObserver to run whenever the DOM gains new nodes or a link's + * target attribute changes, so links are fixed as soon as the framework + * renders or re-applies target="_blank". + * - Runs on pageshow so that when the user navigates back, links are fixed again. + * - Selects elements whose class list contains both "group" and "flex" + * (the Mintlify sidebar nav link pattern). + * - For each such link with a local href: removes the target attribute and + * replaces the arrow SVG with a chevron SVG. + * + * Environment: + * - Loaded globally by Mintlify for every docs page (any .js in the content dir). + * - Wrapped in an IIFE to avoid polluting the global scope. + */ + +(function () { + /** + * Determines whether an href should be treated as local (same-origin / in-doc). + * Local links should open in the same tab; external links may keep target="_blank". + * + * @param {string | null | undefined} href - The href value from the anchor (e.g. getAttribute('href')). + * @returns {boolean} - True if the link is local and safe to open in the same tab. + */ + function isLocalHref(href) { + // Missing or empty href: treat as local (e.g. placeholder or JS-handled link). + if (!href || typeof href !== 'string') return true; + + var trimmed = href.trim(); + // Fragment-only links (e.g. #section) are in-page and always local. + if (trimmed === '' || trimmed.startsWith('#')) return true; + + // Compare case-insensitively so HTTP: and https: are both treated as external. + var lower = trimmed.toLowerCase(); + // Local: relative paths (/foo), path-only, or protocol-relative that we treat as same-site. + // External: explicit http: or https: (and we do not change those). + return !lower.startsWith('http:') && !lower.startsWith('https:'); + } + + /** Chevron (greater-than) path and dimensions matching expandable section icons. */ + var CHEVRON_PATH = 'M0 0L3 3L0 6'; + + /** + * Replaces the arrow (external-link) icon with a chevron on a nav link. + * Matches the expandable section chevron: width="8" height="24" viewBox="0 -9 3 24". + * + * @param {HTMLAnchorElement} a - The nav link element. + */ + function swapArrowToChevron(a) { + var svg = a.querySelector('svg[viewBox="0 0 384 512"]'); + if (!svg) return; + + var path = svg.querySelector('path'); + if (!path) return; + + var d = path.getAttribute('d') || ''; + if (d.indexOf('M328 96') !== 0) return; + if (d === CHEVRON_PATH) return; + + svg.setAttribute('viewBox', '0 -9 3 24'); + svg.setAttribute('width', '8'); + svg.setAttribute('height', '24'); + svg.setAttribute('class', 'transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 w-2 h-5 -mr-0.5 flex-shrink-0'); + path.setAttribute('d', CHEVRON_PATH); + path.setAttribute('fill', 'none'); + path.setAttribute('stroke', 'currentColor'); + path.setAttribute('stroke-width', '1.5'); + path.setAttribute('stroke-linecap', 'round'); + } + + /** + * Finds all "group flex" nav links with a local href, removes target="_blank" + * so they open in the same tab, and swaps the arrow icon to a chevron. + * Marks all processed links so hidden arrows on external links can be revealed. + * + * Safe to call multiple times; idempotent for already-processed links. + */ + function stripTargetBlankFromLocalGroupFlexLinks() { + var links = document.querySelectorAll('a[href]'); + + for (var i = 0; i < links.length; i++) { + var a = links[i]; + var cls = a.className; + + if (typeof cls !== 'string') continue; + if (cls.indexOf('group') === -1 || cls.indexOf('flex') === -1) continue; + + var href = a.getAttribute('href'); + if (isLocalHref(href)) { + a.removeAttribute('target'); + swapArrowToChevron(a); + } + a.setAttribute('data-nav-processed', '1'); + } + } + + // Debounced run: schedule a single stripper run after mutations stop. + var scheduleId = null; + var debounceMs = 120; + function scheduleStrip() { + if (scheduleId) clearTimeout(scheduleId); + scheduleId = setTimeout(function () { + scheduleId = null; + stripTargetBlankFromLocalGroupFlexLinks(); + }, debounceMs); + } + + // Run as soon as the DOM is ready. + if (document.readyState === 'loading') { + document.addEventListener('DOMContentLoaded', function () { + stripTargetBlankFromLocalGroupFlexLinks(); + }); + } else { + stripTargetBlankFromLocalGroupFlexLinks(); + } + + // Delayed runs to catch nav that appears only after framework hydration. + [300, 800, 1500, 3000].forEach(function (ms) { + setTimeout(stripTargetBlankFromLocalGroupFlexLinks, ms); + }); + + // Whenever the framework adds nodes or sets target on a link, run the stripper + // (debounced) so we fix links as soon as they appear or get target="_blank". + function startObserving() { + if (!document.body) return; + var observer = new MutationObserver(function () { + scheduleStrip(); + }); + observer.observe(document.body, { + childList: true, + subtree: true, + attributes: true, + attributeFilter: ['target'] + }); + } + if (document.readyState === 'loading') { + document.addEventListener('DOMContentLoaded', startObserving); + } else { + startObserving(); + } + + // When the user hits "back", re-run so links are fixed after bfcache or re-render. + window.addEventListener('pageshow', function () { + stripTargetBlankFromLocalGroupFlexLinks(); + }); +})(); diff --git a/support/index.mdx b/support/index.mdx new file mode 100644 index 0000000000..628ff1d3ea --- /dev/null +++ b/support/index.mdx @@ -0,0 +1,51 @@ +--- +title: Support +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_index.mdx.j2 +*/} + +import {Banner} from "/snippets/Banner.jsx"; + + + Search for help from support articles, product documentation,
+and the W&B community. + + +## Featured articles + +Here are the most commonly asked questions across all categories. + +### W&B Models + + + At the beginning of the training script, call wandb.init wit... + +[Experiments](/support/models/tags/experiments) + + + You can use W&B Sweeps with custom CLI commands if training ... + +[Sweeps](/support/models/tags/sweeps) + + + By default, wandb.init starts a process that syncs metrics i... + +[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 creat... + +[Environment Variables](/support/models/tags/environment-variables) [Experiments](/support/models/tags/experiments) + + +If you can't find what you are looking for, browse through the popular categories below or search through articles based on categories. + + + Contact support + \ No newline at end of file diff --git a/support/inference/articles/api-error-code-401-authentication-failed.mdx b/support/inference/articles/api-error-code-401-authentication-failed.mdx new file mode 100644 index 0000000000..4cd8313e25 --- /dev/null +++ b/support/inference/articles/api-error-code-401-authentication-failed.mdx @@ -0,0 +1,35 @@ +--- +title: "API error code 401 - Authentication failed" +sidebarTitle: "API error code 401 - Authentication failed" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A 401 error with the message "Authentication failed" means your authentication credentials are incorrect or your W&B project entity and/or name are incorrect. + +## Why this happens + +The W&B Inference API requires valid authentication credentials to process requests. This error occurs when: + +- Your API key is invalid, expired, or revoked +- Your W&B project entity name is incorrect +- Your W&B project name is incorrect + +## What you can do + +1. **Verify your API key** + - Check that you're using the correct API key for your account + - Regenerate your API key if needed from your [W&B settings](https://wandb.ai/settings) + +2. **Check your project details** + - Ensure your W&B project entity (organization or username) is correct + - Verify that the project name matches an existing project + +3. **Contact support** + - If the issue persists after verifying your credentials, reach out to [W&B support](mailto:support@wandb.com) + +--- + +[Inference](/support/inference/tags/inference)[API Errors](/support/inference/tags/api-errors) \ No newline at end of file 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 new file mode 100644 index 0000000000..b178435e75 --- /dev/null +++ b/support/inference/articles/api-error-code-402-you-exceeded-your-cur.mdx @@ -0,0 +1,34 @@ +--- +title: "API error code 402 - You exceeded your current quota" +sidebarTitle: "API error code 402 - You exceeded your current quota" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A 402 error with the message "You exceeded your current quota, please check your plan and billing details" means you've run out of credits or reached your monthly spending cap. + +## Why this happens + +W&B Inference uses a credit-based system. This error occurs when: + +- Your account has no remaining credits +- You've reached the monthly spending cap set for your organization + +## What you can do + +1. **Check your plan and billing details** + - Review your current usage and remaining credits in your W&B account settings + +2. **Get more credits** + - Purchase additional credits or upgrade your plan + +3. **Increase your limits** + - Adjust your monthly spending cap if one is configured + +For more information, see [Usage information and limits](/inference/usage-limits/). + +--- + +[Inference](/support/inference/tags/inference)[API Errors](/support/inference/tags/api-errors)[Billing](/support/inference/tags/billing) \ No newline at end of file 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 new file mode 100644 index 0000000000..4e0c3a22a8 --- /dev/null +++ b/support/inference/articles/api-error-code-403-country-region-or-ter.mdx @@ -0,0 +1,45 @@ +--- +title: "API error code 403 - Country, region, or territory not supported" +sidebarTitle: "API error code 403 - Country, region, or territory not supported" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A 403 error with the message "Country, region, or territory not supported" means you're accessing W&B Inference from an unsupported location. + +## Why this happens + +W&B Inference has geographic restrictions due to compliance and regulatory requirements. The service is only accessible from supported geographic locations. + +## What you can do + +1. **Check the geographic restrictions** + - Review the [geographic restrictions](/inference/usage-limits/#geographic-restrictions) for the current list of supported locations + +2. **Use from a supported location** + - Access the service when in a supported country or region + - Consider using your organization's resources in supported locations + +3. **Contact your account team** + - Enterprise customers can discuss options with their account executive + - Some organizations may have special arrangements + +## Error details + +When you see this error: +``` +{ + "error": { + "code": 403, + "message": "Country, region, or territory not supported" + } +} +``` + +This is determined by your IP address location at the time of the API request. + +--- + +[Inference](/support/inference/tags/inference)[API Errors](/support/inference/tags/api-errors) \ No newline at end of file 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 new file mode 100644 index 0000000000..f667ec34db --- /dev/null +++ b/support/inference/articles/api-error-code-403-the-inference-gateway.mdx @@ -0,0 +1,26 @@ +--- +title: "API error code 403 - The inference gateway is not enabled for your organization" +sidebarTitle: "API error code 403 - The inference gateway is not enabled for your organization" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A 403 error with the message "The inference gateway is not enabled for your organization" means your organization doesn't have the inference gateway enabled, which is required to use W&B Inference. + +## Why this happens + +W&B Inference requires the inference gateway to be enabled at the organization level. If your organization hasn't enabled this feature, all API requests will be rejected with a 403 error. + +## What you can do + +1. **Contact your W&B administrator** + - Ask your organization's W&B administrator to enable the inference gateway + +2. **Reach out to W&B support** + - If you're unsure who your administrator is, or need help enabling the gateway, contact [W&B support](mailto:support@wandb.com) for assistance + +--- + +[Inference](/support/inference/tags/inference)[API Errors](/support/inference/tags/api-errors)[Administrator](/support/inference/tags/administrator) \ No newline at end of file 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 new file mode 100644 index 0000000000..1e8d848938 --- /dev/null +++ b/support/inference/articles/api-error-code-429-concurrency-limit-rea.mdx @@ -0,0 +1,29 @@ +--- +title: "API error code 429 - Concurrency limit reached for requests" +sidebarTitle: "API error code 429 - Concurrency limit reached for requests" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A 429 error with the message "Concurrency limit reached for requests" means you're sending too many concurrent requests to the W&B Inference API. + +## Why this happens + +W&B Inference enforces concurrency limits to ensure fair usage and service stability. When the number of simultaneous requests from your account exceeds the allowed limit, additional requests are rejected with a 429 status code. + +## What you can do + +1. **Reduce concurrent requests** + - Implement request queuing or throttling in your application + - Use exponential backoff when retrying failed requests + +2. **Increase your limits** + - Review your plan's concurrency limits and upgrade if needed + +For more information, see [Usage information and limits](/inference/usage-limits/). + +--- + +[Inference](/support/inference/tags/inference)[API Errors](/support/inference/tags/api-errors) \ No newline at end of file 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 new file mode 100644 index 0000000000..46ab86b2f4 --- /dev/null +++ b/support/inference/articles/api-error-code-500-the-server-had-an-err.mdx @@ -0,0 +1,27 @@ +--- +title: "API error code 500 - The server had an error while processing your request" +sidebarTitle: "API error code 500 - The server had an error while processing your request" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A 500 error with the message "The server had an error while processing your request" indicates an internal server error on the W&B Inference side. + +## Why this happens + +Internal server errors are typically transient issues caused by temporary problems on the server side. These are not caused by your request or configuration. + +## What you can do + +1. **Retry after a brief wait** + - Wait a few seconds and retry your request + - Use exponential backoff for automated retries + +2. **Contact support if it persists** + - If you continue to see 500 errors after multiple retries, contact [W&B support](mailto:support@wandb.com) with details about your request + +--- + +[Inference](/support/inference/tags/inference)[API Errors](/support/inference/tags/api-errors) \ No newline at end of file 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 new file mode 100644 index 0000000000..0b28b7c338 --- /dev/null +++ b/support/inference/articles/api-error-code-503-the-engine-is-current.mdx @@ -0,0 +1,28 @@ +--- +title: "API error code 503 - The engine is currently overloaded" +sidebarTitle: "API error code 503 - The engine is currently overloaded" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A 503 error with the message "The engine is currently overloaded, please try again later" means the W&B Inference server is experiencing high traffic and cannot process your request right now. + +## Why this happens + +During periods of high demand, the inference engine may become temporarily overloaded. This is a transient condition that typically resolves on its own as traffic subsides. + +## What you can do + +1. **Retry after a short delay** + - Wait a few seconds before retrying your request + - Use exponential backoff to avoid adding to the congestion + +2. **Spread out requests** + - If you're sending many requests, consider spacing them out over time + - Implement request queuing to smooth traffic spikes + +--- + +[Inference](/support/inference/tags/inference)[API Errors](/support/inference/tags/api-errors) \ No newline at end of file diff --git a/support/inference/index.mdx b/support/inference/index.mdx new file mode 100644 index 0000000000..0e3e44980b --- /dev/null +++ b/support/inference/index.mdx @@ -0,0 +1,21 @@ +--- +title: "Support: W&B Inference" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_product_index.mdx.j2 +*/} +## Browse by category + + + 7 articles + + + 1 article + + + 1 article + + + 7 articles + diff --git a/support/inference/tags/administrator.mdx b/support/inference/tags/administrator.mdx new file mode 100644 index 0000000000..1b2e684a31 --- /dev/null +++ b/support/inference/tags/administrator.mdx @@ -0,0 +1,12 @@ +--- +title: "Administrator" +sidebarTitle: "Administrator (1)" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_tag.mdx.j2 +*/} + + + A 403 error with the message "The inference gateway is not e ... + diff --git a/support/inference/tags/api-errors.mdx b/support/inference/tags/api-errors.mdx new file mode 100644 index 0000000000..fd7440bdbe --- /dev/null +++ b/support/inference/tags/api-errors.mdx @@ -0,0 +1,30 @@ +--- +title: "API Errors" +sidebarTitle: "API Errors (7)" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_tag.mdx.j2 +*/} + + + A 401 error with the message "Authentication failed" means y ... + + + A 402 error with the message "You exceeded your current quot ... + + + A 403 error with the message "Country, region, or territory ... + + + A 403 error with the message "The inference gateway is not e ... + + + A 429 error with the message "Concurrency limit reached for ... + + + A 500 error with the message "The server had an error while ... + + + A 503 error with the message "The engine is currently overlo ... + diff --git a/support/inference/tags/billing.mdx b/support/inference/tags/billing.mdx new file mode 100644 index 0000000000..9a5c80d543 --- /dev/null +++ b/support/inference/tags/billing.mdx @@ -0,0 +1,12 @@ +--- +title: "Billing" +sidebarTitle: "Billing (1)" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_tag.mdx.j2 +*/} + + + A 402 error with the message "You exceeded your current quot ... + diff --git a/support/inference/tags/inference.mdx b/support/inference/tags/inference.mdx new file mode 100644 index 0000000000..669e842354 --- /dev/null +++ b/support/inference/tags/inference.mdx @@ -0,0 +1,30 @@ +--- +title: "Inference" +sidebarTitle: "Inference (7)" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_tag.mdx.j2 +*/} + + + A 401 error with the message "Authentication failed" means y ... + + + A 402 error with the message "You exceeded your current quot ... + + + A 403 error with the message "Country, region, or territory ... + + + A 403 error with the message "The inference gateway is not e ... + + + A 429 error with the message "Concurrency limit reached for ... + + + A 500 error with the message "The server had an error while ... + + + A 503 error with the message "The engine is currently overlo ... + diff --git a/support/inference_redirector.mdx b/support/inference_redirector.mdx new file mode 100644 index 0000000000..ce70f3ad94 --- /dev/null +++ b/support/inference_redirector.mdx @@ -0,0 +1,4 @@ +--- +title: "W&B Inference" +url: "/support/inference/index" +--- diff --git a/support/models/articles/adding-multiple-authors-to-a-report.mdx b/support/models/articles/adding-multiple-authors-to-a-report.mdx new file mode 100644 index 0000000000..f2e94ccd46 --- /dev/null +++ b/support/models/articles/adding-multiple-authors-to-a-report.mdx @@ -0,0 +1,20 @@ +--- +title: "Adding multiple authors to a report" +sidebarTitle: "Adding multiple authors to a report" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Accurately credit all contributors in your report by adding multiple authors. + +To add multiple authors, click on the **+** icon next to the name of the author. This will open a drop-down menu with all the users who have access to the report. Select the users you want to add as authors. + + + Adding multiple report authors + + +--- + +[Reports](/support/models/tags/reports) \ No newline at end of file diff --git a/support/models/articles/best-practices-to-organize-hyperparamete.mdx b/support/models/articles/best-practices-to-organize-hyperparamete.mdx new file mode 100644 index 0000000000..bbf31a62af --- /dev/null +++ b/support/models/articles/best-practices-to-organize-hyperparamete.mdx @@ -0,0 +1,16 @@ +--- +title: "Best practices to organize hyperparameter searches" +sidebarTitle: "Best practices to organize hyperparameter searches" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +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. + +For more information on `wandb.init()`, see the [`wandb.init()` reference](/models/ref/python/functions/init). + +--- + +[Hyperparameter](/support/models/tags/hyperparameter)[Sweeps](/support/models/tags/sweeps)[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..bcad51e13d --- /dev/null +++ b/support/models/articles/can-i-get-an-academic-plan-as-a-student.mdx @@ -0,0 +1,18 @@ +--- +title: "Can I get an academic plan as a student?" +sidebarTitle: "Can I get an academic plan as a student?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Students can apply for an academic plan by following these steps: + +- Visit [the Pricing page on the wandb.com](https://wandb.ai/site/pricing). +- Apply for the academic plan. +- Alternatively, start with a 30-day trial and convert it to an academic plan by visiting the [W&B academic application page](https://wandb.ai/academic_application). + +--- + +[Administrator](/support/models/tags/administrator)[Academic](/support/models/tags/academic)[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..211dc28dbf --- /dev/null +++ b/support/models/articles/can-i-group-runs-without-using-the-group.mdx @@ -0,0 +1,14 @@ +--- +title: "Can I group runs without using the 'Group' feature?" +sidebarTitle: "Can I group runs without using the 'Group' feature?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +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. + +--- + +[Workspaces](/support/models/tags/workspaces)[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..3ee6a765f2 --- /dev/null +++ b/support/models/articles/can-i-just-log-metrics-no-code-or-datase.mdx @@ -0,0 +1,25 @@ +--- +title: "Can I just log metrics, no code or dataset examples?" +sidebarTitle: "Can I just log metrics, no code or dataset examples?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.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 off code logging with environment variables: + +1. Set `WANDB_DISABLE_CODE` to `true` to turn off all code tracking. This action prevents retrieval of the git SHA and the diff patch. +2. Set `WANDB_IGNORE_GLOBS` to `*.patch` to stop syncing the diff patch to the servers, while keeping it available locally for application with `wandb restore`. + +As an administrator, you can also turn off code saving for your team in your team's settings: + +1. Navigate to the settings of your team at `https://wandb.ai//settings`. Where `` is the name of your team. +2. Scroll to the Privacy section. +3. Toggle **Enable code saving by default**. + +--- + +[Administrator](/support/models/tags/administrator)[Team Management](/support/models/tags/team-management)[Metrics](/support/models/tags/metrics) \ No newline at end of file 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 new file mode 100644 index 0000000000..4638035b87 --- /dev/null +++ b/support/models/articles/can-i-just-set-the-run-name-to-the-run-i.mdx @@ -0,0 +1,22 @@ +--- +title: "Can I just set the run name to the run ID?" +sidebarTitle: "Can I just set the run name to the run ID?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Yes. To overwrite the run name with the run ID, use the following code snippet: + +```python +import wandb + +with wandb.init() as run: + run.name = run.id + run.save() +``` + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..2d90c79a33 --- /dev/null +++ b/support/models/articles/can-i-log-metrics-on-two-different-time-.mdx @@ -0,0 +1,27 @@ +--- +title: "Can I log metrics on two different time scales?" +sidebarTitle: "Can I log metrics on two different time scales?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +For example, I want to log training accuracy per batch and validation accuracy per epoch. + +Yes, log indices like `batch` and `epoch` alongside your metrics. Use `wandb.Run.log()({'train_accuracy': 0.9, 'batch': 200})` in one step and `wandb.Run.log()({'val_accuracy': 0.8, 'epoch': 4})` in another. In the UI, set the desired value as the x-axis for each chart. To set a default x-axis for a specific index, use [Run.define_metric()](/models/ref/python/experiments/run#define_metric). For the example provided, use the following code: + +```python +import wandb + +with wandb.init() as run: + run.define_metric("batch") + run.define_metric("epoch") + + run.define_metric("train_accuracy", step_metric="batch") + run.define_metric("val_accuracy", step_metric="epoch") +``` + +--- + +[Experiments](/support/models/tags/experiments)[Metrics](/support/models/tags/metrics) \ No newline at end of file diff --git a/support/models/articles/can-i-rerun-a-grid-search.mdx b/support/models/articles/can-i-rerun-a-grid-search.mdx new file mode 100644 index 0000000000..6904044c46 --- /dev/null +++ b/support/models/articles/can-i-rerun-a-grid-search.mdx @@ -0,0 +1,16 @@ +--- +title: "Can I rerun a grid search?" +sidebarTitle: "Can I rerun a grid search?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +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 control page](/models/sweeps/sweeps-ui). Start new W&B Sweep agents using the new Sweep ID. + +W&B Run parameter combinations that completed are not re-executed. + +--- + +[Sweeps](/support/models/tags/sweeps)[Hyperparameter](/support/models/tags/hyperparameter)[Runs](/support/models/tags/runs) \ No newline at end of file diff --git a/support/models/articles/can-i-run-wandb-offline.mdx b/support/models/articles/can-i-run-wandb-offline.mdx new file mode 100644 index 0000000000..5c4e3d1a4b --- /dev/null +++ b/support/models/articles/can-i-run-wandb-offline.mdx @@ -0,0 +1,20 @@ +--- +title: "Can I run wandb offline?" +sidebarTitle: "Can I run wandb offline?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If training occurs on an offline machine, use the following steps to upload results to the servers: + +1. Set the environment variable `WANDB_MODE=offline` to save metrics locally without an internet connection. +2. When ready to upload, run `wandb init` in your directory to set the project name. +3. Use `wandb sync YOUR_RUN_DIRECTORY` to transfer metrics to the cloud service and access results in the hosted web app. + +To confirm the run is offline, check `run.settings._offline` or `run.settings.mode` after executing `wandb.init()`. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..0096bc0dc7 --- /dev/null +++ b/support/models/articles/can-i-turn-off-wandb-when-testing-my-cod.mdx @@ -0,0 +1,18 @@ +--- +title: "Can I turn off wandb when testing my code?" +sidebarTitle: "Can I turn off wandb when testing my code?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Use `wandb.init(mode="disabled")` or set `WANDB_MODE=disabled` to configure W&B as a no-operation (NOOP) for testing purposes. + + +Using `wandb.init(mode="disabled")` does not prevent W&B from saving artifacts to `WANDB_CACHE_DIR`. + + +--- + +[Artifacts](/support/models/tags/artifacts) \ No newline at end of file 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 new file mode 100644 index 0000000000..c9c7c0404a --- /dev/null +++ b/support/models/articles/can-i-use-markdown-in-my-reports.mdx @@ -0,0 +1,14 @@ +--- +title: "Can I use Markdown in my reports?" +sidebarTitle: "Can I use Markdown in my reports?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Yes. Type "/mark" anywhere in the document and press enter to insert a Markdown block. This allows editing with Markdown as before. + +--- + +[Reports](/support/models/tags/reports) \ No newline at end of file diff --git a/support/models/articles/can-i-use-sweeps-and-sagemaker.mdx b/support/models/articles/can-i-use-sweeps-and-sagemaker.mdx new file mode 100644 index 0000000000..1fb60c70e9 --- /dev/null +++ b/support/models/articles/can-i-use-sweeps-and-sagemaker.mdx @@ -0,0 +1,19 @@ +--- +title: "Can I use Sweeps and SageMaker?" +sidebarTitle: "Can I use Sweeps and SageMaker?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To authenticate W&B, complete the following steps: create a `requirements.txt` file if using a built-in Amazon SageMaker estimator. For details on authentication and setting up the `requirements.txt` file, refer to the [SageMaker integration](/models/integrations/sagemaker) guide. + + +Find a complete example on [GitHub](https://github.com/wandb/examples/tree/master/examples/pytorch/pytorch-cifar10-sagemaker) and additional insights on our [blog](https://wandb.ai/site/articles/running-sweeps-with-sagemaker).\ +Access the [Deploy Sentiment Analyzer Using SageMaker and W&B tutorial](https://wandb.ai/authors/sagemaker/reports/Deploy-Sentiment-Analyzer-Using-SageMaker-and-W-B--VmlldzoxODA1ODE) for deploying a sentiment analyzer using SageMaker and W&B. + + +--- + +[Sweeps](/support/models/tags/sweeps)[AWS](/support/models/tags/aws) \ No newline at end of file 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 new file mode 100644 index 0000000000..6581218226 --- /dev/null +++ b/support/models/articles/can-wb-team-members-see-my-data.mdx @@ -0,0 +1,14 @@ +--- +title: "Can W&B team members see my data?" +sidebarTitle: "Can W&B team members see my data?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Key engineers and support staff at W&B access logged values for debugging purposes with user permission. All data stores encrypt data at rest, and audit logs record access. For complete data security from W&B employees, license the Self-Managed solution to run a W&B server within your own infrastructure. + +--- + +[Privacy](/support/models/tags/privacy)[Security](/support/models/tags/security) \ No newline at end of file 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 new file mode 100644 index 0000000000..c915914000 --- /dev/null +++ b/support/models/articles/can-we-flag-boolean-variables-as-hyperpa.mdx @@ -0,0 +1,14 @@ +--- +title: "Can we flag boolean variables as hyperparameters?" +sidebarTitle: "Can we flag boolean variables as hyperparameters?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Use the `${args_no_boolean_flags}` macro in the command section of the configuration to pass hyperparameters as boolean flags. This macro automatically includes boolean parameters as flags. If `param` is `True`, the command receives `--param`. If `param` is `False`, the flag is omitted. + +--- + +[Sweeps](/support/models/tags/sweeps) \ No newline at end of file diff --git a/support/models/articles/can-you-group-runs-by-tags.mdx b/support/models/articles/can-you-group-runs-by-tags.mdx new file mode 100644 index 0000000000..70430295c8 --- /dev/null +++ b/support/models/articles/can-you-group-runs-by-tags.mdx @@ -0,0 +1,14 @@ +--- +title: "Can you group runs by tags?" +sidebarTitle: "Can you group runs by tags?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A run can have multiple tags, so grouping by tags is not supported. Add a value to the [`config`](/models/track/config) object for these runs and group by this config value instead. This can be accomplished using [the API](/models/track/config#set-the-configuration-after-your-run-has-finished). + +--- + +[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..039693b939 --- /dev/null +++ b/support/models/articles/can-you-use-wb-sweeps-with-cloud-infrast.mdx @@ -0,0 +1,16 @@ +--- +title: "Can you use W&B Sweeps with cloud infrastructures such as AWS Batch, ECS, etc.?" +sidebarTitle: "Can you use W&B Sweeps with cloud infrastructures such as AWS Batch, ECS, etc.?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +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`. + +For example, launch an Amazon EC2 instance and execute `wandb agent` on it. Use an SQS queue to broadcast the `sweep_id` to multiple EC2 instances. Each instance can then retrieve the `sweep_id` from the queue and initiate the process. + +--- + +[Sweeps](/support/models/tags/sweeps)[AWS](/support/models/tags/aws) \ No newline at end of file diff --git a/support/models/articles/do-environment-variables-overwrite-the-p.mdx b/support/models/articles/do-environment-variables-overwrite-the-p.mdx new file mode 100644 index 0000000000..1ccaeb7765 --- /dev/null +++ b/support/models/articles/do-environment-variables-overwrite-the-p.mdx @@ -0,0 +1,14 @@ +--- +title: "Do environment variables overwrite the parameters passed to wandb.init()?" +sidebarTitle: "Do environment variables overwrite the parameters passed to wandb.init()?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Arguments passed to `wandb.init` override environment variables. To set a default directory other than the system default when the environment variable isn't set, use `wandb.init(dir=os.getenv("WANDB_DIR", my_default_override))`. + +--- + +[Environment Variables](/support/models/tags/environment-variables) \ No newline at end of file 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 new file mode 100644 index 0000000000..d399af728e --- /dev/null +++ b/support/models/articles/do-i-need-to-provide-values-for-all-hype.mdx @@ -0,0 +1,46 @@ +--- +title: "Do I need to provide values for all hyperparameters as part of the W&B Sweep. Can I set defaults?" +sidebarTitle: "Do I need to provide values for all hyperparameters as part of the W&B Sweep. Can I set defaults?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Access hyperparameter names and values from the sweep configuration using `(run.config())`, which acts like a dictionary. + +For runs outside a sweep, set `wandb.Run.config()` values by passing a dictionary to the `config` argument in `wandb.init()`. In a sweep, any configuration supplied to `wandb.init()` serves as a default value, which the sweep can override. + +Use `rwandb.Run.config.setdefaults()` for explicit behavior. The following code snippets illustrate both methods: + + + +```python +# Set default values for hyperparameters +config_defaults = {"lr": 0.1, "batch_size": 256} + +# Start a run and provide defaults +# that a sweep can override +with wandb.init(config=config_defaults) as run: + # Add training code here + ... +``` + + +```python +# Set default values for hyperparameters +config_defaults = {"lr": 0.1, "batch_size": 256} + +# Start a run +with wandb.init() as run: + # Update any values not set by the sweep + run.config.setdefaults(config_defaults) + + # Add training code here +``` + + + +--- + +[Sweeps](/support/models/tags/sweeps) \ No newline at end of file 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 new file mode 100644 index 0000000000..5ca90ea3fd --- /dev/null +++ b/support/models/articles/do-run-finished-alerts-work-in-notebooks.mdx @@ -0,0 +1,16 @@ +--- +title: "Do 'Run Finished' alerts work in notebooks?" +sidebarTitle: "Do 'Run Finished' alerts work in notebooks?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +No. **Run Finished** alerts (activated with the **Run Finished** setting in User Settings) operate only with Python scripts and remain turned off in Jupyter Notebook environments to avoid notifications for each cell execution. + +Use `run.alert()` in notebook environments instead. + +--- + +[Alerts](/support/models/tags/alerts)[Notebooks](/support/models/tags/notebooks) \ No newline at end of file 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 new file mode 100644 index 0000000000..d37e7ea5fa --- /dev/null +++ b/support/models/articles/do-you-have-a-bug-bounty-program.mdx @@ -0,0 +1,14 @@ +--- +title: "Do you have a bug bounty program?" +sidebarTitle: "Do you have a bug bounty program?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Weights and Biases has a bug bounty program. Access the [W&B security portal](https://security.wandb.ai/) for details. + +--- + +[Security](/support/models/tags/security) \ No newline at end of file diff --git a/support/models/articles/does-logging-block-my-training.mdx b/support/models/articles/does-logging-block-my-training.mdx new file mode 100644 index 0000000000..d3ce2124ff --- /dev/null +++ b/support/models/articles/does-logging-block-my-training.mdx @@ -0,0 +1,16 @@ +--- +title: "Does logging block my training?" +sidebarTitle: "Does logging block my training?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +"Is the logging function lazy? I don't want to depend on the network to send results to your servers while executing local operations." + +The `wandb.log` function writes a line to a local file and does not block network calls. When calling `wandb.init`, a new process starts on the same machine. This process listens for filesystem changes and communicates with the web service asynchronously, allowing local operations to continue uninterrupted. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..27b2bd5551 --- /dev/null +++ b/support/models/articles/does-the-wb-client-support-python-2.mdx @@ -0,0 +1,14 @@ +--- +title: "Does the W&B client support Python 2?" +sidebarTitle: "Does the W&B client support Python 2?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.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 with version 0.11 due to Python 2's end of life. Running `pip install --upgrade wandb` on a Python 2.7 system installs only new releases of the 0.10.x series. Support for the 0.10.x series includes critical bug fixes and patches only. The last version of the 0.10.x series that supports Python 2.7 is 0.10.33. + +--- + +[Python](/support/models/tags/python) \ No newline at end of file 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 new file mode 100644 index 0000000000..cbfbc5d05a --- /dev/null +++ b/support/models/articles/does-the-wb-client-support-python-35.mdx @@ -0,0 +1,14 @@ +--- +title: "Does the W&B client support Python 3.5?" +sidebarTitle: "Does the W&B client support Python 3.5?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The W&B client library supported Python 3.5 until version 0.11. Support for Python 3.5 ended with version 0.12, which aligns with its end of life. For more details, visit [version 0.12 release notes](https://github.com/wandb/wandb/releases/tag/v0.12.0). + +--- + +[Python](/support/models/tags/python) \ No newline at end of file diff --git a/support/models/articles/does-this-only-work-for-python.mdx b/support/models/articles/does-this-only-work-for-python.mdx new file mode 100644 index 0000000000..53c2a72d3b --- /dev/null +++ b/support/models/articles/does-this-only-work-for-python.mdx @@ -0,0 +1,14 @@ +--- +title: "Does this only work for Python?" +sidebarTitle: "Does this only work for Python?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The library supports Python 2.7 and later, as well as Python 3.6 and later. The architecture facilitates integration with other programming languages. For monitoring other languages, contact [contact@wandb.com](mailto:contact@wandb.com). + +--- + +[Python](/support/models/tags/python) \ No newline at end of file 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 new file mode 100644 index 0000000000..2f267ef8a1 --- /dev/null +++ b/support/models/articles/does-wb-support-sso-for-multi-tenant.mdx @@ -0,0 +1,22 @@ +--- +title: "Does W&B support SSO for Multi-tenant?" +sidebarTitle: "Does W&B support SSO for Multi-tenant?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +W&B supports Single Sign-On (SSO) for the Multi-tenant offering through Auth0. SSO integration is compatible with any OIDC-compliant identity provider, such as Okta or Azure AD. To configure an OIDC provider, follow these steps: + +* Create a Single Page Application (SPA) on the identity provider. +* Set the `grant_type` to `implicit` flow. +* Set the callback URI to `https://wandb.auth0.com/login/callback`. + +**Requirements for W&B** + +After completing the setup, contact the customer success manager (CSM) with the `Client ID` and `Issuer URL` for the application. W&B will establish an Auth0 connection using these details and enable SSO. + +--- + +[Security](/support/models/tags/security) \ No newline at end of file diff --git a/support/models/articles/does-wb-use-the-multiprocessing-library.mdx b/support/models/articles/does-wb-use-the-multiprocessing-library.mdx new file mode 100644 index 0000000000..073b56b41c --- /dev/null +++ b/support/models/articles/does-wb-use-the-multiprocessing-library.mdx @@ -0,0 +1,21 @@ +--- +title: "Does W&B use the `multiprocessing` library?" +sidebarTitle: "Does W&B use the `multiprocessing` library?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Yes, W&B uses the `multiprocessing` library. An error message like the following indicates a possible issue: + +``` +An attempt has been made to start a new process before the current process +has finished its bootstrapping phase. +``` + +To resolve this, add an entry point protection with `if __name__ == "__main__":`. This protection is necessary when running W&B directly from the script. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..bb71e1a9a2 --- /dev/null +++ b/support/models/articles/does-your-tool-track-or-store-training-d.mdx @@ -0,0 +1,14 @@ +--- +title: "Does your tool track or store training data?" +sidebarTitle: "Does your tool track or store training data?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Pass a SHA or unique identifier to `wandb.Run.config.update(...)` to associate a dataset with a training run. W&B stores no data unless `wandb.Run.save()` is called with the local file name. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file diff --git a/support/models/articles/embedding-reports.mdx b/support/models/articles/embedding-reports.mdx new file mode 100644 index 0000000000..a5bf51881b --- /dev/null +++ b/support/models/articles/embedding-reports.mdx @@ -0,0 +1,18 @@ +--- +title: "Embedding Reports" +sidebarTitle: "Embedding Reports" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +You can share your report by embedding it. Click the **Share** button at the top right of your report, then copy the embedded code from the bottom of the pop-up window. + + +Embedding reports + + +--- + +[Reports](/support/models/tags/reports) \ No newline at end of file diff --git a/support/models/articles/filter-and-delete-unwanted-reports.mdx b/support/models/articles/filter-and-delete-unwanted-reports.mdx new file mode 100644 index 0000000000..9db9612cff --- /dev/null +++ b/support/models/articles/filter-and-delete-unwanted-reports.mdx @@ -0,0 +1,18 @@ +--- +title: "Filter and delete unwanted reports" +sidebarTitle: "Filter and delete unwanted reports" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Use the search bar to filter the reports list. Select an unwanted report to delete it individually, or select all reports and click 'Delete Reports' to remove them from the project. + + +Delete unwanted reports and drafts + + +--- + +[Reports](/support/models/tags/reports) \ No newline at end of file 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 new file mode 100644 index 0000000000..479224de3c --- /dev/null +++ b/support/models/articles/how-can-i-access-the-data-logged-to-my-r.mdx @@ -0,0 +1,20 @@ +--- +title: "How can I access the data logged to my runs directly and programmatically?" +sidebarTitle: "How can I access the data logged to my runs directly and programmatically?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The history object tracks metrics logged with `wandb.log`. Access the history object using the API: + +```python +api = wandb.Api() +run = api.run("username/project/run_id") +print(run.history()) +``` + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..e7f8015d8e --- /dev/null +++ b/support/models/articles/how-can-i-be-removed-from-a-team.mdx @@ -0,0 +1,14 @@ +--- +title: "How can I be removed from a team?" +sidebarTitle: "How can I be removed from a team?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A team admin can [remove you from a team](/platform/app/settings-page/teams) from the **Users** tab of the team settings. + +--- + +[Administrator](/support/models/tags/administrator)[Team Management](/support/models/tags/team-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..21c1b96f7a --- /dev/null +++ b/support/models/articles/how-can-i-change-how-frequently-to-log-s.mdx @@ -0,0 +1,18 @@ +--- +title: "How can I change how frequently to log system metrics?" +sidebarTitle: "How can I change how frequently to log system metrics?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To configure the frequency to log [system metrics](/models/ref/python/experiments/system-metrics), set `_stats_sampling_interval` to a number of seconds, expressed as a float. Default: `10.0`. + +```python +wandb.init(settings=wandb.Settings(x_stats_sampling_interval=30.0)) +``` + +--- + +[Metrics](/support/models/tags/metrics)[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..f1a0d566c2 --- /dev/null +++ b/support/models/articles/how-can-i-change-my-account-from-corpora.mdx @@ -0,0 +1,22 @@ +--- +title: "How can I change my account from corporate to academic?" +sidebarTitle: "How can I change my account from corporate to academic?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To change an account from corporate to academic in W&B, follow these steps: + +1. **Link your academic email**: + - Access account settings. + - Add and set the academic email as the primary email. + +2. **Apply for an academic plan**: + - Visit the [W&B academic application page](https://wandb.ai/academic_application). + - Submit the application for review. + +--- + +[Administrator](/support/models/tags/administrator)[Academic](/support/models/tags/academic)[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..d0828e37ad --- /dev/null +++ b/support/models/articles/how-can-i-change-the-colors-of-each-run-.mdx @@ -0,0 +1,14 @@ +--- +title: "How can I change the colors of each run in the same group?" +sidebarTitle: "How can I change the colors of each run in the same group?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Changing the colors of individual runs within a group is not possible. All runs in the same group share a common color. + +--- + +[Runs](/support/models/tags/runs)[Workspaces](/support/models/tags/workspaces) \ No newline at end of file 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 new file mode 100644 index 0000000000..f8243b022c --- /dev/null +++ b/support/models/articles/how-can-i-change-the-directory-my-sweep-.mdx @@ -0,0 +1,18 @@ +--- +title: "How can I change the directory my sweep logs to locally?" +sidebarTitle: "How can I change the directory my sweep logs to locally?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Set the logging directory for W&B run data by configuring the environment variable `WANDB_DIR`. For example: + +```python +os.environ["WANDB_DIR"] = os.path.abspath("your/directory") +``` + +--- + +[Sweeps](/support/models/tags/sweeps) \ No newline at end of file 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 new file mode 100644 index 0000000000..810a8058f6 --- /dev/null +++ b/support/models/articles/how-can-i-change-the-privacy-of-my-proje.mdx @@ -0,0 +1,30 @@ +--- +title: "How can I change the privacy of my project?" +sidebarTitle: "How can I change the privacy of my project?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.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 project sidebar. +1. At the top right, click **Edit**. +1. Choose a new value for **Project visibility**: + + - **Team** (default): Only your team can view and edit the project. + - **Restricted**: Only invited members can access the project, and public access is turned off. + - **Open**: Anyone can submit runs or create reports, but only your team can edit it. Appropriate only for classroom settings, public benchmark competitions, or other non-durable contexts. + - **Public**: Anyone can view the project, but only your team can edit it. + + + If your W&B admins have turned off **Public** visibility, you cannot choose it. Instead, you can share a view-only [W&B Report](/models/reports/collaborate-on-reports#share-a-report), or contact your W&B organization's admins for assistance. + +1. Click **Save**. + +If you update a project to a more strict privacy setting, you may need to re-invite individual users to restore their ability to access the project. + +--- + +[Privacy](/support/models/tags/privacy)[Projects](/support/models/tags/projects) \ No newline at end of file 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 new file mode 100644 index 0000000000..2d68c620a6 --- /dev/null +++ b/support/models/articles/how-can-i-compare-images-or-media-across.mdx @@ -0,0 +1,14 @@ +--- +title: "How can I compare images or media across epochs or steps?" +sidebarTitle: "How can I compare images or media across epochs or steps?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Expand the image panel and use the step slider to navigate through images from different steps. This process facilitates comparison of a model's output changes during training. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..0ef921c1b9 --- /dev/null +++ b/support/models/articles/how-can-i-configure-the-name-of-the-run-.mdx @@ -0,0 +1,14 @@ +--- +title: "How can I configure the name of the run in my training code?" +sidebarTitle: "How can I configure the name of the run in my training code?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +At the beginning of the training script, call `wandb.init` with an experiment name. For example: `wandb.init(name="my_awesome_run")`. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..2b470191ad --- /dev/null +++ b/support/models/articles/how-can-i-define-the-local-location-for-.mdx @@ -0,0 +1,18 @@ +--- +title: "How can I define the local location for `wandb` files?" +sidebarTitle: "How can I define the local location for `wandb` files?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +- `WANDB_DIR=` or `wandb.init(dir=)`: Controls the location of the `wandb` folder created for your training script. Defaults to `./wandb`. This folder stores Run's data and logs +- `WANDB_ARTIFACT_DIR=` or `wandb.Artifact().download(root="")`: Controls the location where artifacts are downloaded. Defaults to `./artifacts` +- `WANDB_CACHE_DIR=`: This is the location where artifacts are created and stored when you call `wandb.Artifact`. Defaults to `~/.cache/wandb` +- `WANDB_CONFIG_DIR=`: Where config files are stored. Defaults to `~/.config/wandb` +- `WANDB_DATA_DIR=`: Controls the location used for staging artifacts during upload. Defaults to `~/.cache/wandb-data/`. + +--- + +[Environment Variables](/support/models/tags/environment-variables)[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..4b7ad8e3bd --- /dev/null +++ b/support/models/articles/how-can-i-delete-multiple-runs-in-bulk-i.mdx @@ -0,0 +1,24 @@ +--- +title: "How can I delete multiple runs in bulk instead of one at a time?" +sidebarTitle: "How can I delete multiple runs in bulk instead of one at a time?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Use the [public API](/models/ref/python/public-api/api) to delete multiple runs in a single operation: + +```python +import wandb + +api = wandb.Api() +runs = api.runs('/') +for run in runs: + if : + run.delete() +``` + +--- + +[Projects](/support/models/tags/projects)[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..728332d912 --- /dev/null +++ b/support/models/articles/how-can-i-delete-my-user-account.mdx @@ -0,0 +1,14 @@ +--- +title: "How can I delete my user account?" +sidebarTitle: "How can I delete my user account?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Delete your user account by clicking **Delete account** in your [user settings](/platform/app/settings-page/user-settings#delete-your-account). Note that this action is irreversible and it takes effect immediately. + +--- + +[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..5ec3e6a1e0 --- /dev/null +++ b/support/models/articles/how-can-i-disable-logging-of-system-metr.mdx @@ -0,0 +1,18 @@ +--- +title: "How can I disable logging of system metrics to W&B?" +sidebarTitle: "How can I disable logging of system metrics to W&B?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To disable logging of [system metrics](/models/ref/python/experiments/system-metrics), set `_disable_stats` to `True`: + +```python +wandb.init(settings=wandb.Settings(x_disable_stats=True)) +``` + +--- + +[Metrics](/support/models/tags/metrics)[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..3b53b71f71 --- /dev/null +++ b/support/models/articles/how-can-i-fetch-these-version-ids-and-et.mdx @@ -0,0 +1,21 @@ +--- +title: "How can I fetch these Version IDs and ETags in W&B?" +sidebarTitle: "How can I fetch these Version IDs and ETags in W&B?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If an artifact reference is logged with W&B and versioning is enabled on the buckets, the version IDs appear in the Amazon S3 UI. To retrieve these version IDs and ETags in W&B, fetch the artifact and access the corresponding manifest entries. For example: + +```python +artifact = run.use_artifact("my_table:latest") +for entry in artifact.manifest.entries.values(): + versionID = entry.extra.get("versionID") + etag = entry.extra.get("etag") +``` + +--- + +[Artifacts](/support/models/tags/artifacts) \ No newline at end of file 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 new file mode 100644 index 0000000000..a820e16410 --- /dev/null +++ b/support/models/articles/how-can-i-find-the-artifacts-logged-or-c.mdx @@ -0,0 +1,57 @@ +--- +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?" +sidebarTitle: "How can I find the artifacts logged or consumed by a run? How can I find the runs that produced or consumed an artifact?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +W&B tracks artifacts logged by each run and those used by each run to construct an artifact graph. This graph is a bipartite, directed, acyclic graph with nodes representing runs and artifacts. An example can be viewed [here](https://wandb.ai/shawn/detectron2-11/artifacts/dataset/furniture-small-val/06d5ddd4deeb2a6ebdd5/graph) (click "Explode" to expand the graph). + +Use the Public API to navigate the graph programmatically, starting from either an artifact or a run. + + + + +```python +api = wandb.Api() + +artifact = api.artifact("project/artifact:alias") + +# Walk up the graph from an artifact: +producer_run = artifact.logged_by() +# Walk down the graph from an artifact: +consumer_runs = artifact.used_by() + +# Walk down the graph from a run: +next_artifacts = consumer_runs[0].logged_artifacts() +# Walk up the graph from a run: +previous_artifacts = producer_run.used_artifacts() +``` + + + + +```python +api = wandb.Api() + +run = api.run("entity/project/run_id") + +# Walk down the graph from a run: +produced_artifacts = run.logged_artifacts() +# Walk up the graph from a run: +consumed_artifacts = run.used_artifacts() + +# Walk up the graph from an artifact: +earlier_run = consumed_artifacts[0].logged_by() +# Walk down the graph from an artifact: +consumer_runs = produced_artifacts[0].used_by() +``` + + + + +--- + +[Artifacts](/support/models/tags/artifacts) \ No newline at end of file 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 new file mode 100644 index 0000000000..bcc78b2490 --- /dev/null +++ b/support/models/articles/how-can-i-fix-an-error-like-attributeerr.mdx @@ -0,0 +1,18 @@ +--- +title: "How can I fix an error like `AttributeError: module 'wandb' has no attribute ...`?" +sidebarTitle: "How can I fix an error like `AttributeError: module 'wandb' has no attribute ...`?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If you encounter an error like `AttributeError: module 'wandb' has no attribute 'init'` or `AttributeError: module 'wandb' has no attribute 'login'` when importing `wandb` in Python, `wandb` is not installed or the installation is corrupted, but a `wandb` directory exists in the current working directory. To fix this error, uninstall `wandb`, delete the directory, then install `wandb`: + +```bash +pip uninstall wandb; rm -rI wandb; pip install wandb +``` + +--- + +[Crashing And Hanging Runs](/support/models/tags/crashing-and-hanging-runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..73be1bd42d --- /dev/null +++ b/support/models/articles/how-can-i-log-a-metric-that-doesnt-chang.mdx @@ -0,0 +1,14 @@ +--- +title: "How can I log a metric that doesn't change over time such as a final evaluation accuracy?" +sidebarTitle: "How can I log a metric that doesn't change over time such as a final evaluation accuracy?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Using `run.log({'final_accuracy': 0.9})` updates the final accuracy correctly. By default, `run.log({'final_accuracy': })` updates `run.settings['final_accuracy']`, which reflects the value in the runs table. + +--- + +[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..ac1b8b3bcc --- /dev/null +++ b/support/models/articles/how-can-i-log-additional-metrics-after-a.mdx @@ -0,0 +1,18 @@ +--- +title: "How can I log additional metrics after a run completes?" +sidebarTitle: "How can I log additional metrics after a run completes?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +There are several ways to manage experiments. + +For complex workflows, use multiple runs and set the group parameters in [`wandb.init()`](/models/track/create-an-experiment) to a unique value for all processes within a single experiment. The [**Runs** tab](/models/track/project-page#runs-tab) will group the table by group ID, ensuring that visualizations function properly. This approach enables concurrent experiments and training runs while logging results in one location. + +For simpler workflows, call `wandb.init()` with `resume=True` and `id=UNIQUE_ID`, then call `wandb.init()` again with the same `id=UNIQUE_ID`. Log normally with [`run.log()`](/models/track/log/) or `run.summary()`, and the run values will update accordingly. + +--- + +[Runs](/support/models/tags/runs)[Metrics](/support/models/tags/metrics) \ No newline at end of file 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 new file mode 100644 index 0000000000..9e1f543e82 --- /dev/null +++ b/support/models/articles/how-can-i-log-in-to-wb-server.mdx @@ -0,0 +1,17 @@ +--- +title: "How can I log in to W&B Server?" +sidebarTitle: "How can I log in to W&B Server?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Set the login URL by either of these methods: + +- Set the [environment variable](/models/track/environment-variables) `WANDB_BASE_URL` to the Server URL. +- Set the `--host` flag of [`wandb login`](/models/ref/cli/wandb-login) to the Server URL. + +--- + +[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..8f78c40a94 --- /dev/null +++ b/support/models/articles/how-can-i-organize-my-logged-charts-and-.mdx @@ -0,0 +1,25 @@ +--- +title: "How can I organize my logged charts and media in the W&B UI?" +sidebarTitle: "How can I organize my logged charts and media in the W&B UI?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The `/` character separates logged panels in the W&B UI. By default, the segment of the logged item's name before the `/` defines a group of panels known as a "Panel Section." + +```python +import wandb + +with wandb.init() as run: + + run.log({"val/loss": 1.1, "val/acc": 0.3}) + run.log({"train/loss": 0.1, "train/acc": 0.94}) +``` + +In the [Workspace](/models/track/project-page#workspace-tab) settings, adjust the grouping of panels based on either the first segment or all segments separated by `/`. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..82f88b0312 --- /dev/null +++ b/support/models/articles/how-can-i-overwrite-the-logs-from-previo.mdx @@ -0,0 +1,14 @@ +--- +title: "How can I overwrite the logs from previous steps?" +sidebarTitle: "How can I overwrite the logs from previous steps?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To overwrite logs from previous steps, use [forking](/models/runs/forking) and [rewind](/models/runs/rewind). + +--- + +[Logs](/support/models/tags/logs)[Metrics](/support/models/tags/metrics) \ No newline at end of file diff --git a/support/models/articles/how-can-i-recover-deleted-runs.mdx b/support/models/articles/how-can-i-recover-deleted-runs.mdx new file mode 100644 index 0000000000..760c5309f1 --- /dev/null +++ b/support/models/articles/how-can-i-recover-deleted-runs.mdx @@ -0,0 +1,22 @@ +--- +title: "How can I recover deleted runs?" +sidebarTitle: "How can I recover deleted runs?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To recover deleted runs, complete the following steps: + +- Navigate to the Project Overview page. +- Click the three dots in the top right corner. +- Select **Undelete recently deleted runs**. + +**Notes**: +- You can only restore runs deleted within the last 7 days. +- You can manually upload logs using the W&B API if undelete is not an option. + +--- + +[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..6bebd6a773 --- /dev/null +++ b/support/models/articles/how-can-i-regain-access-to-my-account-if.mdx @@ -0,0 +1,19 @@ +--- +title: "How can I regain access to my account if I cannot receive a password reset email?" +sidebarTitle: "How can I regain access to my account if I cannot receive a password reset email?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To regain access to an account when unable to receive a password reset email: + +1. **Check Spam or Junk Folders:** Ensure the email is not filtered there. +2. **Verify Email:** Confirm the correct email associated with the account. +3. **Check for SSO Options:** Use services like "Sign in with Google" if available. +4. **Contact Support:** If issues persist, reach out to support (support@wandb.com) and provide your username and email for assistance. + +--- + +[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..cdd8dcd6cf --- /dev/null +++ b/support/models/articles/how-can-i-remove-projects-from-a-team-sp.mdx @@ -0,0 +1,19 @@ +--- +title: "How can I remove projects from a team space without admin privileges?" +sidebarTitle: "How can I remove projects from a team space without admin privileges?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To remove projects from a team space without admin privileges, follow these options: + +- Request that a current admin remove the projects. +- Ask the admin to grant temporary access for project management. + +If unable to contact the admin, reach out to a billing admin or another authorized user in your organization for assistance. + +--- + +[Administrator](/support/models/tags/administrator) \ No newline at end of file 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 new file mode 100644 index 0000000000..fd51675e91 --- /dev/null +++ b/support/models/articles/how-can-i-resolve-login-issues-with-my-a.mdx @@ -0,0 +1,26 @@ +--- +title: "How can I resolve login issues with my account?" +sidebarTitle: "How can I resolve login issues with my account?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To resolve login issues, follow these steps: + +- **Verify access**: Confirm you are using the correct email or username and check membership in relevant teams or projects. +- **Browser troubleshooting**: + - Use an incognito window to avoid cached data interference. + - Clear the browser cache. + - Attempt to log in from a different browser or device. +- **SSO and permissions**: + - Verify the identity provider (IdP) and Single Sign-On (SSO) settings. + - If using SSO, confirm inclusion in the appropriate SSO group. +- **Technical problems**: + - Take note of specific error messages for further troubleshooting. + - Contact the support team for additional assistance if issues persist. + +--- + +[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..eda4e4460a --- /dev/null +++ b/support/models/articles/how-can-i-resolve-the-filestream-rate-li.mdx @@ -0,0 +1,24 @@ +--- +title: "How can I resolve the Filestream rate limit exceeded error?" +sidebarTitle: "How can I resolve the Filestream rate limit exceeded error?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To resolve the "Filestream rate limit exceeded" error in W&B, follow these steps: + +**Optimize logging**: + - Reduce logging frequency or batch logs to decrease API requests. + - Stagger experiment start times to avoid simultaneous API requests. + +**Check for outages**: + - Verify that the issue does not arise from a temporary server-side problem by checking [W&B status updates](https://status.wandb.com). + +**Contact support**: + - Reach out to W&B support (support@wandb.com) with details of the experimental setup to request an increase in rate limits. + +--- + +[Connectivity](/support/models/tags/connectivity)[Outage](/support/models/tags/outage) \ No newline at end of file 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 new file mode 100644 index 0000000000..734c6f563e --- /dev/null +++ b/support/models/articles/how-can-i-resume-a-sweep-using-python-co.mdx @@ -0,0 +1,26 @@ +--- +title: "How can I resume a sweep using Python code?" +sidebarTitle: "How can I resume a sweep using Python code?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To resume a sweep, pass the `sweep_id` to the `wandb.agent()` function. + +```python +import wandb + +sweep_id = "your_sweep_id" + +def train(): + # Training code here + pass + +wandb.agent(sweep_id=sweep_id, function=train) +``` + +--- + +[Sweeps](/support/models/tags/sweeps)[Python](/support/models/tags/python) \ No newline at end of file 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 new file mode 100644 index 0000000000..9146211042 --- /dev/null +++ b/support/models/articles/how-can-i-rotate-or-revoke-access.mdx @@ -0,0 +1,14 @@ +--- +title: "How can I rotate or revoke access?" +sidebarTitle: "How can I rotate or revoke access?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Personal and service account keys can be rotated or revoked. Create a new API key or service account user, then reconfigure scripts to use the new key. After reconfiguration, remove the old API key from your profile or team. + +--- + +[Administrator](/support/models/tags/administrator)[Security](/support/models/tags/security) \ No newline at end of file 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 new file mode 100644 index 0000000000..77c348d586 --- /dev/null +++ b/support/models/articles/how-can-i-save-the-git-commit-associated.mdx @@ -0,0 +1,16 @@ +--- +title: "How can I save the git commit associated with my run?" +sidebarTitle: "How can I save the git commit associated with my run?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +When `wandb.init` is invoked, the system automatically collects git information, including the remote repository link and the SHA of the latest commit. This information appears on the [run page](/models/runs/#view-logged-runs). Ensure the current working directory when executing the script is within a git-managed folder to view this information. + +The git commit and the command used to run the experiment remain visible to the user but are hidden from external users. In public projects, these details remain private. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..a0667419c5 --- /dev/null +++ b/support/models/articles/how-can-i-see-files-that-do-not-appear-i.mdx @@ -0,0 +1,26 @@ +--- +title: "How can I see files that do not appear in the Files tab?" +sidebarTitle: "How can I see files that do not appear in the Files tab?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The Files tab shows a maximum of 10,000 files. To download all files, use the [public API](/models/ref/python/public-api/api): + +```python +import wandb + +api = wandb.Api() +run = api.run('//') +run.file('').download() + +for f in run.files(): + if : + f.download() +``` + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..c2776fe190 --- /dev/null +++ b/support/models/articles/how-can-i-see-the-bytes-stored-bytes-tra.mdx @@ -0,0 +1,20 @@ +--- +title: "How can I see the bytes stored, bytes tracked and tracked hours of my organization?" +sidebarTitle: "How can I see the bytes stored, bytes tracked and tracked hours of my organization?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +View the bytes stored, bytes tracked, and tracked hours for your organization within organization settings: + +1. Navigate to your organization's settings at `https://wandb.ai/account-settings//settings`. +2. Select the **Billing** tab. +3. Within the **Usage this billing period** section, select **View usage** button. + +Ensure to replace values enclosed in `<>` with your organization's name. + +--- + +[Administrator](/support/models/tags/administrator) \ No newline at end of file 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 new file mode 100644 index 0000000000..b660c123be --- /dev/null +++ b/support/models/articles/how-can-i-send-run-alerts-to-microsoft-t.mdx @@ -0,0 +1,17 @@ +--- +title: "How can I send run alerts to Microsoft Teams?" +sidebarTitle: "How can I send run alerts to Microsoft Teams?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To receive W&B alerts in Teams, follow these steps: + +- **Set up an email address for your Teams channel.** Create an email address for the Teams channel where you want to receive alerts. +- **Forward W&B alert emails to the Teams channel's email address.** Configure W&B to send alerts via email, then forward these emails to your Teams channel's email. + +--- + +[Alerts](/support/models/tags/alerts) \ No newline at end of file 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 new file mode 100644 index 0000000000..1f241399c2 --- /dev/null +++ b/support/models/articles/how-can-i-use-wandb-with-multiprocessing.mdx @@ -0,0 +1,23 @@ +--- +title: "How can I use wandb with multiprocessing, e.g. distributed training?" +sidebarTitle: "How can I use wandb with multiprocessing, e.g. distributed training?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If a training program uses multiple processes, structure the program to avoid making wandb method calls from processes without `wandb.init()`. + +Manage multiprocess training using these approaches: + +1. Call `wandb.init` in all processes and use the [group](/models/runs/grouping) keyword argument to create a shared group. Each process will have its own wandb run, and the UI will group the training processes together. +2. Call `wandb.init` from only one process and pass data to log through [multiprocessing queues](https://docs.python.org/3/library/multiprocessing.html#exchanging-objects-between-processes). + + +Refer to the [Distributed Training Guide](/models/track/log/distributed-training) for detailed explanations of these approaches, including code examples with Torch DDP. + + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..b407bdc48c --- /dev/null +++ b/support/models/articles/how-do-i-add-plotly-or-bokeh-charts-into.mdx @@ -0,0 +1,82 @@ +--- +title: "How do I add Plotly or Bokeh Charts into Tables?" +sidebarTitle: "How do I add Plotly or Bokeh Charts into Tables?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Direct integration of Plotly or Bokeh figures into tables is not supported. Instead, export the figures to HTML and include the HTML in the table. Below are examples demonstrating this with interactive Plotly and Bokeh charts. + + + +```python +import wandb +import plotly.express as px + +# Initialize a new run +with wandb.init(project="log-plotly-fig-tables", name="plotly_html") as run: + + # Create a table + table = wandb.Table(columns=["plotly_figure"]) + + # Define path for Plotly figure + path_to_plotly_html = "./plotly_figure.html" + + # Create a Plotly figure + fig = px.scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16]) + + # Export Plotly figure to HTML + # Setting auto_play to False prevents animated Plotly charts from playing automatically + fig.write_html(path_to_plotly_html, auto_play=False) + + # Add Plotly figure as HTML file to the table + table.add_data(wandb.Html(path_to_plotly_html)) + + # Log Table + run.log({"test_table": table}) + +``` + + +```python +from scipy.signal import spectrogram +import holoviews as hv +import panel as pn +from scipy.io import wavfile +import numpy as np +from bokeh.resources import INLINE + +hv.extension("bokeh", logo=False) +import wandb + +def save_audio_with_bokeh_plot_to_html(audio_path, html_file_name): + sr, wav_data = wavfile.read(audio_path) + duration = len(wav_data) / sr + f, t, sxx = spectrogram(wav_data, sr) + spec_gram = hv.Image((t, f, np.log10(sxx)), ["Time (s)", "Frequency (Hz)"]).opts( + width=500, height=150, labelled=[] + ) + audio = pn.pane.Audio(wav_data, sample_rate=sr, name="Audio", throttle=500) + slider = pn.widgets.FloatSlider(end=duration, visible=False) + line = hv.VLine(0).opts(color="white") + slider.jslink(audio, value="time", bidirectional=True) + slider.jslink(line, value="glyph.location") + combined = pn.Row(audio, spec_gram * line, slider).save(html_file_name) + +html_file_name = "audio_with_plot.html" +audio_path = "hello.wav" +save_audio_with_bokeh_plot_to_html(audio_path, html_file_name) + +wandb_html = wandb.Html(html_file_name) +with wandb.init(project="audio_test") as run: + my_table = wandb.Table(columns=["audio_with_plot"], data=[[wandb_html], [wandb_html]]) + run.log({"audio_table": my_table}) +``` + + + +--- + +[Experiments](/support/models/tags/experiments)[Tables](/support/models/tags/tables)[Charts](/support/models/tags/charts) \ No newline at end of file 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 new file mode 100644 index 0000000000..9f8c83ed95 --- /dev/null +++ b/support/models/articles/how-do-i-best-log-models-from-runs-in-a-.mdx @@ -0,0 +1,18 @@ +--- +title: "How do I best log models from runs in a sweep?" +sidebarTitle: "How do I best log models from runs in a sweep?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +One effective approach for logging models in a [sweep](/models/sweeps/) involves creating a model artifact for the sweep. Each version represents a different run from the sweep. Implement it as follows: + +```python +wandb.Artifact(name="sweep_name", type="model") +``` + +--- + +[Artifacts](/support/models/tags/artifacts)[Sweeps](/support/models/tags/sweeps) \ No newline at end of file diff --git a/support/models/articles/how-do-i-cancel-my-subscription.mdx b/support/models/articles/how-do-i-cancel-my-subscription.mdx new file mode 100644 index 0000000000..816e2deb3c --- /dev/null +++ b/support/models/articles/how-do-i-cancel-my-subscription.mdx @@ -0,0 +1,15 @@ +--- +title: "How do I cancel my subscription?" +sidebarTitle: "How do I cancel my subscription?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +- Contact the support team (support@wandb.com). +- Provide the organization name, email associated with the account, and username. + +--- + +[Administrator](/support/models/tags/administrator) \ No newline at end of file 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 new file mode 100644 index 0000000000..7ea2f4302f --- /dev/null +++ b/support/models/articles/how-do-i-change-my-billing-address.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I change my billing address?" +sidebarTitle: "How do I change my billing address?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To change the billing address, contact the support team (support@wandb.com). + +--- + +[Administrator](/support/models/tags/administrator)[Billing](/support/models/tags/billing) \ No newline at end of file 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 new file mode 100644 index 0000000000..f21b1bbd24 --- /dev/null +++ b/support/models/articles/how-do-i-deal-with-network-issues.mdx @@ -0,0 +1,22 @@ +--- +title: "How do I deal with network issues?" +sidebarTitle: "How do I deal with network issues?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If you encounter SSL or network errors, such as `wandb: Network error (ConnectionError), entering retry loop`, use the following solutions: + +1. Upgrade the SSL certificate. On an Ubuntu server, run `update-ca-certificates`. A valid SSL certificate is essential for syncing training logs to mitigate security risks. +2. If the network connection is unstable, operate in offline mode by setting the [optional environment variable](/models/track/environment-variables#optional-environment-variables) `WANDB_MODE` to `offline`, and sync files later from a device with Internet access. +3. Consider using [W&B Private Hosting](/platform/hosting/), which runs locally and avoids syncing to cloud servers. + +For the `SSL CERTIFICATE_VERIFY_FAILED` error, this issue might stem from a company firewall. Configure local CAs and execute: + +`export REQUESTS_CA_BUNDLE=/etc/ssl/certs/ca-certificates.crt` + +--- + +[Connectivity](/support/models/tags/connectivity) \ No newline at end of file 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 new file mode 100644 index 0000000000..d80459620a --- /dev/null +++ b/support/models/articles/how-do-i-delete-a-panel-grid.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I delete a panel grid?" +sidebarTitle: "How do I delete a panel grid?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Select the panel grid and press delete or backspace. Click the drag handle in the top-right corner to select the panel grid. + +--- + +[Reports](/support/models/tags/reports)[Wysiwyg](/support/models/tags/wysiwyg) \ No newline at end of file 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 new file mode 100644 index 0000000000..d6d9c6649d --- /dev/null +++ b/support/models/articles/how-do-i-delete-a-team-from-my-account.mdx @@ -0,0 +1,17 @@ +--- +title: "How do I delete a team from my account?" +sidebarTitle: "How do I delete a team from my account?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To delete a team from an account: + +- Access team settings as an admin. +- Click the **Delete** button at the bottom of the page. + +--- + +[Administrator](/support/models/tags/administrator)[Team Management](/support/models/tags/team-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..a77e596985 --- /dev/null +++ b/support/models/articles/how-do-i-delete-my-organization-account.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I delete my organization account?" +sidebarTitle: "How do I delete my organization account?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To delete an organization account, follow these steps, contact the support team (support@wandb.com). + +--- + +[Administrator](/support/models/tags/administrator) \ No newline at end of file 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 new file mode 100644 index 0000000000..53ab760fa7 --- /dev/null +++ b/support/models/articles/how-do-i-downgrade-my-subscription-plan.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I downgrade my subscription plan?" +sidebarTitle: "How do I downgrade my subscription plan?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To downgrade a subscription plan, contact the support team at support@wandb.com with your current plan details and the desired plan. + +--- + +[Billing](/support/models/tags/billing)[Administrator](/support/models/tags/administrator) \ No newline at end of file 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 new file mode 100644 index 0000000000..c6cee2f6e2 --- /dev/null +++ b/support/models/articles/how-do-i-enable-code-logging-with-sweeps.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I enable code logging with Sweeps?" +sidebarTitle: "How do I enable code logging with Sweeps?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To enable code logging for sweeps, add `wandb.log_code()` after initializing the W&B Run. This action is necessary even when code logging is enabled in the W&B profile settings. For advanced code logging, refer to the [docs for `wandb.log_code()` here](/models/ref/python/experiments/run#log_code). + +--- + +[Sweeps](/support/models/tags/sweeps) \ No newline at end of file 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 new file mode 100644 index 0000000000..68fb7dba52 --- /dev/null +++ b/support/models/articles/how-do-i-export-a-list-of-users-from-my-.mdx @@ -0,0 +1,39 @@ +--- +title: "How do I export a list of users from my W&B Organisation?" +sidebarTitle: "How do I export a list of users from my W&B Organisation?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To export a list of users from a W&B organization, an admin uses the SCIM API with the following code: + +```python +import base64 +import requests + +def encode_base64(username, key): + auth_string = f'{username}:{key}' + return base64.b64encode(auth_string.encode('utf-8')).decode('utf-8') + +username = '' # Organization admin username +key = '' # API key +scim_base_url = 'https://api.wandb.ai/scim/v2' +users_endpoint = f'{scim_base_url}/Users' +headers = { + 'Authorization': f'Basic {encode_base64(username, key)}', + 'Content-Type': 'application/scim+json' +} + +response = requests.get(users_endpoint, headers=headers) +users = [] +for user in response.json()['Resources']: + users.append([user['userName'], user['emails']['Value']]) +``` + +Modify the script to save the output as needed. + +--- + +[Administrator](/support/models/tags/administrator)[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..174d221ce8 --- /dev/null +++ b/support/models/articles/how-do-i-find-an-artifact-from-the-best-.mdx @@ -0,0 +1,24 @@ +--- +title: "How do I find an artifact from the best run in a sweep?" +sidebarTitle: "How do I find an artifact from the best run in a sweep?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To retrieve artifacts from the best performing run in a sweep, use the following code: + +```python +api = wandb.Api() +sweep = api.sweep("entity/project/sweep_id") +runs = sorted(sweep.runs, key=lambda run: run.summary.get("val_acc", 0), reverse=True) +best_run = runs[0] +for artifact in best_run.logged_artifacts(): + artifact_path = artifact.download() + print(artifact_path) +``` + +--- + +[Artifacts](/support/models/tags/artifacts) \ No newline at end of file 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 new file mode 100644 index 0000000000..47c6201ec9 --- /dev/null +++ b/support/models/articles/how-do-i-find-my-api-key.mdx @@ -0,0 +1,16 @@ +--- +title: "How do I find my API key?" +sidebarTitle: "How do I find my API key?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +import ApiKeyFind from "/snippets/en/_includes/api-key-find.mdx"; + + + +--- + +[Security](/support/models/tags/security)[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..a026e94a15 --- /dev/null +++ b/support/models/articles/how-do-i-fix-invalid-authentication-401-.mdx @@ -0,0 +1,52 @@ +--- +title: "How do I fix Invalid Authentication (401) errors with W&B Inference?" +sidebarTitle: "How do I fix Invalid Authentication (401) errors with W&B Inference?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A 401 Invalid Authentication error means your API key is invalid or your W&B project entity/name is incorrect. + +## Verify your API key + +1. Create a new API key at [User Settings](https://wandb.ai/settings). +2. Store your API key securely. + +## Check your project configuration + +Ensure your project is formatted correctly as `/`: + +**Python example:** +```python +client = openai.OpenAI( + base_url='https://api.inference.wandb.ai/v1', + api_key="", + project="/", # Must match your W&B team and project +) +``` + +**Bash example:** +```bash +curl https://api.inference.wandb.ai/v1/chat/completions \ + -H "Authorization: Bearer " \ + -H "OpenAI-Project: /" +``` + +## Common mistakes + +- Using personal entity instead of team name +- Misspelling team or project name +- Missing forward slash between team and project +- Using an expired or deleted API key + +## Still having issues? + +- Verify the team and project exist in your W&B account +- Ensure you have access to the specified team +- Try creating a new API key if the current one isn't working + +--- + +[Inference](/support/models/tags/inference) \ No newline at end of file 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 new file mode 100644 index 0000000000..13cb3ba0b3 --- /dev/null +++ b/support/models/articles/how-do-i-fix-server-errors-500-503-with-.mdx @@ -0,0 +1,72 @@ +--- +title: "How do I fix server errors (500, 503) with W&B Inference?" +sidebarTitle: "How do I fix server errors (500, 503) with W&B Inference?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Server errors indicate temporary issues with the W&B Inference service. + +## Error types + +### 500 - Internal Server Error +**Message:** "The server had an error while processing your request" + +This is a temporary internal error on the server side. + +### 503 - Service Overloaded +**Message:** "The engine is currently overloaded, please try again later" + +The service is experiencing high traffic. + +## How to handle server errors + +1. **Wait before retrying** + - 500 errors: Wait 30-60 seconds + - 503 errors: Wait 60-120 seconds + +2. **Use exponential backoff** + ```python + import time + import openai + + def call_with_retry(client, messages, model, max_retries=5): + for attempt in range(max_retries): + try: + return client.chat.completions.create( + model=model, + messages=messages + ) + except Exception as e: + if "500" in str(e) or "503" in str(e): + if attempt < max_retries - 1: + wait_time = min(60, (2 ** attempt)) + time.sleep(wait_time) + else: + raise + else: + raise + ``` + +3. **Set appropriate timeouts** + - Increase timeout values for your HTTP client + - Consider async operations for better handling + +## When to contact support + +Contact support if: +- Errors persist for more than 10 minutes +- You see patterns of failures at specific times +- Error messages contain additional details + +Provide: +- Error messages and codes +- Time when errors occurred +- Your code snippet (remove API keys) +- W&B entity and project names + +--- + +[Inference](/support/models/tags/inference) \ No newline at end of file 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 new file mode 100644 index 0000000000..349890f0c5 --- /dev/null +++ b/support/models/articles/how-do-i-fix-the-error-resumemust-but-ru.mdx @@ -0,0 +1,20 @@ +--- +title: "How do I fix the error `resume='must' but run () doesn't exist`?" +sidebarTitle: "How do I fix the error `resume='must' but run () doesn't exist`?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If you encounter the error `resume='must' but run () doesn't exist`, the run you are attempting to resume does not exist within the project or entity. Ensure that you are logged in to the correct instance and that the project and entity are set: + +```python +wandb.init(entity=, project=, id=, resume='must') +``` + +Run [`wandb login --relogin`](/models/ref/cli/wandb-login) to verify that you are authenticated. + +--- + +[Resuming](/support/models/tags/resuming)[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..d1deab86a0 --- /dev/null +++ b/support/models/articles/how-do-i-fix-the-overflows-maximum-value.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I fix the 'overflows maximum values of a signed 64 bits integer' error?" +sidebarTitle: "How do I fix the 'overflows maximum values of a signed 64 bits integer' error?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To resolve this error, add `?workspace=clear` to the end of the URL and press Enter. This action directs you to a cleared version of the project page workspace. + +--- + +[Workspaces](/support/models/tags/workspaces) \ No newline at end of file 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 new file mode 100644 index 0000000000..c1643d928e --- /dev/null +++ b/support/models/articles/how-do-i-get-added-to-a-team-on-wb.mdx @@ -0,0 +1,17 @@ +--- +title: "How do I get added to a team on W&B?" +sidebarTitle: "How do I get added to a team on W&B?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To join a team, follow these steps: + +- Contact a team admin or someone with administrative privileges to request an invite. +- Check your email for the invitation, and follow the instructions to join the team. + +--- + +[Administrator](/support/models/tags/administrator)[Team Management](/support/models/tags/team-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..7a5e4974f6 --- /dev/null +++ b/support/models/articles/how-do-i-get-the-random-run-name-in-my-s.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I get the random run name in my script?" +sidebarTitle: "How do I get the random run name in my script?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Call a run object's `.save()` method to save the current run. Retrieve the name using the run object's `name` attribute. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..f4b42fb2f6 --- /dev/null +++ b/support/models/articles/how-do-i-handle-the-failed-to-query-for-.mdx @@ -0,0 +1,29 @@ +--- +title: "How do I handle the 'Failed to query for notebook' error?" +sidebarTitle: "How do I handle the 'Failed to query for notebook' error?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If you encounter the error message `"Failed to query for notebook name, you can set it manually with the WANDB_NOTEBOOK_NAME environment variable,"` resolve it by setting the environment variable. Multiple methods accomplish this: + + + +```python +%env "WANDB_NOTEBOOK_NAME" "notebook name here" +``` + + +```python +import os + +os.environ["WANDB_NOTEBOOK_NAME"] = "notebook name here" +``` + + + +--- + +[Notebooks](/support/models/tags/notebooks)[Environment Variables](/support/models/tags/environment-variables) \ No newline at end of file diff --git a/support/models/articles/how-do-i-insert-a-table.mdx b/support/models/articles/how-do-i-insert-a-table.mdx new file mode 100644 index 0000000000..ef29915005 --- /dev/null +++ b/support/models/articles/how-do-i-insert-a-table.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I insert a table?" +sidebarTitle: "How do I insert a table?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Tables remain the only feature from Markdown without a direct WYSIWYG equivalent. To add a table, insert a Markdown block and create the table inside it. + +--- + +[Reports](/support/models/tags/reports)[Wysiwyg](/support/models/tags/wysiwyg)[Tables](/support/models/tags/tables) \ No newline at end of file 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 new file mode 100644 index 0000000000..39db180dc3 --- /dev/null +++ b/support/models/articles/how-do-i-install-the-wandb-python-librar.mdx @@ -0,0 +1,30 @@ +--- +title: "How do I install the wandb Python library in environments without gcc?" +sidebarTitle: "How do I install the wandb Python library in environments without gcc?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If an error occurs when installing `wandb` that states: + +``` +unable to execute 'gcc': No such file or directory +error: command 'gcc' failed with exit status 1 +``` + +Install `psutil` directly from a pre-built wheel. Determine your Python version and operating system at [https://pywharf.github.io/pywharf-pkg-repo/psutil](https://pywharf.github.io/pywharf-pkg-repo/psutil). + +For example, to install `psutil` on Python 3.8 in Linux: + +```bash +WHEEL_URL=https://github.com/pywharf/pywharf-pkg-repo/releases/download/psutil-5.7.0-cp38-cp38-manylinux2010_x86_64.whl#sha256=adc36dabdff0b9a4c84821ef5ce45848f30b8a01a1d5806316e068b5fd669c6d +pip install $WHEEL_URL +``` + +After installing `psutil`, run `pip install wandb` to complete the installation of `wandb`. + +--- + +[Python](/support/models/tags/python) \ No newline at end of file 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 new file mode 100644 index 0000000000..f8e0c8f45c --- /dev/null +++ b/support/models/articles/how-do-i-kill-a-job-with-wandb.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I kill a job with wandb?" +sidebarTitle: "How do I kill a job with wandb?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Press `Ctrl+D` on the keyboard to stop a script instrumented with W&B. + +--- + +[Crashing And Hanging Runs](/support/models/tags/crashing-and-hanging-runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..b32f23de33 --- /dev/null +++ b/support/models/articles/how-do-i-launch-multiple-runs-from-one-s.mdx @@ -0,0 +1,69 @@ +--- +title: "How do I launch multiple runs from one script?" +sidebarTitle: "How do I launch multiple runs from one script?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Finish previous runs before starting new runs to log multiple runs within +a single script. + +The recommended way to do this is by using `wandb.init()` as a context manager +because this finishes the run and marks it as failed if your script raises an +exception: + +```python +import wandb + +for x in range(10): + with wandb.init() as run: + for y in range(100): + run.log({"metric": x + y}) +``` + +You can also call `run.finish()` explicitly: + +```python +import wandb + +for x in range(10): + run = wandb.init() + + try: + for y in range(100): + run.log({"metric": x + y}) + + except Exception: + run.finish(exit_code=1) + raise + + finally: + run.finish() +``` + +## Multiple active runs + +Starting with wandb 0.19.10, you can set the `reinit` setting to `"create_new"` +to create multiple simultaneously active runs. + +```python +import wandb + +with wandb.init(reinit="create_new") as tracking_run: + for x in range(10): + with wandb.init(reinit="create_new") as run: + for y in range(100): + run.log({"x_plus_y": x + y}) + + tracking_run.log({"x": x}) +``` + +See [Multiple runs per process](/models/runs/initialize-run) +for more information about `reinit="create_new"`, including caveats about W&B +integrations. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..4078898ebd --- /dev/null +++ b/support/models/articles/how-do-i-log-a-list-of-values.mdx @@ -0,0 +1,42 @@ +--- +title: "How do I log a list of values?" +sidebarTitle: "How do I log a list of values?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +These examples show logging losses a couple of different ways using [`wandb.Run.log()`](/models/ref/python/experiments/run/#method-runlog/). + + + +```python +import wandb + +# Initialize a new run +with wandb.init(project="log-list-values", name="log-dict") as run: + # Log losses as a dictionary + losses = [0.1, 0.2, 0.3, 0.4, 0.5] + run.log({"losses": losses}) + run.log({f"losses/loss-{ii}": loss for ii, loss in enumerate(losses)}) +``` + + +```python +import wandb + +# Initialize a new run +with wandb.init(project="log-list-values", name="log-hist") as run: + # Log losses as a histogram + losses = [0.1, 0.2, 0.3, 0.4, 0.5] + run.log({"losses": wandb.Histogram(losses)}) +``` + + + +For more, see [the documentation on logging](/models/track/log/). + +--- + +[Logs](/support/models/tags/logs)[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..ce99636093 --- /dev/null +++ b/support/models/articles/how-do-i-log-an-artifact-to-an-existing-.mdx @@ -0,0 +1,21 @@ +--- +title: "How do I log an artifact to an existing run?" +sidebarTitle: "How do I log an artifact to an existing run?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Occasionally, it is necessary to mark an artifact as the output of a previously logged run. In this case, reinitialize the old run and log new artifacts as follows: + +```python +with wandb.init(id="existing_run_id", resume="allow") as run: + artifact = wandb.Artifact("artifact_name", "artifact_type") + artifact.add_file("my_data/file.txt") + run.log_artifact(artifact) +``` + +--- + +[Artifacts](/support/models/tags/artifacts) \ No newline at end of file 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 new file mode 100644 index 0000000000..54e174ab60 --- /dev/null +++ b/support/models/articles/how-do-i-log-runs-launched-by-continuous.mdx @@ -0,0 +1,18 @@ +--- +title: "How do I log runs launched by continuous integration or internal tools?" +sidebarTitle: "How do I log runs launched by continuous integration or internal tools?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To launch automated tests or internal tools that log to W&B, create a **Service Account** on the team settings page. This action allows the use of a service API key for automated jobs, including those running through continuous integration. To attribute service account jobs to a specific user, set the `WANDB_USERNAME` or `WANDB_USER_EMAIL` environment variables. + + +Creating service account + + +--- + +[Runs](/support/models/tags/runs)[Logs](/support/models/tags/logs) \ No newline at end of file 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 new file mode 100644 index 0000000000..1635e8e4da --- /dev/null +++ b/support/models/articles/how-do-i-log-to-the-right-wandb-user-on-.mdx @@ -0,0 +1,16 @@ +--- +title: "How do I log to the right wandb user on a shared machine?" +sidebarTitle: "How do I log to the right wandb user on a shared machine?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +When using a shared machine, ensure that runs log to the correct WandB account by setting the `WANDB_API_KEY` environment variable for authentication. If sourced in the environment, this variable provides the correct credentials upon login. Alternatively, set the environment variable directly in the script. + +Execute the command `export WANDB_API_KEY=X`, replacing X with your API key. Create an API key at [wandb.ai/settings](https://wandb.ai/settings). + +--- + +[Logs](/support/models/tags/logs) \ No newline at end of file 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 new file mode 100644 index 0000000000..0f567d09a3 --- /dev/null +++ b/support/models/articles/how-do-i-plot-multiple-lines-on-a-plot-w.mdx @@ -0,0 +1,29 @@ +--- +title: "How do I plot multiple lines on a plot with a legend?" +sidebarTitle: "How do I plot multiple lines on a plot with a legend?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Create a multi-line custom chart with `wandb.plot.line_series()`. Navigate to the [project page](/models/track/project-page) to view the line chart. To add a legend, include the `keys` argument in `wandb.plot.line_series()`. For example: + +```python + +with wandb.init(project="my_project") as run: + + run.log( + { + "my_plot": wandb.plot.line_series( + xs=x_data, ys=y_data, keys=["metric_A", "metric_B"] + ) + } + ) +``` + +Refer to additional details about multi-line plots [here](/models/track/log/plots#basic-charts) under the **Multi-line** tab. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..d8b0d06af3 --- /dev/null +++ b/support/models/articles/how-do-i-programmatically-access-the-hum.mdx @@ -0,0 +1,22 @@ +--- +title: "How do I programmatically access the human-readable run name?" +sidebarTitle: "How do I programmatically access the human-readable run name?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The `.name` attribute of a [`wandb.Run`](/models/ref/python/experiments/run) is accessible as follows: + +```python +import wandb + +with wandb.init() as run: + run_name = run.name + print(f"The human-readable run name is: {run_name}") +``` + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file diff --git a/support/models/articles/how-do-i-rename-a-project.mdx b/support/models/articles/how-do-i-rename-a-project.mdx new file mode 100644 index 0000000000..381970df63 --- /dev/null +++ b/support/models/articles/how-do-i-rename-a-project.mdx @@ -0,0 +1,21 @@ +--- +title: "How do I rename a project?" +sidebarTitle: "How do I rename a project?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To rename a project: + +- Navigate to the Project overview. +- Click on **Edit Project**. + +Note: + +- If the project name is protected, such as `model-registry`, it cannot be renamed. Contact support for assistance with protected names. + +--- + +[Projects](/support/models/tags/projects) \ No newline at end of file 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 new file mode 100644 index 0000000000..d6f7fad6a0 --- /dev/null +++ b/support/models/articles/how-do-i-renew-my-expired-license.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I renew my expired license?" +sidebarTitle: "How do I renew my expired license?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To renew an expired license, contact the support team at support@wandb.com for assistance with the renewal process and to receive a new license key. + +--- + +[Administrator](/support/models/tags/administrator) \ No newline at end of file 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 new file mode 100644 index 0000000000..b23706a49a --- /dev/null +++ b/support/models/articles/how-do-i-request-the-complete-deletion-o.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I request the complete deletion of my W&B account?" +sidebarTitle: "How do I request the complete deletion of my W&B account?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To delete a W&B account, navigate to the **User settings** page, scroll to the bottom, and click the **Delete Account** button. + +--- + +[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..db51ee9fb1 --- /dev/null +++ b/support/models/articles/how-do-i-resolve-a-run-initialization-ti.mdx @@ -0,0 +1,26 @@ +--- +title: "How do I resolve a run initialization timeout error in wandb?" +sidebarTitle: "How do I resolve a run initialization timeout error in wandb?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To resolve a run initialization timeout error, follow these steps: + +- **Retry initialization**: Attempt to restart the run. +- **Check network connection**: Confirm a stable internet connection. +- **Update wandb version**: Install the latest version of wandb. +- **Increase timeout settings**: Modify the `WANDB_INIT_TIMEOUT` environment variable: + ```python + import os + os.environ['WANDB_INIT_TIMEOUT'] = '600' + ``` +- **Enable debugging**: Set `WANDB_DEBUG=true` and `WANDB_CORE_DEBUG=true` for detailed logs. +- **Verify configuration**: Check that the API key and project settings are correct. +- **Review logs**: Inspect `debug.log`, `debug-internal.log`, `debug-core.log`, and `output.log` for errors. + +--- + +[Connectivity](/support/models/tags/connectivity)[Crashing And Hanging Runs](/support/models/tags/crashing-and-hanging-runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..e9dc529541 --- /dev/null +++ b/support/models/articles/how-do-i-resolve-permission-errors-when-.mdx @@ -0,0 +1,34 @@ +--- +title: "How do I resolve permission errors when logging a run?" +sidebarTitle: "How do I resolve permission errors when logging a run?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To resolve permission errors when logging a run to a W&B entity, follow these steps: + +- **Verify entity and project names**: Ensure correct spelling and case sensitivity of the W&B entity and project names in your code. +- **Confirm permissions**: Ensure necessary permissions have been granted by the administrator. +- **Check log-in credentials**: Confirm log-in to the correct W&B account. Test by creating a run with the following code: + ```python + import wandb + + run = wandb.init(entity="your_entity", project="your_project") + run.log({'example_metric': 1}) + run.finish() + ``` +- **Set API key**: Use the `WANDB_API_KEY` environment variable: + ```bash + export WANDB_API_KEY='your_api_key' + ``` +- **Confirm host information**: For custom deployments, set the host URL: + ```bash + wandb login --relogin --host= + export WANDB_BASE_URL= + ``` + +--- + +[Runs](/support/models/tags/runs)[Security](/support/models/tags/security) \ No newline at end of file diff --git a/support/models/articles/how-do-i-save-code.mdx b/support/models/articles/how-do-i-save-code.mdx new file mode 100644 index 0000000000..c35d0b1ba7 --- /dev/null +++ b/support/models/articles/how-do-i-save-code.mdx @@ -0,0 +1,20 @@ +--- +title: "How do I save code?‌" +sidebarTitle: "How do I save code?‌" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +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, version the code with Artifacts. The following example demonstrates this process: + +```python +code_artifact = wandb.Artifact(type="code") +code_artifact.add_file("./train.py") +wandb.log_artifact(code_artifact) +``` + +--- + +[Artifacts](/support/models/tags/artifacts) \ No newline at end of file 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 new file mode 100644 index 0000000000..8616ee850c --- /dev/null +++ b/support/models/articles/how-do-i-set-a-retention-or-expiration-p.mdx @@ -0,0 +1,14 @@ +--- +title: "How do I set a retention or expiration policy on my artifact?" +sidebarTitle: "How do I set a retention or expiration policy on my artifact?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To manage artifacts that contain sensitive data or to schedule the deletion of artifact versions, set a TTL (time-to-live) policy. For detailed instructions, refer to the [TTL guide](/models/artifacts/ttl). + +--- + +[Artifacts](/support/models/tags/artifacts) \ No newline at end of file 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 new file mode 100644 index 0000000000..d31a4c75a1 --- /dev/null +++ b/support/models/articles/how-do-i-silence-wb-info-messages.mdx @@ -0,0 +1,44 @@ +--- +title: "How do I silence W&B info messages?" +sidebarTitle: "How do I silence W&B info messages?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To suppress log messages in your notebook such as this: + +``` +INFO SenderThread:11484 [sender.py:finish():979] +``` + +Set the log level to `logging.ERROR` to only show errors, suppressing output of info-level log output. + +```python +import logging + +logger = logging.getLogger("wandb") +logger.setLevel(logging.ERROR) +``` + +To significantly reduce log output, set `WANDB_QUIET` environment variable to `True`. To turn off log output completely, set the `WANDB_SILENT` environment variable to `True`. In a notebook, set `WANDB_QUIET` or `WANDB_SILENT` before running `wandb.login`: + + + +```python +%env WANDB_SILENT=True +``` + + +```python +import os + +os.environ["WANDB_SILENT"] = "True" +``` + + + +--- + +[Notebooks](/support/models/tags/notebooks)[Environment Variables](/support/models/tags/environment-variables) \ No newline at end of file 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 new file mode 100644 index 0000000000..724d5c5107 --- /dev/null +++ b/support/models/articles/how-do-i-stop-wandb-from-writing-to-my-t.mdx @@ -0,0 +1,32 @@ +--- +title: "How do I stop wandb from writing to my terminal or my Jupyter notebook output?" +sidebarTitle: "How do I stop wandb from writing to my terminal or my Jupyter notebook output?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Set the environment variable [`WANDB_SILENT`](/models/track/environment-variables) to `true`. + + + +```python +os.environ["WANDB_SILENT"] = "true" +``` + + +```python +%env WANDB_SILENT=true +``` + + +```shell +WANDB_SILENT=true +``` + + + +--- + +[Environment Variables](/support/models/tags/environment-variables) \ No newline at end of file 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 new file mode 100644 index 0000000000..9b072ca30d --- /dev/null +++ b/support/models/articles/how-do-i-switch-between-accounts-on-the-.mdx @@ -0,0 +1,19 @@ +--- +title: "How do I switch between accounts on the same machine?" +sidebarTitle: "How do I switch between accounts on the same machine?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To manage two W&B accounts from the same machine, store both API keys in a file. Use the following code in your repositories to switch between keys securely, preventing secret keys from being checked into source control. + +```python +if os.path.exists("~/keys.json"): + os.environ["WANDB_API_KEY"] = json.loads("~/keys.json")["work_account"] +``` + +--- + +[Environment Variables](/support/models/tags/environment-variables) \ No newline at end of file diff --git a/support/models/articles/how-do-i-turn-off-logging.mdx b/support/models/articles/how-do-i-turn-off-logging.mdx new file mode 100644 index 0000000000..3c8862c27d --- /dev/null +++ b/support/models/articles/how-do-i-turn-off-logging.mdx @@ -0,0 +1,23 @@ +--- +title: "How do I turn off logging?" +sidebarTitle: "How do I turn off logging?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The command `wandb offline` sets the environment variable `WANDB_MODE=offline`, preventing data from syncing to the remote W&B server. This action affects all projects, stopping the logging of data to W&B servers. + +To suppress warning messages, use the following code: + +```python +import logging + +logger = logging.getLogger("wandb") +logger.setLevel(logging.WARNING) +``` + +--- + +[Logs](/support/models/tags/logs) \ No newline at end of file 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 new file mode 100644 index 0000000000..a20595ddab --- /dev/null +++ b/support/models/articles/how-do-i-use-custom-cli-commands-with-sw.mdx @@ -0,0 +1,66 @@ +--- +title: "How do I use custom CLI commands with sweeps?" +sidebarTitle: "How do I use custom CLI commands with sweeps?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +You can use W&B Sweeps with custom CLI commands if training configuration passes command-line arguments. + +In the example below, the code snippet illustrates a bash terminal where a user trains a Python script named `train.py`, providing values that the script parses: + +```bash +/usr/bin/env python train.py -b \ + your-training-config \ + --batchsize 8 \ + --lr 0.00001 +``` + +To implement custom commands, modify the `command` key in the YAML file. Based on the previous example, the configuration appears as follows: + +```yaml +program: + train.py +method: grid +parameters: + batch_size: + value: 8 + lr: + value: 0.0001 +command: + - ${env} + - python + - ${program} + - "-b" + - your-training-config + - ${args} +``` + +The `${args}` key expands to all parameters in the sweep configuration, formatted for `argparse` as `--param1 value1 --param2 value2`. + +For additional arguments outside of `argparse`, implement the following: + +```python +parser = argparse.ArgumentParser() +args, unknown = parser.parse_known_args() +``` + + +Depending on the environment, `python` might refer to Python 2. To ensure invocation of Python 3, use `python3` in the command configuration: + +```yaml +program: + script.py +command: + - ${env} + - python3 + - ${program} + - ${args} +``` + + +--- + +[Sweeps](/support/models/tags/sweeps) \ No newline at end of file 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 new file mode 100644 index 0000000000..fa386818c9 --- /dev/null +++ b/support/models/articles/how-do-i-use-the-resume-parameter-when-r.mdx @@ -0,0 +1,18 @@ +--- +title: "How do I use the resume parameter when resuming a run in W&B?" +sidebarTitle: "How do I use the resume parameter when resuming a run in W&B?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To use the `resume` parameter in W&B , set the `resume` argument in `wandb.init()` with `entity`, `project`, and `id` specified. The `resume` argument accepts values of `"must"` or `"allow"`. + + ```python + run = wandb.init(entity="your-entity", project="your-project", id="your-run-id", resume="must") + ``` + +--- + +[Resuming](/support/models/tags/resuming) \ No newline at end of file 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 new file mode 100644 index 0000000000..829522b0b0 --- /dev/null +++ b/support/models/articles/how-do-we-update-our-payment-method.mdx @@ -0,0 +1,23 @@ +--- +title: "How do we update our payment method?" +sidebarTitle: "How do we update our payment method?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To update your payment method, follow these steps: + +1. **Go to your profile page**: First, navigate to your user profile page. +2. **Select your Organization**: Choose the relevant organization from the Account selector. +3. **Access Billing settings**: Under **Account**, select **Billing**. +4. **Add a new payment method**: + - Click **Add payment method**. + - Enter your new card details and select the option to make it your **primary** payment method. + +> **Note:** To manage billing, you must be assigned as the billing admin for your organization. + +--- + +[Billing](/support/models/tags/billing) \ No newline at end of file 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 new file mode 100644 index 0000000000..08ea949ad3 --- /dev/null +++ b/support/models/articles/how-do-you-delete-a-custom-chart-preset.mdx @@ -0,0 +1,18 @@ +--- +title: "How do you delete a custom chart preset?" +sidebarTitle: "How do you delete a custom chart preset?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Access the custom chart editor. Click on the currently selected chart type to open a menu displaying all presets. Hover over the preset to delete, then click the Trash icon. + + +Deleting chart preset + + +--- + +[Charts](/support/models/tags/charts) \ No newline at end of file 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 new file mode 100644 index 0000000000..34196194c4 --- /dev/null +++ b/support/models/articles/how-do-you-show-a-step-slider-in-a-custo.mdx @@ -0,0 +1,14 @@ +--- +title: "How do you show a 'step slider' in a custom chart?" +sidebarTitle: "How do you show a 'step slider' in a custom chart?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Enable this option on the “Other settings” page of the custom chart editor. Changing the query to use a `historyTable` instead of a `summaryTable` provides the option to “Show step selector” in the custom chart editor. This feature includes a slider for selecting the step. + +--- + +[Charts](/support/models/tags/charts) \ No newline at end of file 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 new file mode 100644 index 0000000000..4fde05f5f8 --- /dev/null +++ b/support/models/articles/how-does-someone-without-an-account-see-.mdx @@ -0,0 +1,24 @@ +--- +title: "How does someone without an account see run results?" +sidebarTitle: "How does someone without an account see run results?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If someone runs the script with `anonymous="allow"`: + +1. **Auto-create temporary account**: W&B checks for a signed-in account. If none exists, W&B creates a new anonymous account and saves the API key for that session. +2. **Log results quickly**: Users can repeatedly run the script and instantly view results in the W&B dashboard. These unclaimed anonymous runs remain available for 7 days. +3. **Claim data when it's useful**: Once a user identifies valuable results in W&B, they can click a button in the banner at the top of the page to save their run data to a real account. Without claiming, the run data deletes after 7 days. + + +**Anonymous run links are sensitive**. These links permit anyone to view and claim experiment results for 7 days, so share links only with trusted individuals. For publicly sharing results while hiding the author's identity, contact support@wandb.com for assistance. + + +When a W&B user finds and runs the script, their results log correctly to their account, just like a normal run. + +--- + +[Anonymous](/support/models/tags/anonymous) \ No newline at end of file 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 new file mode 100644 index 0000000000..d0dfe5d419 --- /dev/null +++ b/support/models/articles/how-does-wandb-stream-logs-and-writes-to.mdx @@ -0,0 +1,16 @@ +--- +title: "How does wandb stream logs and writes to disk?" +sidebarTitle: "How does wandb stream logs and writes to disk?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +W&B queues events in memory and writes them to disk asynchronously to manage failures and support the `WANDB_MODE=offline` configuration, allowing synchronization after logging. + +In the terminal, observe the path to the local run directory. This directory includes a `.wandb` file, which serves as the datastore. For image logging, W&B stores images in the `media/images` subdirectory before uploading them to cloud storage. + +--- + +[Environment Variables](/support/models/tags/environment-variables) \ No newline at end of file diff --git a/support/models/articles/how-is-wb-different-from-tensorboard.mdx b/support/models/articles/how-is-wb-different-from-tensorboard.mdx new file mode 100644 index 0000000000..f20ac86f82 --- /dev/null +++ b/support/models/articles/how-is-wb-different-from-tensorboard.mdx @@ -0,0 +1,26 @@ +--- +title: "How is W&B different from TensorBoard?" +sidebarTitle: "How is W&B different from TensorBoard?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +W&B integrates with TensorBoard and improves experiment tracking tools. The founders created W&B to address common frustrations faced by TensorBoard users. Key improvements include: + +1. **Model Reproducibility**: W&B facilitates experimentation, exploration, and model reproduction. It captures metrics, hyperparameters, code versions, and saves model checkpoints to ensure reproducibility. + +2. **Automatic Organization**: W&B streamlines project handoffs and vacations by providing an overview of all attempted models, which saves time by preventing the re-execution of old experiments. + +3. **Quick Integration**: Integrate W&B into your project in five minutes. Install the free open-source Python package and add a few lines of code. Logged metrics and records appear with each model run. + +4. **Centralized Dashboard**: Access a consistent dashboard regardless of where training occurs—locally, on lab clusters, or cloud spot instances. Eliminate the need to manage TensorBoard files across different machines. + +5. **Robust Filtering Table**: Search, filter, sort, and group results from various models efficiently. Easily identify the best-performing models for different tasks, an area where TensorBoard often struggles with larger projects. + +6. **Collaboration Tools**: W&B enhances collaboration for complex machine learning projects. Share project links and utilize private teams for result sharing. Create reports with interactive visualizations and markdown descriptions for work logs or presentations. + +--- + +[Tensorboard](/support/models/tags/tensorboard) \ No newline at end of file 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 new file mode 100644 index 0000000000..dbe4aaf53a --- /dev/null +++ b/support/models/articles/how-many-runs-can-i-create-per-project.mdx @@ -0,0 +1,14 @@ +--- +title: "How many runs can I create per project?" +sidebarTitle: "How many runs can I create per project?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Limit each project to approximately 10,000 runs for optimal performance. + +--- + +[Projects](/support/models/tags/projects)[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..2e0c51efc7 --- /dev/null +++ b/support/models/articles/how-much-storage-does-each-artifact-vers.mdx @@ -0,0 +1,39 @@ +--- +title: "How much storage does each artifact version use?" +sidebarTitle: "How much storage does each artifact version use?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Only files that change between two artifact versions incur storage costs. + + +Artifact deduplication + + +Consider an image artifact named `animals` that contains two image files, `cat.png` and `dog.png`: + +``` +images +|-- cat.png (2MB) # Added in `v0` +|-- dog.png (1MB) # Added in `v0` +``` + +This artifact receives version `v0`. + +When adding a new image, `rat.png`, a new artifact version, `v1`, is created with the following contents: + +``` +images +|-- cat.png (2MB) # Added in `v0` +|-- dog.png (1MB) # Added in `v0` +|-- rat.png (3MB) # Added in `v1` +``` + +Version `v1` tracks a total of 6MB, but occupies only 3MB of space since it shares the remaining 3MB with `v0`. Deleting `v1` reclaims the 3MB of storage associated with `rat.png`. Deleting `v0` transfers the storage costs of `cat.png` and `dog.png` to `v1`, increasing its storage size to 6MB. + +--- + +[Artifacts](/support/models/tags/artifacts)[Storage](/support/models/tags/storage) \ No newline at end of file diff --git a/support/models/articles/how-often-are-system-metrics-collected.mdx b/support/models/articles/how-often-are-system-metrics-collected.mdx new file mode 100644 index 0000000000..934471d9a7 --- /dev/null +++ b/support/models/articles/how-often-are-system-metrics-collected.mdx @@ -0,0 +1,14 @@ +--- +title: "How often are system metrics collected?" +sidebarTitle: "How often are system metrics collected?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Metrics collect by default every 10 seconds. For higher resolution metrics, email contact@wandb.com. + +--- + +[Metrics](/support/models/tags/metrics) \ No newline at end of file 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 new file mode 100644 index 0000000000..5ad3c85d68 --- /dev/null +++ b/support/models/articles/how-should-i-run-sweeps-on-slurm.mdx @@ -0,0 +1,14 @@ +--- +title: "How should I run sweeps on SLURM?" +sidebarTitle: "How should I run sweeps on SLURM?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +When using sweeps with the [SLURM scheduling system](https://slurm.schedmd.com/documentation.html), run `wandb agent --count 1 SWEEP_ID` in each scheduled job. This command executes a single training job and then exits, facilitating runtime predictions for resource requests while leveraging the parallelism of hyperparameter searches. + +--- + +[Sweeps](/support/models/tags/sweeps) \ No newline at end of file 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 new file mode 100644 index 0000000000..2964863613 --- /dev/null +++ b/support/models/articles/how-to-get-multiple-charts-with-differen.mdx @@ -0,0 +1,18 @@ +--- +title: "How to get multiple charts with different selected runs?" +sidebarTitle: "How to get multiple charts with different selected runs?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +With W&B Reports, follow these steps: + +1. Create multiple panel grids. +2. Apply filters to select the desired run sets for each panel grid. +3. Generate the desired charts within the panel grids. + +--- + +[Reports](/support/models/tags/reports) \ No newline at end of file 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 new file mode 100644 index 0000000000..8cff25b5bb --- /dev/null +++ b/support/models/articles/i-converted-my-report-to-wysiwyg-but-wan.mdx @@ -0,0 +1,18 @@ +--- +title: "I converted my report to WYSIWYG but want to revert back to Markdown" +sidebarTitle: "I converted my report to WYSIWYG but want to revert back to Markdown" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If the report conversion occurred through the message at the top, click the red "Revert" button to restore the prior state. Note that any changes made after conversion will be lost. + +If a single Markdown block was converted, use `cmd+z` to undo. + +If options to revert are unavailable because of a closed session, consider discarding the draft or editing from the last saved version. If neither works, contact W&B Support. + +--- + +[Reports](/support/models/tags/reports)[Wysiwyg](/support/models/tags/wysiwyg) \ No newline at end of file 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 new file mode 100644 index 0000000000..8deeffabad --- /dev/null +++ b/support/models/articles/i-didnt-name-my-run-where-is-the-run-nam.mdx @@ -0,0 +1,14 @@ +--- +title: "I didn't name my run. Where is the run name coming from?" +sidebarTitle: "I didn't name my run. Where is the run name coming from?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If a run is not explicitly named, W&B assigns a random name to identify it in your project. Examples of random names are `pleasant-flower-4` and `misunderstood-glade-2. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..0f2f1d9e2f --- /dev/null +++ b/support/models/articles/if-i-am-the-admin-of-my-local-instance-h.mdx @@ -0,0 +1,14 @@ +--- +title: "If I am the admin of my local instance, how should I manage it?" +sidebarTitle: "If I am the admin of my local instance, how should I manage it?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If you are the admin for your instance, review the [User Management](/platform/hosting/iam/access-management/manage-organization) section for instructions on adding users and creating teams. + +--- + +[Administrator](/support/models/tags/administrator) \ No newline at end of file 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 new file mode 100644 index 0000000000..5fadbdad3a --- /dev/null +++ b/support/models/articles/if-wandb-crashes-will-it-possibly-crash-.mdx @@ -0,0 +1,14 @@ +--- +title: "If wandb crashes, will it possibly crash my training run?" +sidebarTitle: "If wandb crashes, will it possibly crash my training run?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +It is critical to avoid interference with training runs. W&B operates in a separate process, ensuring that training continues even if W&B experiences a crash. In the event of an internet outage, W&B continually retries sending data to [wandb.ai](https://wandb.ai). + +--- + +[Crashing And Hanging Runs](/support/models/tags/crashing-and-hanging-runs) \ No newline at end of file diff --git a/support/models/articles/incorporating-latex.mdx b/support/models/articles/incorporating-latex.mdx new file mode 100644 index 0000000000..0823bb6f95 --- /dev/null +++ b/support/models/articles/incorporating-latex.mdx @@ -0,0 +1,16 @@ +--- +title: "Incorporating LaTeX" +sidebarTitle: "Incorporating LaTeX" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +LaTeX integrates seamlessly into reports. To add LaTeX, create a new report and begin typing in the rich text area to write notes and save custom visualizations and tables. + +On a new line, press `/` and navigate to the inline equations tab to insert LaTeX content. + +--- + +[Reports](/support/models/tags/reports) \ No newline at end of file diff --git a/support/models/articles/initstarterror-error-communicating-with-.mdx b/support/models/articles/initstarterror-error-communicating-with-.mdx new file mode 100644 index 0000000000..ef73a69d4c --- /dev/null +++ b/support/models/articles/initstarterror-error-communicating-with-.mdx @@ -0,0 +1,33 @@ +--- +title: "InitStartError: Error communicating with wandb process" +sidebarTitle: "InitStartError: Error communicating with wandb process" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +This error indicates that the library encounters an issue launching the process that synchronizes data to the server. + +The following workarounds resolve the issue in specific environments: + + + +```python +wandb.init(settings=wandb.Settings(start_method="fork")) +``` + + + + +For versions prior to `0.13.0`, use: + +```python +wandb.init(settings=wandb.Settings(start_method="thread")) +``` + + + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..6c14d7603b --- /dev/null +++ b/support/models/articles/is-it-possible-to-add-the-same-service-a.mdx @@ -0,0 +1,14 @@ +--- +title: "Is it possible to add the same service account to multiple teams?" +sidebarTitle: "Is it possible to add the same service account to multiple teams?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A service account cannot be added to multiple teams in W&B. Each service account is tied to a specific team. + +--- + +[Administrator](/support/models/tags/administrator)[Team Management](/support/models/tags/team-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..da63dadf2e --- /dev/null +++ b/support/models/articles/is-it-possible-to-change-the-group-assig.mdx @@ -0,0 +1,23 @@ +--- +title: "Is it possible to change the group assigned to a run after completion?" +sidebarTitle: "Is it possible to change the group assigned to a run after completion?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +You can change the group assigned to a completed run using the API. This feature does not appear in the web UI. Use the following code to update the group: + +```python +import wandb + +api = wandb.Api() +run = api.run("//") +run.group = "NEW-GROUP-NAME" +run.update() +``` + +--- + +[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..643b0b3f0a --- /dev/null +++ b/support/models/articles/is-it-possible-to-change-the-username.mdx @@ -0,0 +1,14 @@ +--- +title: "Is it possible to change the username?" +sidebarTitle: "Is it possible to change the username?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Changing the username after account creation is not possible. Create a new account with the desired username instead. + +--- + +[Administrator](/support/models/tags/administrator)[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..53054bed47 --- /dev/null +++ b/support/models/articles/is-it-possible-to-create-a-new-account-w.mdx @@ -0,0 +1,14 @@ +--- +title: "Is it possible to create a new account with an email that was previously used for a deleted account?" +sidebarTitle: "Is it possible to create a new account with an email that was previously used for a deleted account?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A new account can use an email previously associated with a deleted account. + +--- + +[User Management](/support/models/tags/user-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..5566699029 --- /dev/null +++ b/support/models/articles/is-it-possible-to-move-a-run-from-one-pr.mdx @@ -0,0 +1,22 @@ +--- +title: "Is it possible to move a run from one project to another?" +sidebarTitle: "Is it possible to move a run from one project to another?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +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. +- Click on the **Runs** tab to open the runs table. +- Select the runs to move. +- Click the **Move** button. +- Choose the destination project and confirm the action. + +W&B supports moving runs through the UI, but does not support copying runs. Artifacts logged with the runs do not transfer to the new project. To move artifacts to the run's new location manually, you can use the [`wandb artifact get`](/models/ref/cli/wandb-artifact/wandb-artifact-get/) SDK command or the [`Api.artifact` API](/models/ref/python/public-api/api/#artifact) to download the artifact, then use [wandb artifact put](/models/ref/cli/wandb-artifact/wandb-artifact-put/) or the `Api.artifact` API to upload it to the run's new location. + +--- + +[Runs](/support/models/tags/runs) \ No newline at end of file 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 new file mode 100644 index 0000000000..ec16a16f7c --- /dev/null +++ b/support/models/articles/is-it-possible-to-plot-the-max-of-a-metr.mdx @@ -0,0 +1,14 @@ +--- +title: "Is it possible to plot the max of a metric rather than plot step by step?" +sidebarTitle: "Is it possible to plot the max of a metric rather than plot step by step?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Create a scatter plot of the metric. Open the **Edit** menu and select **Annotations**. From there, plot the running maximum of the values. + +--- + +[Metrics](/support/models/tags/metrics) \ No newline at end of file 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 new file mode 100644 index 0000000000..945263d029 --- /dev/null +++ b/support/models/articles/is-it-possible-to-recover-an-artifact-af.mdx @@ -0,0 +1,14 @@ +--- +title: "Is it possible to recover an artifact after it has been deleted with a run?" +sidebarTitle: "Is it possible to recover an artifact after it has been deleted with a run?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +When deleting a run, a prompt asks whether to delete the associated artifacts. Choosing this option permanently removes the artifacts, making recovery impossible, even if the run itself is restored later. + +--- + +[Artifacts](/support/models/tags/artifacts) \ No newline at end of file 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 new file mode 100644 index 0000000000..02807f8d66 --- /dev/null +++ b/support/models/articles/is-it-possible-to-save-metrics-offline-a.mdx @@ -0,0 +1,57 @@ +--- +title: "Is it possible to save metrics offline and sync them to W&B later?" +sidebarTitle: "Is it possible to save metrics offline and sync them to W&B later?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +By default, `wandb.init` starts a process that syncs metrics in real time to the cloud. For offline use, set two environment variables to enable offline mode and sync later. + +Set the following environment variables: + +1. `WANDB_API_KEY=$KEY`, where `$KEY` is an API key created at [User Settings](https://wandb.ai/settings). +2. `WANDB_MODE="offline"`. + +Here is an example of implementing this in a script: + +```python +import wandb +import os + +os.environ["WANDB_API_KEY"] = "YOUR_KEY_HERE" +os.environ["WANDB_MODE"] = "offline" + +config = { + "dataset": "CIFAR10", + "machine": "offline cluster", + "model": "CNN", + "learning_rate": 0.01, + "batch_size": 128, +} + +with wandb.init(project="offline-demo") as run: + for i in range(100): + run.log({"accuracy": i}) +``` + +Sample terminal output is shown below: + + +Offline mode terminal output + + +After completing work, run the following command to sync data to the cloud: + +```shell +wandb sync wandb/dryrun-folder-name +``` + + +Cloud sync terminal output + + +--- + +[Experiments](/support/models/tags/experiments)[Environment Variables](/support/models/tags/environment-variables)[Metrics](/support/models/tags/metrics) \ No newline at end of file diff --git a/support/models/articles/is-there-a-dark-mode.mdx b/support/models/articles/is-there-a-dark-mode.mdx new file mode 100644 index 0000000000..0d89d760be --- /dev/null +++ b/support/models/articles/is-there-a-dark-mode.mdx @@ -0,0 +1,18 @@ +--- +title: "Is there a dark mode?" +sidebarTitle: "Is there a dark mode?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Dark mode is in beta and not optimized for accessibility. To enable dark mode: + +1. Go to your [W&B account settings](https://wandb.ai/settings). +2. Scroll to the **Public preview features** section. +3. In **UI Display**, select **Dark mode** from the dropdown. + +--- + +[Workspaces](/support/models/tags/workspaces) \ No newline at end of file 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 new file mode 100644 index 0000000000..18b6757b5d --- /dev/null +++ b/support/models/articles/is-there-a-monthly-subscription-option-f.mdx @@ -0,0 +1,14 @@ +--- +title: "Is there a monthly subscription option for the teams plan?" +sidebarTitle: "Is there a monthly subscription option for the teams plan?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The Teams plan does not offer a monthly subscription option. This subscription is billed annually. + +--- + +[Administrator](/support/models/tags/administrator)[Billing](/support/models/tags/billing)[Team Management](/support/models/tags/team-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..db60c614d9 --- /dev/null +++ b/support/models/articles/is-there-a-way-to-add-extra-values-to-a-.mdx @@ -0,0 +1,14 @@ +--- +title: "Is there a way to add extra values to a sweep, or do I need to start a new one?" +sidebarTitle: "Is there a way to add extra values to a sweep, or do I need to start a new one?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Once a W&B Sweep starts, you cannot change the Sweep configuration. However, you can navigate to any table view, select runs using the checkboxes, and then choose the **Create sweep** menu option to generate a new Sweep configuration based on previous runs. + +--- + +[Sweeps](/support/models/tags/sweeps) \ No newline at end of file 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 new file mode 100644 index 0000000000..1bd7ec94f2 --- /dev/null +++ b/support/models/articles/is-there-a-way-to-add-more-seats.mdx @@ -0,0 +1,17 @@ +--- +title: "Is there a way to add more seats?" +sidebarTitle: "Is there a way to add more seats?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To add more seats to an account, follow these steps: + +- Contact the Account Executive or support team (support@wandb.com) for assistance. +- Provide the organization name and the desired number of seats. + +--- + +[Administrator](/support/models/tags/administrator)[User Management](/support/models/tags/user-management) \ No newline at end of file diff --git a/support/models/articles/is-there-a-wb-outage.mdx b/support/models/articles/is-there-a-wb-outage.mdx new file mode 100644 index 0000000000..3065797c98 --- /dev/null +++ b/support/models/articles/is-there-a-wb-outage.mdx @@ -0,0 +1,14 @@ +--- +title: "Is there a W&B outage?" +sidebarTitle: "Is there a W&B outage?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Check if the W&B Multi-tenant Cloud at wandb.ai is experiencing an outage by visiting the [W&B status page](https://status.wandb.com). + +--- + +[Connectivity](/support/models/tags/connectivity)[Outage](/support/models/tags/outage) \ No newline at end of file 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 new file mode 100644 index 0000000000..9cf2d9a971 --- /dev/null +++ b/support/models/articles/is-there-an-anaconda-package-for-weights.mdx @@ -0,0 +1,35 @@ +--- +title: "Is there an anaconda package for Weights and Biases?" +sidebarTitle: "Is there an anaconda package for Weights and Biases?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +There is an anaconda package that is installable using either `pip` or `conda`. For `conda`, obtain the package from the [conda-forge](https://conda-forge.org) channel. + + + +```shell +# Create a conda environment +conda create -n wandb-env python=3.8 anaconda +# Activate the environment +conda activate wandb-env +# Install wandb using pip +pip install wandb +``` + + +```shell +conda activate myenv +conda install wandb --channel conda-forge +``` + + + +For installation issues, refer to this Anaconda [documentation on managing packages](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-pkgs.html) for assistance. + +--- + +[Python](/support/models/tags/python) \ No newline at end of file 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 new file mode 100644 index 0000000000..39bc56c22b --- /dev/null +++ b/support/models/articles/my-report-is-running-slowly-after-the-ch.mdx @@ -0,0 +1,14 @@ +--- +title: "My report is running slowly after the change to WYSIWYG" +sidebarTitle: "My report is running slowly after the change to WYSIWYG" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Performance issues may arise on older hardware or with very large reports. To mitigate this, collapse sections of the report that are not currently in use. + +--- + +[Reports](/support/models/tags/reports)[Wysiwyg](/support/models/tags/wysiwyg) \ No newline at end of file diff --git a/support/models/articles/my-report-looks-different-after-converti.mdx b/support/models/articles/my-report-looks-different-after-converti.mdx new file mode 100644 index 0000000000..0181605685 --- /dev/null +++ b/support/models/articles/my-report-looks-different-after-converti.mdx @@ -0,0 +1,14 @@ +--- +title: "My report looks different after converting from Markdown." +sidebarTitle: "My report looks different after converting from Markdown." +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The goal is to maintain the original appearance after transitioning to WYSIWYG, but the conversion process is not flawless. If significant discrepancies arise, report them for evaluation. Users can revert to the previous state until the editing session concludes. + +--- + +[Reports](/support/models/tags/reports)[Wysiwyg](/support/models/tags/wysiwyg) \ No newline at end of file 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 new file mode 100644 index 0000000000..4001300ee7 --- /dev/null +++ b/support/models/articles/my-runs-state-is-crashed-on-the-ui-but-i.mdx @@ -0,0 +1,14 @@ +--- +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?" +sidebarTitle: "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?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +You likely lost connection to your machine during training. Recover data by running [`wandb sync [PATH_TO_RUN]`](/models/ref/cli/wandb-sync). The path to your run is a folder in your `wandb` directory that matches the Run ID of the ongoing run. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..7b4b519978 --- /dev/null +++ b/support/models/articles/on-a-local-instance-which-files-should-i.mdx @@ -0,0 +1,21 @@ +--- +title: "On a local instance, which files should I check when I have issues?" +sidebarTitle: "On a local instance, which files should I check when I have issues?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Check the `Debug Bundle`. An admin can retrieve it from the `/system-admin` page by selecting the W&B icon in the top right corner and then choosing `Debug Bundle`. + + +Debug Bundle download + + +System settings + + +--- + +[Administrator](/support/models/tags/administrator) \ No newline at end of file diff --git a/support/models/articles/optimizing-multiple-metrics.mdx b/support/models/articles/optimizing-multiple-metrics.mdx new file mode 100644 index 0000000000..0e28725f04 --- /dev/null +++ b/support/models/articles/optimizing-multiple-metrics.mdx @@ -0,0 +1,37 @@ +--- +title: "Optimizing multiple metrics" +sidebarTitle: "Optimizing multiple metrics" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To optimize multiple metrics in a single run, use a weighted sum of the individual metrics. + +```python +with wandb.init() as run: + # Log individual metrics + metric_a = run.summary.get("metric_a", 0.5) + metric_b = run.summary.get("metric_b", 0.7) + # ... log other metrics as needed + metric_n = run.summary.get("metric_n", 0.9) + + # Combine metrics with weights + # Adjust weights according to your optimization goals + # For example, if you want to give more importance to metric_a and metric_n: + metric_combined = 0.3 * metric_a + 0.2 * metric_b + ... + 1.5 * metric_n + run.log({"metric_combined": metric_combined}) +``` + +Log the new combined metric and set it as the optimization objective: + +```yaml +metric: + name: metric_combined + goal: minimize +``` + +--- + +[Sweeps](/support/models/tags/sweeps)[Metrics](/support/models/tags/metrics) \ No newline at end of file diff --git a/support/models/articles/refreshing-data.mdx b/support/models/articles/refreshing-data.mdx new file mode 100644 index 0000000000..238b26daaa --- /dev/null +++ b/support/models/articles/refreshing-data.mdx @@ -0,0 +1,14 @@ +--- +title: "Refreshing data" +sidebarTitle: "Refreshing data" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Workspaces automatically load updated data. Auto-refresh does not apply to reports. Reload the page to refresh report data. + +--- + +[Reports](/support/models/tags/reports)[Workspaces](/support/models/tags/workspaces) \ No newline at end of file diff --git a/support/models/articles/upload-a-csv-to-a-report.mdx b/support/models/articles/upload-a-csv-to-a-report.mdx new file mode 100644 index 0000000000..2391faa7d1 --- /dev/null +++ b/support/models/articles/upload-a-csv-to-a-report.mdx @@ -0,0 +1,14 @@ +--- +title: "Upload a CSV to a report" +sidebarTitle: "Upload a CSV to a report" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +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` object. This action renders the data as a table in the report. + +--- + +[Reports](/support/models/tags/reports) \ No newline at end of file diff --git a/support/models/articles/upload-an-image-to-a-report.mdx b/support/models/articles/upload-an-image-to-a-report.mdx new file mode 100644 index 0000000000..38dc9a4450 --- /dev/null +++ b/support/models/articles/upload-an-image-to-a-report.mdx @@ -0,0 +1,18 @@ +--- +title: "Upload an image to a report" +sidebarTitle: "Upload an image to a report" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Press `/` on a new line, scroll to the Image option, and drag and drop an image into the report. + + +Adding image to report + + +--- + +[Reports](/support/models/tags/reports) \ No newline at end of file diff --git a/support/models/articles/using-artifacts-with-multiple-architectu.mdx b/support/models/articles/using-artifacts-with-multiple-architectu.mdx new file mode 100644 index 0000000000..19c445f438 --- /dev/null +++ b/support/models/articles/using-artifacts-with-multiple-architectu.mdx @@ -0,0 +1,17 @@ +--- +title: "Using artifacts with multiple architectures and runs?" +sidebarTitle: "Using artifacts with multiple architectures and runs?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +There are various methods to version a model. Artifacts provide a tool for model versioning tailored to specific needs. A common approach for projects that explore multiple model architectures involves separating artifacts by architecture. Consider the following steps: + +1. Create a new artifact for each distinct model architecture. Use the `metadata` attribute of artifacts to provide detailed descriptions of the architecture, similar to the use of `config` for a run. +2. For each model, log checkpoints periodically with `log_artifact`. W&B builds a history of these checkpoints, labeling the most recent one with the `latest` alias. Refer to the latest checkpoint for any model architecture using `architecture-name:latest`. + +--- + +[Artifacts](/support/models/tags/artifacts) \ No newline at end of file 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 new file mode 100644 index 0000000000..d22d3f253f --- /dev/null +++ b/support/models/articles/what-are-features-that-are-not-available.mdx @@ -0,0 +1,25 @@ +--- +title: "What are features that are not available to anonymous users?" +sidebarTitle: "What are features that are not available to anonymous users?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +* **No persistent data**: Runs save for 7 days in an anonymous account. Claim anonymous run data by saving it to a real account. + + +Anonymous mode interface + + +* **No artifact logging**: A warning appears on the command line when attempting to log an artifact to an anonymous run: + ```bash + wandb: WARNING Artifacts logged anonymously cannot be claimed and expire after 7 days. + ``` + +* **No profile or settings pages**: The UI does not include certain pages, as they are only useful for real accounts. + +--- + +[Anonymous](/support/models/tags/anonymous) \ No newline at end of file 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 new file mode 100644 index 0000000000..1995bb4cba --- /dev/null +++ b/support/models/articles/what-are-the-best-practices-for-handling.mdx @@ -0,0 +1,112 @@ +--- +title: "What are the best practices for handling W&B Inference errors?" +sidebarTitle: "What are the best practices for handling W&B Inference errors?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Follow these best practices to handle W&B Inference errors gracefully and maintain reliable applications. + +## 1. Always implement error handling + +Wrap API calls in try-except blocks: + +```python +import openai + +try: + response = client.chat.completions.create( + model="meta-llama/Llama-3.1-8B-Instruct", + messages=messages + ) +except Exception as e: + print(f"Error: {e}") + # Handle error appropriately +``` + +## 2. Use retry logic with exponential backoff + +```python +import time +from typing import Optional + +def call_inference_with_retry( + client, + messages, + model: str, + max_retries: int = 3, + base_delay: float = 1.0 +) -> Optional[str]: + for attempt in range(max_retries): + try: + response = client.chat.completions.create( + model=model, + messages=messages + ) + return response.choices[0].message.content + except Exception as e: + if attempt == max_retries - 1: + raise + + # Calculate delay with exponential backoff + delay = base_delay * (2 ** attempt) + print(f"Attempt {attempt + 1} failed, retrying in {delay}s...") + time.sleep(delay) + + return None +``` + +## 3. Monitor your usage + +- Track credit usage in the W&B Billing page +- Set up alerts before hitting limits +- Log API usage in your application + +## 4. Handle specific error codes + +```python +def handle_inference_error(error): + error_str = str(error) + + if "401" in error_str: + # Invalid authentication + raise ValueError("Check your API key and project configuration") + elif "402" in error_str: + # Out of credits + raise ValueError("Insufficient credits") + elif "429" in error_str: + # Rate limited + return "retry" + elif "500" in error_str or "503" in error_str: + # Server error + return "retry" + else: + # Unknown error + raise +``` + +## 5. Set appropriate timeouts + +Configure reasonable timeouts for your use case: + +```python +# For longer responses +client = openai.OpenAI( + base_url='https://api.inference.wandb.ai/v1', + api_key="your-api-key", + timeout=60.0 # 60 second timeout +) +``` + +## Additional tips + +- Log errors with timestamps for debugging +- Use async operations for better concurrency handling +- Implement circuit breakers for production systems +- Cache responses when appropriate to reduce API calls + +--- + +[Inference](/support/models/tags/inference) \ No newline at end of file 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 new file mode 100644 index 0000000000..96cc37da6f --- /dev/null +++ b/support/models/articles/what-does-wandbinit-do-to-my-training-pr.mdx @@ -0,0 +1,14 @@ +--- +title: "What does wandb.init do to my training process?" +sidebarTitle: "What does wandb.init do to my training process?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +When `wandb.init()` runs in a training script, an API call creates a run object on the servers. A new process starts to stream and collect metrics, allowing the primary process to function normally. The script writes to local files while the separate process streams data to the servers, including system metrics. To turn off streaming, run `wandb off` from the training directory or set the `WANDB_MODE` environment variable to `offline`. + +--- + +[Environment Variables](/support/models/tags/environment-variables)[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..1516b99d03 --- /dev/null +++ b/support/models/articles/what-formula-do-you-use-for-your-smoothi.mdx @@ -0,0 +1,16 @@ +--- +title: "What formula do you use for your smoothing algorithm?" +sidebarTitle: "What formula do you use for your smoothing algorithm?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The exponential moving average formula aligns with the one used in TensorBoard. + +Refer to this [explanation on Stack OverFlow](https://stackoverflow.com/questions/42281844/what-is-the-mathematics-behind-the-smoothing-parameter-in-tensorboards-scalar/75421930#75421930) for details on the equivalent Python implementation. The source code to TensorBoard's smoothing algorithm (as of this writing) can be found [here](https://github.com/tensorflow/tensorboard/blob/34877f15153e1a2087316b9952c931807a122aa7/tensorboard/components/vz_line_chart2/line-chart.ts#L699). + +--- + +[Tensorboard](/support/models/tags/tensorboard) \ No newline at end of file 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 new file mode 100644 index 0000000000..12bdd5534c --- /dev/null +++ b/support/models/articles/what-happens-if-i-edit-my-python-files-w.mdx @@ -0,0 +1,16 @@ +--- +title: "What happens if I edit my Python files while a sweep is running?" +sidebarTitle: "What happens if I edit my Python files while a sweep is running?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +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 files that the `train.py` script references change, such as helper functions in the `helper.py` script, the sweep begins to use the updated `helper.py`. + +--- + +[Sweeps](/support/models/tags/sweeps) \ No newline at end of file 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 new file mode 100644 index 0000000000..c6a4ea2fc6 --- /dev/null +++ b/support/models/articles/what-happens-if-i-pass-a-class-attribute.mdx @@ -0,0 +1,14 @@ +--- +title: "What happens if I pass a class attribute into wandb.Run.log()?" +sidebarTitle: "What happens if I pass a class attribute into wandb.Run.log()?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Avoid passing class attributes into `wandb.Run.log()`. Attributes may change before the network call executes. When storing metrics as class attributes, use a deep copy to ensure the logged metric matches the attribute's value at the time of the `wandb.Run.log()` call. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..d226ce7e56 --- /dev/null +++ b/support/models/articles/what-happens-if-internet-connection-is-l.mdx @@ -0,0 +1,16 @@ +--- +title: "What happens if internet connection is lost while I'm training a model?" +sidebarTitle: "What happens if internet connection is lost while I'm training a model?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +If the library cannot connect to the internet, it enters a retry loop and continues to attempt to stream metrics until the network is restored. The program continues to run during this time. + +To run on a machine without internet, set `WANDB_MODE=offline`. This configuration stores metrics locally on the hard drive. Later, call `wandb sync DIRECTORY` to stream the data to the server. + +--- + +[Environment Variables](/support/models/tags/environment-variables)[Outage](/support/models/tags/outage) \ No newline at end of file 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 new file mode 100644 index 0000000000..8cec3d3910 --- /dev/null +++ b/support/models/articles/what-happens-when-i-log-millions-of-step.mdx @@ -0,0 +1,16 @@ +--- +title: "What happens when I log millions of steps to W&B? How is that rendered in the browser?" +sidebarTitle: "What happens when I log millions of steps to W&B? How is that rendered in the browser?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The number of points sent affects the loading time of graphs in the UI. For lines exceeding 1,000 points, the backend samples the data down to 1,000 points before sending it to the browser. This sampling is nondeterministic, resulting in different sampled points upon page refresh. + +Log fewer than 10,000 points per metric. Logging over 1 million points in a line significantly increases page load time. Explore strategies to minimize logging footprint without sacrificing accuracy in this [Colab](https://wandb.me/log-hf-colab). With more than 500 columns of config and summary metrics, only 500 display in the table. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..934af7d30a --- /dev/null +++ b/support/models/articles/what-if-i-want-to-integrate-wb-into-my-p.mdx @@ -0,0 +1,14 @@ +--- +title: "What if I want to integrate W&B into my project, but I don't want to upload any images or media?" +sidebarTitle: "What if I want to integrate W&B into my project, but I don't want to upload any images or media?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +W&B supports projects that log only scalars by allowing explicit specification of files or data for upload. Refer to this [example in PyTorch](https://wandb.me/pytorch-colab) that demonstrates logging without using images. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file 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 new file mode 100644 index 0000000000..a06db19575 --- /dev/null +++ b/support/models/articles/what-if-i-want-to-log-some-metrics-on-ba.mdx @@ -0,0 +1,22 @@ +--- +title: "What if I want to log some metrics on batches and some metrics only on epochs?" +sidebarTitle: "What if I want to log some metrics on batches and some metrics only on epochs?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +To log specific metrics in each batch and standardize plots, log the desired x-axis values alongside the metrics. In the custom plots, click edit and select a custom x-axis. + +```python +import wandb + +with wandb.init() as run: + run.log({"batch": batch_idx, "loss": 0.3}) + run.log({"epoch": epoch, "val_acc": 0.94}) +``` + +--- + +[Experiments](/support/models/tags/experiments)[Metrics](/support/models/tags/metrics) \ No newline at end of file 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 new file mode 100644 index 0000000000..f46d9ec185 --- /dev/null +++ b/support/models/articles/what-is-a-service-account-and-why-is-it-.mdx @@ -0,0 +1,33 @@ +--- +title: "What is a service account, and why is it useful?" +sidebarTitle: "What is a service account, and why is it useful?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A **service account** represents a non-human or machine identity, which can automate common tasks across teams and projects. Service accounts are ideal for CI/CD pipelines, automated training jobs, and other machine-to-machine workflows. + +Key benefits of service accounts: +- **No license consumption**: Service accounts do not consume user seats or licenses +- **Dedicated API keys**: Secure credentials for automated workflows +- **User attribution**: Optionally attribute automated runs to human users +- **Enterprise-ready**: Built for production automation at scale +- **Delegated operations**: Service accounts operate on behalf of the user or organization that creates them + +Among other things, service accounts are useful for tracking automated jobs logged to wandb, like periodic retraining, nightly builds, and so on. If you'd like, you can associate a username with one of these machine-launched runs with the [environment variables](/models/track/environment-variables) `WANDB_USERNAME` or `WANDB_USER_EMAIL`. + +For comprehensive information about service accounts, including best practices and detailed setup instructions, refer to [Use service accounts to automate workflows](/platform/hosting/iam/service-accounts). For information about how service accounts behave in team contexts, refer to [Team Service Account Behavior](/platform/app/settings-page/teams#team-service-account-behavior). + +import TeamServiceAccountCreate from "/snippets/en/_includes/team-service-account-create.mdx"; + + + + +Apart from the **Built-in** service accounts, W&B also supports **External service accounts** using [identity federation for SDK and CLI](/platform/hosting/iam/identity_federation#external-service-accounts). Use external service accounts if you are looking to automate W&B tasks using service identities managed in your identity provider that can issue JSON Web Tokens (JWT). + + +--- + +[Administrator](/support/models/tags/administrator) \ No newline at end of file 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 new file mode 100644 index 0000000000..01c0c9b6aa --- /dev/null +++ b/support/models/articles/what-is-a-team-and-where-can-i-find-more.mdx @@ -0,0 +1,14 @@ +--- +title: "What is a team and where can I find more information about it?" +sidebarTitle: "What is a team and where can I find more information about it?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +For additional information about teams, visit the [teams section](/platform/app/settings-page/teams). + +--- + +[Team Management](/support/models/tags/team-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..b396710f6c --- /dev/null +++ b/support/models/articles/what-is-the-difference-between-log-and-s.mdx @@ -0,0 +1,20 @@ +--- +title: "What is the difference between `.log()` and `.summary`?" +sidebarTitle: "What is the difference between `.log()` and `.summary`?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +The summary displays in the table, while the log saves all values for future plotting. + +For instance, call `run.log()` whenever accuracy changes. By default, `run.log()` updates the summary value unless set manually for that metric. + +The scatterplot and parallel coordinate plots use the summary value, while the line plot shows all values recorded by `run.log`. + +Some users prefer to set the summary manually to reflect the optimal accuracy instead of the most recent accuracy logged. + +--- + +[Charts](/support/models/tags/charts) \ No newline at end of file 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 new file mode 100644 index 0000000000..685ff16cb7 --- /dev/null +++ b/support/models/articles/what-is-the-difference-between-team-and-.mdx @@ -0,0 +1,14 @@ +--- +title: "What is the difference between team and entity? As a user - what does entity mean for me?" +sidebarTitle: "What is the difference between team and entity? As a user - what does entity mean for me?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A team serves as a collaborative workspace for users working on the same projects. An entity represents either a username or a team name. When logging runs in W&B, set the entity to a personal or team account using `wandb.init(entity="example-team")`. + +--- + +[Team Management](/support/models/tags/team-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..36b993b7b7 --- /dev/null +++ b/support/models/articles/what-is-the-difference-between-team-and-_2.mdx @@ -0,0 +1,14 @@ +--- +title: "What is the difference between team and organization?" +sidebarTitle: "What is the difference between team and organization?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +A team serves as a collaborative workspace for users working on the same projects. An organization functions as a higher-level entity that can include multiple teams, often related to billing and account management. + +--- + +[Team Management](/support/models/tags/team-management)[Administrator](/support/models/tags/administrator) \ No newline at end of file diff --git a/support/models/articles/what-is-the-difference-between-wandbinit.mdx b/support/models/articles/what-is-the-difference-between-wandbinit.mdx new file mode 100644 index 0000000000..15d6b368fc --- /dev/null +++ b/support/models/articles/what-is-the-difference-between-wandbinit.mdx @@ -0,0 +1,18 @@ +--- +title: "What is the difference between wandb.init modes?" +sidebarTitle: "What is the difference between wandb.init modes?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +These modes are available: + +* `online` (default): The client sends data to the wandb server. +* `offline`: The client stores data locally on the machine instead of sending it to the wandb server. Use the [`wandb sync`](/models/ref/cli/wandb-sync) command to synchronize the data later. +* `disabled`: The client simulates operation by returning mocked objects and prevents any network communication. All logging is turned off, but all API method stubs remain callable. This mode is typically used for testing. + +--- + +[Experiments](/support/models/tags/experiments) \ No newline at end of file diff --git a/support/models/articles/what-is-the-est-runs-column.mdx b/support/models/articles/what-is-the-est-runs-column.mdx new file mode 100644 index 0000000000..0bb7134f73 --- /dev/null +++ b/support/models/articles/what-is-the-est-runs-column.mdx @@ -0,0 +1,37 @@ +--- +title: "What is the `Est. Runs` column?" +sidebarTitle: "What is the `Est. Runs` column?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +W&B provides an estimated number of Runs generated when creating a W&B Sweep with a discrete search space. This total reflects the cartesian product of the search space. + +For instance, consider the following search space: + + +Estimated runs column + + +In this case, the Cartesian product equals 9. W&B displays this value in the App UI as the estimated run count (**Est. Runs**): + + +Sweep run estimation + + +To retrieve the estimated Run count programmatically, use the `expected_run_count` attribute of the Sweep object within the W&B SDK: + +```python +sweep_id = wandb.sweep( + sweep_configs, project="your_project_name", entity="your_entity_name" +) +api = wandb.Api() +sweep = api.sweep(f"your_entity_name/your_project_name/sweeps/{sweep_id}") +print(f"EXPECTED RUN COUNT = {sweep.expected_run_count}") +``` + +--- + +[Sweeps](/support/models/tags/sweeps)[Hyperparameter](/support/models/tags/hyperparameter) \ No newline at end of file diff --git a/support/models/articles/what-really-good-functionalities-are-hid.mdx b/support/models/articles/what-really-good-functionalities-are-hid.mdx new file mode 100644 index 0000000000..0eb3ccb34a --- /dev/null +++ b/support/models/articles/what-really-good-functionalities-are-hid.mdx @@ -0,0 +1,18 @@ +--- +title: "What really good functionalities are hidden and where can I find those?" +sidebarTitle: "What really good functionalities are hidden and where can I find those?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Some functionalities are hidden under a feature flag in the **Beta Features** section of a team's settings. + + +Available beta features hidden under a feature flag + + +--- + +[Workspaces](/support/models/tags/workspaces) \ No newline at end of file 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 new file mode 100644 index 0000000000..56004bac48 --- /dev/null +++ b/support/models/articles/what-type-of-roles-are-available-and-wha.mdx @@ -0,0 +1,14 @@ +--- +title: "What type of roles are available and what are the differences between them?" +sidebarTitle: "What type of roles are available and what are the differences between them?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Visit the [Team roles and permissions](/platform/app/settings-page/teams#team-roles-and-permissions) page for an overview of the available roles and permissions. + +--- + +[User Management](/support/models/tags/user-management)[Team Management](/support/models/tags/team-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..0fd91fde26 --- /dev/null +++ b/support/models/articles/when-should-i-log-to-my-personal-entity-.mdx @@ -0,0 +1,14 @@ +--- +title: "When should I log to my personal entity against my team entity?" +sidebarTitle: "When should I log to my personal entity against my team entity?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +Personal Entities are unavailable for accounts created after May 21, 2024. W&B encourages all users to log new projects to a Team to enable sharing of results. + +--- + +[Team Management](/support/models/tags/team-management) \ No newline at end of file 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 new file mode 100644 index 0000000000..f3e92ce4c6 --- /dev/null +++ b/support/models/articles/where-are-artifacts-downloaded-and-how-c.mdx @@ -0,0 +1,27 @@ +--- +title: "Where are artifacts downloaded, and how can I control that?" +sidebarTitle: "Where are artifacts downloaded, and how can I control that?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +By default, artifacts download to the `artifacts/` folder. To change the location: + +- Pass it to [`wandb.Artifact().download`](/models/ref/python/public-api/api): + + ```python + wandb.Artifact().download(root="") + ``` + +- Set the `WANDB_ARTIFACT_DIR` [environment variable](/models/track/environment-variables): + + ```python + import os + os.environ["WANDB_ARTIFACT_DIR"] = "" + ``` + +--- + +[Artifacts](/support/models/tags/artifacts)[Environment Variables](/support/models/tags/environment-variables) \ No newline at end of file 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 new file mode 100644 index 0000000000..5ead5847e9 --- /dev/null +++ b/support/models/articles/which-files-should-i-check-when-my-code-.mdx @@ -0,0 +1,14 @@ +--- +title: "Which files should I check when my code crashes?" +sidebarTitle: "Which files should I check when my code crashes?" +--- +{/* +Built with DocEngine. Do not edit this MDX file directly. +Template: /sites/wandb-docs/templates/support_article.mdx.j2 +*/} + +For the affected run, check `debug.log` and `debug-internal.log` in `wandb/run-_