Profile
Within 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
To edit your intro, click Edit at the top of your profile. The WYSIWYG editor that opens supports Markdown.- To edit a line, click it. To save time, you can type
/and choose Markdown from the list. - Use an item’s drag handles to move it.
- To delete a block, click the drag handle, then click Delete.
- To save your changes, click Save.
Add social badges
To add a follow badge for the@weights_biases account on X, you could add a Markdown-style link with an HTML <img> tag that points to the badge image:
<img> tag, you can specify width, height, or both. If you specify only one of them, the image’s proportions are maintained.
Default team
If you are a member of more than one team, the Default team section allows you to configure the default team to use when a run or a Weave trace does not specify a team. If you are a member of only one team, that team is the default and this section does not appear. Select a tab to continue.- Multi-tenant Cloud
- Dedicated Cloud / Self-Managed
Next to Default location to create new projects in, click thew drop-down, then select your default team.
To specify the default team when you’re running a script in an automated environment, you can specify the default location using 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.
- Optionally, turn on Hide teams in public profile.
To create or manage a team, see Manage teams.
API keys
The API Keys section allows you to manage your personal API keys for authenticating with W&B services.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 creating the key
- Created: When the key was created
- Last used: The most recent usage timestamp
The table shows only the key ID (first part of the key) for security. The full secret API key is only displayed once when you create it.
Create a new API key
To create an API key, select the Personal API key or Service Account API key tab for details.- Personal API key
- Service account API key
To create a personal API key owned by your user ID:
- Navigate to User Settings and log in if necessary.
- Click Create new API key.
- Provide a descriptive name for your API key.
- Click Create.
- Copy the displayed API key immediately and store it securely.
Delete an API key
To revoke access by deleting an API key:- Find the key you want to delete in the API keys table.
- Click the delete button next to the key.
- Confirm the deletion.
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:Recommended storage methods
- Secrets manager: Use a dedicated secrets management system such as AWS Secrets Manager, HashiCorp Vault, Azure Key Vault, or Google Secret Manager.
- Password manager: Use a reputable password manager application.
- OS-level keychains: Store keys in macOS Keychain, Windows Credential Manager, or Linux secret service. Not suggested for production.
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.
Environment variables
When using API keys in your code, pass them through environment variables:SDK version compatibility
New API keys are longer than legacy keys. When authenticating with older versions of thewandb or weave SDKs, you may encounter an API key length error.
Solution: Update to a newer SDK version:
-
wandbSDK v0.22.3+ -
weaveSDK v0.52.17+
WANDB_API_KEY environment variable as a workaround.
Beta features
Within the Beta Features section you can optionally enable fun add-ons and sneak previews of new products in development. Select the toggle switch next to the beta feature you want to enable.Alerts
Get notified when your runs crash, finish, or set custom alerts with wandb.Run.alert(). Receive notifications either through Email or Slack. Toggle the switch next to the event type you want to receive alerts from.- Runs finished: whether a Weights and Biases run successfully finished.
- Run crashed: notification if a run has failed to finish.
Personal GitHub integration
Connect a personal Github account. To connect a Github account:- Select the Connect Github button. This will redirect you to an open authorization (OAuth) page.
- Select the organization to grant access in the Organization access section.
- Select Authorize wandb.