Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ and the W&B community.
<CardGroup cols={3}>
<Card title="W&B Models" href="/support/models" arrow="true" icon="/icons/cropped-models.svg">
{/* AUTO-GENERATED: counts */}
190 articles &middot; 33 tags
211 articles &middot; 40 tags
{/* END AUTO-GENERATED: counts */}
</Card>
<Card title="W&B Weave" href="/support/weave" arrow="true" icon="/icons/cropped-weave.svg">
{/* AUTO-GENERATED: counts */}
16 articles &middot; 8 tags
17 articles &middot; 8 tags
{/* END AUTO-GENERATED: counts */}
</Card>
<Card title="W&B Inference" href="/support/inference" arrow="true" icon="/icons/cropped-inference.svg">
{/* AUTO-GENERATED: counts */}
7 articles &middot; 5 tags
9 articles &middot; 5 tags
{/* END AUTO-GENERATED: counts */}
</Card>
</CardGroup>
Expand Down
2 changes: 1 addition & 1 deletion support/inference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ template: "scripts/knowledgebase-nav/templates/support_product_index.mdx.j2"
1 article
</Card>
<Card title="Authentication & Access" href="/support/inference/tags/authentication-access" arrow="true">
3 articles
5 articles
</Card>
<Card title="Billing" href="/support/inference/tags/billing" arrow="true">
1 article
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "API error code 404 - Model not found"
keywords: ["Authentication & Access"]
---

A 404 error with the message "Model not found" means the model identifier in your request does not match any model available through the W&B Inference API.

## Why this happens

- **Incorrect model ID**: The model name or path in your request is misspelled or formatted incorrectly.
- **Model is not available on W&B Inference**: Not all models hosted on other providers are available through the W&B Inference API. The model you are requesting may not have been onboarded.
- **Using the wrong base URL**: If you are pointing at a different provider's endpoint but using a W&B API key, the model ID will not resolve correctly.
- **Model was removed**: A model that was previously available may have been deprecated or removed.

## What you can do

1. **Check the model ID**
- Verify the exact model identifier against the [W&B Inference supported models list](/inference/supported-models).
- Model IDs are case-sensitive and typically use the format `provider/model-name` (for example, `meta-llama/Llama-3.3-70B-Instruct`).

2. **Confirm the base URL**
- The W&B Inference base URL is `https://api.wandb.ai/v1`. Ensure your client is pointed at this URL and not another provider's endpoint.

3. **Request access to a new model**
- If the model you need is not currently supported, contact [W&B support](mailto:support@wandb.com) to request it be added.

---

{/* AUTO-GENERATED: tab badges */}
<Badge stroke shape="pill" color="orange" size="md">[Authentication & Access](/support/inference/tags/authentication-access)</Badge>
{/* END AUTO-GENERATED: tab badges */}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: "API error code 422 - Invalid request parameters"
keywords: ["Authentication & Access"]
---

A 422 error means the request was understood by the server but could not be processed because one or more parameters are invalid, missing, or out of range.

## Why this happens

- **Unsupported parameter for the model**: Some parameters (such as `frequency_penalty`, `logprobs`, or `response_format`) are not supported by all models. Passing an unsupported parameter returns a 422.
- **Parameter value out of range**: Values like `temperature` must fall within a valid range (typically 0–2). Passing a value outside that range causes a 422.
- **Malformed messages array**: The `messages` field must be a list of objects with `role` and `content` keys. Missing or incorrectly typed fields return a 422.
- **Invalid `response_format`**: Requesting JSON mode (`response_format: {"type": "json_object"}`) with a model that does not support structured outputs causes a 422.

## What you can do

1. **Check the error message body**
- The 422 response body contains a `detail` field that identifies which parameter is invalid and why. Read it before troubleshooting.

2. **Verify parameter support for your model**
- Review the [W&B Inference supported models list](/inference/supported-models) for the specific parameters and ranges each model accepts.

3. **Validate your messages array**
- Each message must have a `role` (`system`, `user`, or `assistant`) and a `content` string. Tool call messages require additional fields—consult the API reference for the correct schema.

4. **Remove unsupported parameters**
- If you are adapting code from another provider, remove any parameters that are not in the W&B Inference API reference. Extra parameters that the model does not support will trigger a 422.

