Metadata-Version: 2.1
Name: wandb
Version: 0.17.3
Summary: A CLI and library for interacting with the Weights & Biases API.
Project-URL: Source, https://github.com/wandb/wandb
Project-URL: Bug Reports, https://github.com/wandb/wandb/issues
Project-URL: Documentation, https://docs.wandb.ai/
Author-email: Weights & Biases <support@wandb.com>
License: MIT License
Copyright (c) 2021 Weights and Biases, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.7
Requires-Dist: click!=8.0.0,>=7.1
Requires-Dist: docker-pycreds>=0.4.0
Requires-Dist: gitpython!=3.1.29,>=1.0.0
Requires-Dist: platformdirs
Requires-Dist: protobuf!=4.21.0,<6,>=3.12.0; python_version < '3.9' and sys_platform == 'linux'
Requires-Dist: protobuf!=4.21.0,<6,>=3.15.0; python_version == '3.9' and sys_platform == 'linux'
Requires-Dist: protobuf!=4.21.0,<6,>=3.19.0; python_version > '3.9' and sys_platform == 'linux'
Requires-Dist: protobuf!=4.21.0,<6,>=3.19.0; sys_platform != 'linux'
Requires-Dist: psutil>=5.0.0
Requires-Dist: pyyaml
Requires-Dist: requests<3,>=2.0.0
Requires-Dist: sentry-sdk>=1.0.0
Requires-Dist: setproctitle
Requires-Dist: setuptools
Requires-Dist: typing-extensions; python_version < '3.10'
Provides-Extra: aws
Requires-Dist: boto3; extra == 'aws'
Provides-Extra: azure
Requires-Dist: azure-identity; extra == 'azure'
Requires-Dist: azure-storage-blob; extra == 'azure'
Provides-Extra: gcp
Requires-Dist: google-cloud-storage; extra == 'gcp'
Provides-Extra: importers
Requires-Dist: filelock; extra == 'importers'
Requires-Dist: mlflow; extra == 'importers'
Requires-Dist: polars; extra == 'importers'
Requires-Dist: rich; extra == 'importers'
Requires-Dist: tenacity; extra == 'importers'
Provides-Extra: kubeflow
Requires-Dist: google-cloud-storage; extra == 'kubeflow'
Requires-Dist: kubernetes; extra == 'kubeflow'
Requires-Dist: minio; extra == 'kubeflow'
Requires-Dist: sh; extra == 'kubeflow'
Provides-Extra: launch
Requires-Dist: awscli; extra == 'launch'
Requires-Dist: azure-containerregistry; extra == 'launch'
Requires-Dist: azure-identity; extra == 'launch'
Requires-Dist: azure-storage-blob; extra == 'launch'
Requires-Dist: boto3; extra == 'launch'
Requires-Dist: botocore; extra == 'launch'
Requires-Dist: chardet; extra == 'launch'
Requires-Dist: google-auth; extra == 'launch'
Requires-Dist: google-cloud-aiplatform; extra == 'launch'
Requires-Dist: google-cloud-artifact-registry; extra == 'launch'
Requires-Dist: google-cloud-compute; extra == 'launch'
Requires-Dist: google-cloud-storage; extra == 'launch'
Requires-Dist: iso8601; extra == 'launch'
Requires-Dist: kubernetes; extra == 'launch'
Requires-Dist: kubernetes-asyncio; extra == 'launch'
Requires-Dist: nbconvert; extra == 'launch'
Requires-Dist: nbformat; extra == 'launch'
Requires-Dist: optuna; extra == 'launch'
Requires-Dist: pydantic; extra == 'launch'
Requires-Dist: pyyaml>=6.0.0; extra == 'launch'
Requires-Dist: tomli; extra == 'launch'
Requires-Dist: typing-extensions; extra == 'launch'
Provides-Extra: media
Requires-Dist: bokeh; extra == 'media'
Requires-Dist: moviepy; extra == 'media'
Requires-Dist: numpy; extra == 'media'
Requires-Dist: pillow; extra == 'media'
Requires-Dist: plotly>=5.18.0; extra == 'media'
Requires-Dist: rdkit-pypi; extra == 'media'
Requires-Dist: soundfile; extra == 'media'
Provides-Extra: models
Requires-Dist: cloudpickle; extra == 'models'
Provides-Extra: perf
Requires-Dist: orjson; extra == 'perf'
Provides-Extra: sweeps
Requires-Dist: sweeps>=0.2.0; extra == 'sweeps'
Provides-Extra: workspaces
Requires-Dist: wandb-workspaces; extra == 'workspaces'
Description-Content-Type: text/markdown
<div align="center">
<img src="https://i.imgur.com/RUtiVzH.png" width="600" /><br><br>
</div>
# Weights and Biases [](https://pypi.python.org/pypi/wandb) [](https://anaconda.org/conda-forge/wandb) [](https://circleci.com/gh/wandb/wandb) [](https://codecov.io/gh/wandb/wandb)
Use W&B to build better models faster. Track and visualize all the pieces of your machine learning pipeline, from datasets to production models.
- Quickly identify model regressions. Use W&B to visualize results in real time, all in a central dashboard.
- Focus on the interesting ML. Spend less time manually tracking results in spreadsheets and text files.
- Capture dataset versions with W&B Artifacts to identify how changing data affects your resulting models.
- Reproduce any model, with saved code, hyperparameters, launch commands, input data, and resulting model weights.
[Sign up for a free account →](https://wandb.ai/login?signup=true)
## Features
- Store hyper-parameters used in a training run
- Search, compare, and visualize training runs
- Analyze system usage metrics alongside runs
- Collaborate with team members
- Replicate historic results
- Run parameter sweeps
- Keep records of experiments available forever
[Documentation →](https://docs.wandb.com)
## Quickstart
```shell
pip install wandb
```
In your training script:
```python
import wandb
# Your custom arguments defined here
args = ...
wandb.init(config=args, project="my-project")
wandb.config["more"] = "custom"
def training_loop():
while True:
# Do some machine learning
epoch, loss, val_loss = ...
# Framework agnostic / custom metrics
wandb.log({"epoch": epoch, "loss": loss, "val_loss": val_loss})
```
If you're already using Tensorboard or [TensorboardX](https://github.com/lanpa/tensorboardX), you can integrate with one line:
```python
wandb.init(sync_tensorboard=True)
```
## Running your script
Run `wandb login` from your terminal to signup or authenticate your machine (we store your api key in ~/.netrc). You can also set the `WANDB_API_KEY` environment variable with a key from your [settings](https://app.wandb.ai/settings).
Run your script with `python my_script.py` and all metadata will be synced to the cloud. 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. If you want to test your script without syncing to the cloud you can set the environment variable `WANDB_MODE=dryrun`.
If you are using [docker](https://docker.com) to run your code, we provide a wrapper command `wandb docker` that mounts your current directory, sets environment variables, and ensures the wandb library is installed. Training your models in docker gives you the ability to restore the exact code and environment with the `wandb restore` command.
## Web Interface
[Sign up for a free account →](https://wandb.com)
[](https://youtu.be/EeqhOSvNX-A)
[Introduction video →](https://youtu.be/EeqhOSvNX-A)
## Detailed Usage
Framework specific and detailed usage can be found in our [documentation](http://docs.wandb.com/).
## Testing
To run basic test use `make test`. More detailed information can be found at CONTRIBUTING.md.
We use [circleci](https://circleci.com) for CI.
# Academic Researchers
If you'd like a free academic account for your research group, [reach out to us →](https://www.wandb.com/academic)
We make it easy to cite W&B in your published paper. [Learn more →](https://www.wandb.com/academic)
[](https://www.wandb.com/academic)
## Community
Got questions, feedback or want to join a community of ML engineers working on exciting projects?
<a href="https://bit.ly/wb-slack"><img src="https://svgshare.com/i/M93.svg" alt="slack" width="55"/></a> Join our [slack](https://bit.ly/wb-slack) community.
[](https://twitter.com/weights_biases) Follow us on [Twitter](https://twitter.com/weights_biases).