Skip to main content

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

Project description



Weights and Biases ci pypi Coverage Status

Use W&B to organize and analyze machine learning experiments. It's framework-agnostic and lighter than TensorBoard. Each time you run a script instrumented with wandb, we save your hyperparameters and output metrics. Visualize models over the course of training, and compare versions of your models easily. We also automatically track the state of your code, system metrics, and configuration parameters.

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.10.19.tar.gz (1.7 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.10.19-py2.py3-none-any.whl (2.0 MB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: wandb-0.10.19.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for wandb-0.10.19.tar.gz
Algorithm Hash digest
SHA256 c308cd478b9a7e26be50524e9dd7cc348068411fac273ea9710f7999ab66a046
MD5 92100c52bf402b170ebd9ef1a9e57825
BLAKE2b-256 6118c5a0f437221700f56ca3b2b0b0696b1d2c24d32906974713c22d2bad82f3

See more details on using hashes here.

File details

Details for the file wandb-0.10.19-py2.py3-none-any.whl.

File metadata

  • Download URL: wandb-0.10.19-py2.py3-none-any.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for wandb-0.10.19-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6be23c10fb18773621f5b0d2372b0db58f993cba7c81c9b090368fa15873a8c9
MD5 a9e2209d579570c9b6019973e249b6a0
BLAKE2b-256 68484b59e775d7fd3917201de7975892241a5145ce482bc739bf22e83735e5c4

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