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

Uploaded Source

Built Distribution

wandb_testing-0.5.21.post1-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.post1.tar.gz.

File metadata

File hashes

Hashes for wandb-testing-0.5.21.post1.tar.gz
Algorithm Hash digest
SHA256 6fb77963d2dba9f3e1acd49e4a02f34306e64bd6b89b21d8c74805e6d5ea81f8
MD5 8a008990bdcdb055538f1ac1c88da7d4
BLAKE2b-256 a6055d573f2b7fd06989591adaf325c4ff41f632da4fdca56b4e9a8517c7084f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wandb_testing-0.5.21.post1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1d7cc56cfa7710e3bc233b30070678b32bb0a99134f218f0d79e4432bdfd1b85
MD5 941595a240a10560f9f620b3c967737a
BLAKE2b-256 84b57b5e5a5af9a426a314a3cb0c379dff592eafd0c9ccbd3ad9bb178fc9c770

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