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


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.5a4.tar.gz (275.4 kB view details)

Uploaded Source

Built Distribution

wandb_testing-0.5a4-py2.py3-none-any.whl (62.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for wandb-testing-0.5a4.tar.gz
Algorithm Hash digest
SHA256 3000ed1ca50fbdbfc6ae68c693c2dc2ec2a298bcbdc84934c8e5c42d71842b51
MD5 dad64bf705216f0515819a831d6852f1
BLAKE2b-256 e807fca434e8da9e8a6e647768b973ebfee9c59fbc4b79ed2da2e637b48acb6c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wandb_testing-0.5a4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d79d08104797477cd5c19045dec819d2585f78c0831c9ca16a530ba274d50d29
MD5 cc6a9abae28567c87846645dc2d040b3
BLAKE2b-256 d224bd77aaf65908860b87c9fa918afe008528021ff2036facb187e43477b1e9

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