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

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

## Quickstart

```shell
pip install wandb
```

In your training script:

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

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

def training_loop():
while True:
# Do some machine learning
epoch, loss, val_loss = ...
run.history.add({"epoch": epoch, "loss": loss, "val_loss": val_loss})
```

Running your script will save run 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.

![Runs screenshot](docs/screenshot.jpg?raw=true)

## 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


Download files

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

Source Distribution

wandb-testing-0.5a3.tar.gz (272.2 kB view details)

Uploaded Source

Built Distribution

wandb_testing-0.5a3-py2.py3-none-any.whl (60.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file wandb-testing-0.5a3.tar.gz.

File metadata

File hashes

Hashes for wandb-testing-0.5a3.tar.gz
Algorithm Hash digest
SHA256 6e3ff10b6c1bcd2f698e139a1eaddbcdfe6f14aa1c4f20cc9662cbef93c48e83
MD5 196bb84bb4bd23c05e1d617f57bb5c72
BLAKE2b-256 2bcfcabf9c5167e4f40c98d3abe324f2ebdacb4e2a1110ea156e62ddb12c6067

See more details on using hashes here.

File details

Details for the file wandb_testing-0.5a3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for wandb_testing-0.5a3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d2809320022c17095633d00ded34b5e1f5a6dd195928a126ee8f3030f2bd8c53
MD5 3e2b9022a9653e4f46e5dd27db3b3d9c
BLAKE2b-256 adbb0556bbe3ed2c835aaa47cb9a707efc6184b481a5d2b04d326bf6ea486b1c

See more details on using hashes here.

Supported by

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