Skip to content

Latest commit

 

History

History
89 lines (53 loc) · 3.77 KB

package_readme.md

File metadata and controls

89 lines (53 loc) · 3.77 KB


Weights and Biases PyPI Conda (channel only) CircleCI Codecov

Use W&B to build better models faster. Track and visualize all the pieces of your machine learning pipeline, from datasets to production machine learning models. Get started with W&B today, sign up for an account!

See the W&B Developer Guide and API Reference Guide for a full technical description of the W&B platform.

 

Quickstart

Get started with W&B in four steps:

  1. First, sign up for a W&B account.

  2. Second, install the W&B SDK with pip. Navigate to your terminal and type the following command:

pip install wandb
  1. Third, log into W&B:
wandb.login()
  1. Use the example code snippet below as a template to integrate W&B to your Python script:
import wandb

# Start a W&B Run with wandb.init
run = wandb.init(project="my_first_project")

# Save model inputs and hyperparameters in a wandb.config object
config = run.config
config.learning_rate = 0.01

# Model training code here ...

# Log metrics over time to visualize performance with wandb.log
for i in range(10):
    run.log({"loss": ...})

# Mark the run as finished, and finish uploading all data
run.finish()

For example, if the preceding code was stored in a script called train.py:

python train.py

You will see a URL in your terminal logs when your script starts and finishes. Data is staged locally in a directory named wandb relative to your script. Navigate to the W&B App to view a dashboard of your first W&B Experiment. Use the W&B App to compare multiple experiments in a unified place, dive into the results of a single run, and much more!

 

Integrations

Use your favorite framework with W&B. W&B integrations make it fast and easy to set up experiment tracking and data versioning inside existing projects. For more information on how to integrate W&B with the framework of your choice, see W&B Integrations in the W&B Developer Guide.

 

Contribution guidelines

Weights & Biases ❤️ open source, and we welcome contributions from the community! See the Contribution guide for more information on the development workflow and the internals of the wandb library. For wandb bugs and feature requests, visit GitHub Issues or contact [email protected].

 

Academic Researchers

Reach out to W&B Support at [email protected] to get a free academic license for you and your research group.

 

W&B Community

Be a part of the growing W&B Community and interact with the W&B team in our Discord. Stay connected with the latest ML updates and tutorials with W&B Fully Connected.

 

License

MIT License