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
from wandb.keras import WandbCallback
# 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=[WandbCallback()])
```

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


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.5.21.post0.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

wandb_testing-0.5.21.post0-py2.py3-none-any.whl (2.9 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file wandb-testing-0.5.21.post0.tar.gz.

File metadata

File hashes

Hashes for wandb-testing-0.5.21.post0.tar.gz
Algorithm Hash digest
SHA256 2679890bae7c2203f8e37ccdad2ed6071b5d9947587468e3c8910e52e0f6bb92
MD5 d8bcae82abfb39be0d11f40ca5c210e2
BLAKE2b-256 8214c9c3ab86b95457813e9b715ccd0901c543c9f48507a31fa3fee3a3ae020e

See more details on using hashes here.

File details

Details for the file wandb_testing-0.5.21.post0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for wandb_testing-0.5.21.post0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b9f7a63eb340ededda35813c59e64d8845a304a46aff41b5206d513f3718b120
MD5 979bdea8db05121d839c11725d1dbfe8
BLAKE2b-256 d0d50ee5acd24a180670408359775cae0283b1aee6f14a80d454f95b239b6286

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