Wandb Export
A package to export runs from a WandB project to a local folder.
Relies on Hydra for configuration management but can still be used as a CLI tool by automatically creating a default config file.
For each run, it will export :
- the config file used for the run in a yaml file
- the metrics in a csv file
- the image URLs
- metadata such as ID or run name
- the histograms in a csv file (optional)
Installation
pip install -r requirements.txt
pip install wandb-export
Usage
First, you will need to initialize your config folder with the following command:
wandb-export-init-config
This will create a directory ./configs_wandb_export/ in your current working directory that the package will use as Hydra's config directory. It will include a file config_default.yaml that will be used by default.
Fill that config file as explained below and then you can run the following command to export the runs:
wandb-export
Or to use a different config file:
wandb-export --config-name=<config_name>.yaml
Configuration
The configuration file is a Hydra config file. Fields are explained below:
# The name of the WandB project to use.
project: user/project
# The filters that will be applied to the config for accepting a run, following WandB filters. Example:
filters:
"summary_metrics._step":
"$gte": 50000
"config.benchmark_name": bench19_fp_hc
# How many samples maximal to use for the plot.
samples: 10000
# The minimum number of metrics to have in the run to be considered.
min_n_metrics: 0
# Which data types to log.
data_types:
scalar : True
histogram : False
image_url: True
config : True
metadata : True
Python API
You can also use the package as a Python API:
from wandb_export import export_wandb_data
export_wandb_data()
It will use the same configuration file as the CLI tool.
Metadata
Release files for wandb-export 1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wandb_export-1.0.tar.gz | 6.0 kB | Without provenance | Details for wandb_export-1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| wandb_export-1.0-py3-none-any.whl | Python 3 | none | any | Details for wandb_export-1.0-py3-none-any.whl |
Total release size: 13.2 kB
Release files / wandb_export-1.0.tar.gz
| Download URL | wandb_export-1.0.tar.gz |
|---|---|
| Size | 6.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ba50005a589d885e13762fcf7a10e2dbd8539246be1758b905932e973002e314
|
|
BLAKE2b-256 checksum How to use checksums |
8bc7167792ea110812605288690553c8e99eb2e63e3bbf37cf83d866b90edc8c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.7
|
Release files / wandb_export-1.0-py3-none-any.whl
| Download URL | wandb_export-1.0-py3-none-any.whl |
|---|---|
| Size | 7.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
560d9a08deeccf1a3f00b5552628ed90623daabb0fcee66429a4023178f23496
|
|
BLAKE2b-256 checksum How to use checksums |
e21fb004501a5fc9f875831ef10f405f3f239575060dd158400dd20e34481c1d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.7
|
Security for wandb-export 1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.