Get started

The following guide will help you get started with W&B notebooks, from signing up and creating an API key to running your first training experiment. To authenticate your machine with W&B, you need an 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:

Log in to W&B, then click your user profile icon > User Settings.
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.

W&B shows the full API key only once, when you create it. After you close the dialog, you cannot view the full API key again. Your settings display only the key ID (the first part of the key). If you lose the full API key, you must create a new one.

For secure storage options, see Store API keys securely.

Create your first notebook

Navigate to your project’s workspace.
Select Notebooks from the project sidebar.
Click Create notebook.

See the Create and manage notebooks for more information.

Run a training experiment

This mock training script logs simulated accuracy and loss metrics to W&B. Copy and paste the following code into a Python script or notebook cell and run it:

Select Python to create a new code cell.
Copy and paste the following code into the cell:

import random
import wandb

PROJECT = "your-project-name"

# Dictionary with hyperparameters
config = {
    'epochs' : 10,
    'lr' : 0.01
}

with wandb.init(project=PROJECT, config=config) as run:
    offset = random.random() / 5
    print(f"lr: {config['lr']}")
    
    # Simulate a training run
    for epoch in range(2, config['epochs']):
        acc = 1 - 2**-config['epochs'] - random.random() / config['epochs'] - offset
        loss = 2**-config['epochs'] + random.random() / config['epochs'] + offset
        print(f"epoch={config['epochs']}, accuracy={acc}, loss={loss}")
        run.log({"accuracy": acc, "loss": loss})

Press Command + Enter on macOS or Ctrl+Enter on Windows or Linux. Alternatively, select the play () button next to the cell.

View your experiment

View the accuracy and loss metrics logged during the training experiment:

Select Workspace from the project sidebar.
Review the runs and visualizations in the workspace. The runs list shows each run logged to the project and its details. Workspace panels display visualizations of the metrics logged during each run.

Save the notebook

Notebooks save automatically by default. You can turn off automatic saving, change how often the notebook saves, and configure other save settings in the notebook preferences. To save the notebook manually, press Command+S on macOS or Ctrl+S on Windows or Linux. Alternatively, select the save () button in the lower-right corner of the notebook. Share your notebook with users outside of W&B. You can publish it as HTML, create a WebAssembly link, or create a molab notebook.

Select action ( ) in the upper-right corner of the notebook.
Move your cursor to Share.
From the dropdown menu, select the desired sharing option: Publish HTML to web, Create WebAssembly link, or Create molab notebook.

For more information on sharing your notebook, see the relevant guides below:

Guides

Integrations

Reference

Create your first notebook

Run a training experiment

View your experiment

Save the notebook

​Sign up and create an API key

​Create your first notebook

​Run a training experiment

​View your experiment

​Save the notebook

​Share your notebook

Sign up and create an API key

Create your first notebook

Run a training experiment

View your experiment

Save the notebook

Share your notebook