---

{/* AUTO-GENERATED: tab badges */}
<Badge stroke shape="pill" color="orange" size="md">[Authentication & Access](/support/inference/tags/authentication-access)</Badge>
{/* END AUTO-GENERATED: tab badges */}
8 changes: 7 additions & 1 deletion support/inference/tags/authentication-access.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Authentication & Access"
tag: "3"
tag: "5"
generator: "knowledgebase-nav"
template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2"
---
Expand All @@ -14,3 +14,9 @@ template: "scripts/knowledgebase-nav/templates/support_tag.mdx.j2"
<Card title="API error code 403 - The inference gateway is not enabled for your organization" href="/support/inference/articles/api-error-code-403-the-inference-gateway" arrow="true" horizontal>
A 403 error with the message "The inference gateway is not enabled for your organization" means your organization doesn' ...
</Card>
<Card title="API error code 404 - Model not found" href="/support/inference/articles/api-error-code-404-model-not-found" arrow="true" horizontal>
A 404 error with the message "Model not found" means the model identifier in your request does not match any model avail ...
</Card>
<Card title="API error code 422 - Invalid request parameters" href="/support/inference/articles/api-error-code-422-invalid-request-parameters" arrow="true" horizontal>
A 422 error means the request was understood by the server but could not be processed because one or more parameters are ...
</Card>
49 changes: 35 additions & 14 deletions support/models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,32 @@ template: "scripts/knowledgebase-nav/templates/support_product_index.mdx.j2"
</Card>
## Browse by category

<Card title="API" href="/support/models/tags/api" arrow="true">
2 articles
</Card>
<Card title="API Keys" href="/support/models/tags/api-keys" arrow="true">
1 article
</Card>
<Card title="AWS" href="/support/models/tags/aws" arrow="true">
2 articles
</Card>
<Card title="Academic" href="/support/models/tags/academic" arrow="true">
2 articles
</Card>
<Card title="Administrator" href="/support/models/tags/administrator" arrow="true">
25 articles
26 articles
</Card>
<Card title="Alerts" href="/support/models/tags/alerts" arrow="true">
2 articles
3 articles
</Card>
<Card title="Anonymous" href="/support/models/tags/anonymous" arrow="true">
2 articles
</Card>
<Card title="Artifacts" href="/support/models/tags/artifacts" arrow="true">
14 articles
15 articles
</Card>
<Card title="Authentication" href="/support/models/tags/authentication" arrow="true">
1 article
</Card>
<Card title="Billing" href="/support/models/tags/billing" arrow="true">
4 articles
Expand All @@ -53,13 +62,13 @@ template: "scripts/knowledgebase-nav/templates/support_product_index.mdx.j2"
4 articles
</Card>
<Card title="Connectivity" href="/support/models/tags/connectivity" arrow="true">
4 articles
5 articles
</Card>
<Card title="Environment Variables" href="/support/models/tags/environment-variables" arrow="true">
12 articles
13 articles
</Card>
<Card title="Experiments" href="/support/models/tags/experiments" arrow="true">
39 articles
51 articles
</Card>
<Card title="Hyperparameter" href="/support/models/tags/hyperparameter" arrow="true">
3 articles
Expand All @@ -68,14 +77,17 @@ template: "scripts/knowledgebase-nav/templates/support_product_index.mdx.j2"
5 articles
</Card>
<Card title="Logs" href="/support/models/tags/logs" arrow="true">
7 articles
10 articles
</Card>
<Card title="Metrics" href="/support/models/tags/metrics" arrow="true">
19 articles
23 articles
</Card>
<Card title="Notebooks" href="/support/models/tags/notebooks" arrow="true">
3 articles
</Card>
<Card title="Org Management" href="/support/models/tags/org-management" arrow="true">
2 articles
</Card>
<Card title="Outage" href="/support/models/tags/outage" arrow="true">
3 articles
</Card>
Expand All @@ -92,13 +104,16 @@ template: "scripts/knowledgebase-nav/templates/support_product_index.mdx.j2"
15 articles
</Card>
<Card title="Resuming" href="/support/models/tags/resuming" arrow="true">
2 articles
3 articles
</Card>
<Card title="Run Crashes" href="/support/models/tags/run-crashes" arrow="true">
10 articles
11 articles
</Card>
<Card title="Runs" href="/support/models/tags/runs" arrow="true">
19 articles
31 articles
</Card>
<Card title="SDK" href="/support/models/tags/sdk" arrow="true">
1 article
</Card>
<Card title="Security" href="/support/models/tags/security" arrow="true">
7 articles
Expand All @@ -107,19 +122,25 @@ template: "scripts/knowledgebase-nav/templates/support_product_index.mdx.j2"
2 articles
</Card>
<Card title="Sweeps" href="/support/models/tags/sweeps" arrow="true">
19 articles
23 articles
</Card>
<Card title="Tables" href="/support/models/tags/tables" arrow="true">
2 articles
</Card>
<Card title="Team Management" href="/support/models/tags/team-management" arrow="true">
12 articles
13 articles
</Card>
<Card title="Teams" href="/support/models/tags/teams" arrow="true">
3 articles
</Card>
<Card title="Tensorboard" href="/support/models/tags/tensorboard" arrow="true">
2 articles
</Card>
<Card title="User Management" href="/support/models/tags/user-management" arrow="true">
13 articles
15 articles
</Card>
<Card title="Workspace" href="/support/models/tags/workspace" arrow="true">
2 articles
</Card>
<Card title="Workspaces" href="/support/models/tags/workspaces" arrow="true">
7 articles
Expand Down
30 changes: 30 additions & 0 deletions support/models/articles/can-i-resume-a-run-inside-a-sweep.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Can I resume a run inside a sweep?"
keywords: ["Sweeps", "Resuming"]
---

