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.11.tar.gz (281.0 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.11-py2.py3-none-any.whl (67.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for wandb-0.5.11.tar.gz
Algorithm Hash digest
SHA256 da35091b0f761997a583e59a71e0bd79087ca6c7fb3138e67c717685acff9dd7
MD5 e5212521bab580052d540d60071cccc7
BLAKE2b-256 b7e42dd6a02a89b8aa0e11e3978b3427e308ac5085670b08d1430a7def0a6608

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wandb-0.5.11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e407dea70b76c5eddab29ac276dd0f0b0808602eebfb9d0f9a957c003159becb
MD5 5ebed0351b2a5262a7dca68dd2f16b4e
BLAKE2b-256 4a8f345d32448029e2a0578f0f2bc16d9d3d753fc8a23e5ac16664366e8619c6

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