Skip to main content

A CLI and library for interacting with the Weights & Biases API.

Project description



Weights and Biases PyPI Conda (channel only) CircleCI Codecov

Use W&B to build better models faster. Track and visualize all the pieces of your machine learning pipeline, from datasets to production models.

  • Quickly identify model regressions. Use W&B to visualize results in real time, all in a central dashboard.
  • Focus on the interesting ML. Spend less time manually tracking results in spreadsheets and text files.
  • Capture dataset versions with W&B Artifacts to identify how changing data affects your resulting models.
  • Reproduce any model, with saved code, hyperparameters, launch commands, input data, and resulting model weights.

Sign up for a free account →

Features

  • Store hyper-parameters used in a training run
  • Search, compare, and visualize training runs
  • Analyze system usage metrics alongside runs
  • Collaborate with team members
  • Replicate historic results
  • Run parameter sweeps
  • Keep records of experiments available forever

Documentation →

Quickstart

pip install wandb

In your training script:

import wandb

# Your custom arguments defined here
args = ...

wandb.init(config=args, project="my-project")
wandb.config["more"] = "custom"


def training_loop():
    while True:
        # Do some machine learning
        epoch, loss, val_loss = ...
        # Framework agnostic / custom metrics
        wandb.log({"epoch": epoch, "loss": loss, "val_loss": val_loss})

If you're already using Tensorboard or TensorboardX, you can integrate with one line:

wandb.init(sync_tensorboard=True)

Running your script

Run wandb login from your terminal to signup or authenticate your machine (we store your api key in ~/.netrc). You can also set the WANDB_API_KEY environment variable with a key from your settings.

Run your script with python my_script.py and all metadata will be synced to the cloud. You will see a url in your terminal logs when your script starts and finishes. Data is staged locally in a directory named wandb relative to your script. If you want to test your script without syncing to the cloud you can set the environment variable WANDB_MODE=dryrun.

If you are using docker to run your code, we provide a wrapper command wandb docker that mounts your current directory, sets environment variables, and ensures the wandb library is installed. Training your models in docker gives you the ability to restore the exact code and environment with the wandb restore command.

Web Interface

Sign up for a free account → Watch the video Introduction video →

Detailed Usage

Framework specific and detailed usage can be found in our documentation.

Testing

To run basic test use make test. More detailed information can be found at CONTRIBUTING.md.

We use circleci for CI.

Academic Researchers

If you'd like a free academic account for your research group, reach out to us →

We make it easy to cite W&B in your published paper. Learn more →

Community

Got questions, feedback or want to join a community of ML engineers working on exciting projects?

slack Join our slack community.

Twitter Follow us on Twitter.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wandb-0.16.6.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wandb-0.16.6-py3-none-any.whl (2.2 MB view details)

Uploaded Python 3

File details

Details for the file wandb-0.16.6.tar.gz.

File metadata

  • Download URL: wandb-0.16.6.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for wandb-0.16.6.tar.gz
Algorithm Hash digest
SHA256 86f491e3012d715e0d7d7421a4d6de41abef643b7403046261f962f3e512fe1c
MD5 d7625b12aa22e8f15d6b3c979939013b
BLAKE2b-256 e5d2fdd399df703539233fcb99182067be0e16f7fbdbd00e83e372982faeeac0

See more details on using hashes here.

File details

Details for the file wandb-0.16.6-py3-none-any.whl.

File metadata

  • Download URL: wandb-0.16.6-py3-none-any.whl
  • Upload date:
  • Size: 2.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for wandb-0.16.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5810019a3b981c796e98ea58557a7c380f18834e0c6bdaed15df115522e5616e
MD5 32a8181bb9ccaf032c6b5d9925e97d42
BLAKE2b-256 8b8dbb05a4ecdeac6b2256d98ac10bae8723af5d7a8c1a4c2384b3ae0f80370e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page