Run resumption is not supported inside a W&B sweep. If you pass a `run_id` or use `wandb.init(resume=...)` while a sweep agent is running, W&B ignores the run ID and starts a fresh run instead. You will see the following warning:

```
wandb: WARNING Ignoring run_id when running a sweep
```

This is expected behavior, not a bug. Sweep agents are designed to launch independent runs for each hyperparameter configuration. Resuming a specific run would conflict with the sweep controller's job scheduling.

**Workarounds**

If you need fault tolerance for long sweep runs, consider these approaches:

- **Checkpoint and reload within a single run**: Save model checkpoints at regular intervals inside your training function. On restart, load the latest checkpoint at the beginning of `train()`. The sweep starts a new run, but training picks up from the saved state.

- **Use `--count 1` on SLURM with requeue**: Submit each sweep agent job with `wandb agent --count 1 SWEEP_ID`. If the job is preempted, SLURM can requeue it and the sweep controller will assign a new configuration.

- **Mark a run as failed and requeue manually**: If a run crashes mid-way, the sweep controller will eventually mark it as failed and may assign the same configuration to a new agent depending on your sweep settings.

If you need to continue an interrupted training job outside of a sweep, use `wandb.init(resume="allow", id="YOUR_RUN_ID")` in a standalone script instead.

---

{/* AUTO-GENERATED: tab badges */}
<Badge stroke shape="pill" color="orange" size="md">[Sweeps](/support/models/tags/sweeps)</Badge><Badge stroke shape="pill" color="orange" size="md">[Resuming](/support/models/tags/resuming)</Badge>
{/* END AUTO-GENERATED: tab badges */}
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: "How do I connect to a self-hosted W&B Server?"
keywords: ["Administrator", "User Management", "Environment Variables"]
---

W&B Server is a self-hosted deployment of W&B that runs within your own infrastructure. Connecting the W&B SDK and CLI to a self-hosted instance requires pointing them at your server's URL instead of `api.wandb.ai`.

**Authenticating via the CLI**

```bash
wandb login --host https://your-wandb-server.company.com
```

This stores the host and your API key in `~/.netrc`. You will be prompted to enter your API key, which you can retrieve from your user profile on the self-hosted instance.

**Setting the host via environment variable**

For containerized jobs or CI/CD pipelines where you cannot run interactive login:

```bash
export WANDB_BASE_URL=https://your-wandb-server.company.com
export WANDB_API_KEY=your_api_key
python train.py
```

