Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt

Use this file to discover all available pages before exploring further.

Your user settings let you manage your profile, default team, API keys, alerts, integrations, and other account-level options. This page describes each section of the user settings and how to use it. To open your user settings, navigate to your user profile page and select your user icon on the top right corner. From the dropdown, choose Settings.

​
Profile

In the Profile section, you can manage and modify your account name and institution. You can optionally add a biography, location, link to a personal or your institution’s website, and upload a profile image.

​
Edit your intro

Your intro appears at the top of your profile and is a good place to introduce yourself, link to projects, or share related accounts. To edit your intro, click Edit at the top of your profile. The WYSIWYG editor that opens supports Markdown.
  1. To edit a line, click it. To save time, type / and choose Markdown from the list.
  2. To move an item, use its drag handles.
  3. To delete a block, click the drag handle, then click Delete.
  4. To save your changes, click Save.
Your updated intro is now visible on your profile.

​
Add social badges

To add a follow badge for the @weights_biases account on X, add a Markdown-style link with an HTML <img> tag that points to the badge image: 
[![X: @weights_biases](https://img.shields.io/twitter/follow/weights_biases?style=social)](https://x.com/intent/follow?screen_name=weights_biases)
In an <img> tag, you can specify width, height, or both. If you specify only one, the image keeps its proportions.

​
Default team

If you’re a member of more than one team, the Default team section lets you configure the default team to use when a run or a Weave trace doesn’t specify a team. If you’re a member of only one team, that team is the default and this section doesn’t appear. The steps to set your default team differ depending on your deployment. Select the tab that matches your environment.
Next to Default location to create new projects in, click the dropdown, then select your default team.
To specify the default team when you’re running a script in an automated environment, specify the default location with the WANDB_ENTITY environment variable.

​
Teams

The Teams section lists all of your teams.
  • Click a team name to go to the team page.
  • If you have permission to join additional teams, click View teams next to We found teams for you to join.
  • Optional: Turn on Hide teams in public profile.
To create or manage a team, see Manage teams.

​
API keys

The API Keys section lets you manage your personal API keys for authenticating with W&B services. From this section, you can review existing keys, create new ones, and revoke keys you no longer need.

​
View your API keys

The API keys table displays:
  • Key ID: The first part of each API key, used for identification.
  • Name: A descriptive name you provided when you created the key.
  • Created: When the key was created.
  • Last used: The most recent usage timestamp.
For security, the table shows only the key ID (the first part of the key). The full secret API key appears only once, when you create it.
To filter the list of API keys, enter a partial key name or ID.

​
Create a new API key

To create an API key, select the Personal API key or Service Account API key tab for details.
To create a personal API key owned by your user ID:
  1. Log in to W&B, click your user profile icon, then click User Settings.
  2. Click Create new API key.
  3. Provide a descriptive name for your API key.
  4. Click Create.
  5. Copy the displayed API key immediately and store it securely.
The full API key is only shown once at creation time. After you close the dialog, you cannot view the full API key again. Only the key ID (first part of the key) is visible in your settings. If you lose the full API key, you must create a new API key.
For secure storage options, see Store API keys securely.

​
Delete an API key

Delete an API key when you no longer need it or when it may have been exposed. To revoke access by deleting an API key:
  1. Find the key you want to delete in the API keys table.
  2. Click the delete button next to the key.
  3. Confirm the deletion.
W&B removes the key from the table, and you can no longer use it to authenticate.
Deleting an API key immediately revokes access for any scripts or services that use that key. Before you delete the old key, make sure you’ve updated all systems to use a new key.

​
Store and handle API keys securely

API keys provide access to your W&B account and should be protected like passwords. Follow these best practices:

​
What to avoid

  • Never commit API keys to version control systems such as Git.
  • Do not store API keys in plain text configuration files.
  • Do not pass API keys on the command line, because they will be visible in the output of OS commands like ps.
  • Avoid sharing API keys through email, chat, or other unencrypted channels.
  • Do not hard-code API keys in your source code.
If an API key is exposed, delete the API key from your W&B account immediately and contact support or your AISE.

​
Environment variables

When using API keys in your code, pass them through environment variables: 
export WANDB_API_KEY="your-api-key-here"
This approach keeps keys out of your source code and makes it easier to rotate them when needed.
Avoid setting the environment variable in line with the command, because it will be visible in the output of OS commands like ps:
# Avoid this pattern, which can expose the API key in process managers
export WANDB_API_KEY="your-api-key-here" ./my-script.sh

​
SDK version compatibility

New API keys are longer than legacy keys. When authenticating with older versions of the wandb or weave SDKs, you may encounter an API key length error. Solution: Update to a newer SDK version:
  • wandb SDK v0.22.3+ 
    pip install --upgrade wandb==0.22.3
  • weave SDK v0.52.17+ 
    pip install --upgrade weave==0.52.17
If you cannot upgrade the SDK immediately, set the API key using the WANDB_API_KEY environment variable as a workaround.

​
Beta features

In the Beta Features section, you can optionally enable add-ons and previews of products in development. Select the toggle switch next to the beta feature you want to enable.

​
Alerts

Get notified when your runs crash or finish, or set custom alerts with wandb.Run.alert(). You receive notifications through email or Slack. Toggle the switch next to the event type you want to receive alerts for:
  • Runs finished: Notify you when a W&B run successfully finishes.
  • Run crashed: Notify you when a run fails to finish.
For more information about how to set up and manage alerts, see Send alerts with wandb.Run.alert().

​
Personal GitHub integration

Connect a personal GitHub account so that W&B can access GitHub resources on your behalf. To connect a GitHub account:
  1. Select the Connect Github button. W&B redirects you to an open authorization (OAuth) page.
  2. In the Organization access section, select the organization to grant access.
  3. Select Authorize wandb.
Your personal GitHub account is now linked to your W&B account.

​
Delete your account

Select the Delete Account button to delete your account.
You can’t reverse account deletion.

​
Storage

The Storage section describes the total memory your account has consumed on the W&B servers. The default storage plan is 100 GB. For more information about storage and pricing, see the Pricing page.