Skip to main content

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

Project description

<div align="center">
<img src="https://app.wandb.ai/logo.svg" width="350" /><br><br>
</div>

# Weights and Biases [![ci](https://circleci.com/gh/wandb/client.svg?style=svg)](https://circleci.com/gh/wandb/client) [![pypi](https://img.shields.io/pypi/v/wandb.svg)](https://pypi.python.org/pypi/wandb)

The **Weights and Biases** client is an open source library, CLI (wandb), and local web application for organizing and analyzing your machine learning experiments. Think of it as a framework-agnostic lightweight TensorBoard that persists additional information such as the state of your code, system metrics, and configuration parameters.

## Local Features

* Store config parameters used in a training run
* Associate version control with your training runs
* Search, compare, and visualize training runs
* Analyze system usage metrics alongside runs

## Cloud Features

* Collaborate with team members
* Run parameter sweeps
* Persist runs forever

## Quickstart

```shell
pip install wandb
```

In your training script:

```python
import wandb
# Your custom arguments defined here
args = ...

run = wandb.init(config=args)
run.config["more"] = "custom"

def training_loop():
while True:
# Do some machine learning
epoch, loss, val_loss = ...
# Framework agnostic / custom metrics
run.history.add({"epoch": epoch, "loss": loss, "val_loss": val_loss})
# Keras metrics
model.fit(..., callbacks=[wandb.callbacks.Keras()])
```

Running your training script will save data in a directory named _wandb_ relative to your training script. To view your runs, call `wandb board` from the same directory as your training script.

<p align="center">
<img src="https://github.com/wandb/client/raw/master/docs/screenshot.jpg?raw=true" alt="Runs screenshot" style="max-width:100%;">
</p>

## Cloud Usage

[Signup](https://app.wandb.ai/login?invited) for an account, then run `wandb init` from the directory with your training script. You can checkin _wandb/settings_ to version control to enable other users on your team to share experiments. Run your script with `wandb run my_script.py` and all metadata will be synced to the cloud.

## Detailed Usage

Framework specific and detailed usage can be found in our [documentation](http://docs.wandb.com/).

## Development

See https://github.com/wandb/client/blob/master/DEVELOPMENT.md

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.5.9.tar.gz (281.3 kB view details)

Uploaded Source

Built Distribution

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

wandb-0.5.9-py2.py3-none-any.whl (67.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: wandb-0.5.9.tar.gz
  • Upload date:
  • Size: 281.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for wandb-0.5.9.tar.gz
Algorithm Hash digest
SHA256 56d90d799ea2806e6751ed2c6f62bc3ab4f27c4cb961e49b3a6ffffa20038091
MD5 5c45eba9ab8c2933a088ce9e9b738e83
BLAKE2b-256 b611f1e888f6ab002d526b8981b90c8a2c29c72495843addb9da326382a2b48b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wandb-0.5.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1f488ec6b01336a66fa68eaea7ca0597c3ee43f163e807d6d427f906a43c0109
MD5 4d206d88a59c6ff86f6641e97858dd88
BLAKE2b-256 7e1e68b5db74a0a08eeaf2282c73ca0a3f133f046cbe6b4a92add64272971e25

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