`WANDB_BASE_URL` takes precedence over any value stored in `~/.netrc`.

**Setting the host in Python**

```python
import wandb

wandb.login(
host="https://your-wandb-server.company.com",
key="your_api_key",
)

wandb.init(project="my-project")
```

**Verifying the connection**

```bash
wandb status
```

This prints the current host, logged-in user, and API key (masked). Confirm the host matches your server URL.

**SSL / certificate issues**

If your server uses a self-signed or internal CA certificate, Python's `requests` library may reject the connection. Set the path to your CA bundle:

```bash
export REQUESTS_CA_BUNDLE=/path/to/ca-bundle.crt
```

Or in Python before initializing W&B:

```python
import os
os.environ["REQUESTS_CA_BUNDLE"] = "/path/to/ca-bundle.crt"
```

**Switching between cloud and self-hosted**

To switch back to W&B cloud (`api.wandb.ai`) from a self-hosted instance, either unset `WANDB_BASE_URL` or re-run `wandb login` without the `--host` flag:

```bash
unset WANDB_BASE_URL
wandb login
```

**Common issues**

- **401 on `wandb.init()`**: Your API key does not exist on the self-hosted instance. API keys are not shared between W&B cloud and self-hosted deployments — generate a new key from your profile on the self-hosted instance.
- **Connection refused / timeout**: The server URL may be wrong, or your machine may need VPN access to reach the internal network.
- **License not recognized**: See [Why is my enterprise license not recognized?](/support/models/articles/enterprise-license-not-recognized) for license validation steps.

---

{/* AUTO-GENERATED: tab badges */}
<Badge stroke shape="pill" color="orange" size="md">[Administrator](/support/models/tags/administrator)</Badge><Badge stroke shape="pill" color="orange" size="md">[User Management](/support/models/tags/user-management)</Badge><Badge stroke shape="pill" color="orange" size="md">[Environment Variables](/support/models/tags/environment-variables)</Badge>
{/* END AUTO-GENERATED: tab badges */}
47 changes: 47 additions & 0 deletions support/models/articles/how-do-i-create-a-new-team-in-wandb.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "How do I create a new team in W&B?"
keywords: ["Teams", "Org Management"]
---

Teams are the primary unit of collaboration in W&B. A team has its own entity name, shared projects, and member roster. Anyone with a W&B account can create a team.

**Creating a team**

1. Log in to [wandb.ai](https://wandb.ai).
2. Click the **+** icon or **Create new team** in the left sidebar (or navigate to [wandb.ai/create-team](https://wandb.ai/create-team)).
3. Enter a **team name**. This becomes the team's entity name (e.g., `wandb.ai/my-team`). Team names must be globally unique, lowercase, and can contain letters, numbers, and hyphens.
4. Click **Create team**.

You are automatically made an admin of the new team.

**Inviting members after creation**

After creating the team, go to **Team settings → Members → Invite members** to add colleagues. See [How do I invite a user to my W&B team?](/support/models/articles/how-do-i-invite-a-user-to-my-wb-team) for full details.

**Choosing a team name**

The team name becomes part of every project and run URL under that team, so choose a name that will remain meaningful long-term. Team names cannot be changed after creation without contacting W&B support.

**Personal accounts vs. team accounts**

Your personal W&B account has its own entity (your username) that is separate from any teams you belong to. Runs logged to your personal entity are not visible to your team unless you explicitly log them to the team entity:

```python
import wandb

# Log to a team project (visible to all team members)
wandb.init(entity="my-team", project="shared-project")

# Log to personal entity (only visible to you)
wandb.init(entity="my-username", project="personal-experiments")
```

**Team limits**

On the free plan, teams support a limited number of seats and storage. Check your plan details at **Team settings → Billing** or [wandb.ai/site/pricing](https://wandb.ai/site/pricing).

---

{/* AUTO-GENERATED: tab badges */}
<Badge stroke shape="pill" color="orange" size="md">[Teams](/support/models/tags/teams)</Badge><Badge stroke shape="pill" color="orange" size="md">[Org Management](/support/models/tags/org-management)</Badge>
{/* END AUTO-GENERATED: tab badges */}
Loading
Loading