2020-07-30 22:09:03 +02:00
|
|
|
.. _tune-wandb:
|
|
|
|
|
|
|
|
|
|
Using Weights & Biases with Tune
|
|
|
|
|
================================
|
|
|
|
|
|
2020-12-29 06:49:17 +05:30
|
|
|
`Weights & Biases <https://www.wandb.ai/>`_ (Wandb) is a tool for experiment
|
2020-07-30 22:09:03 +02:00
|
|
|
tracking, model optimizaton, and dataset versioning. It is very popular
|
|
|
|
|
in the machine learning and data science community for its superb visualization
|
|
|
|
|
tools.
|
|
|
|
|
|
|
|
|
|
.. image:: /images/wandb_logo_full.png
|
|
|
|
|
:height: 80px
|
|
|
|
|
:alt: Weights & Biases
|
|
|
|
|
:align: center
|
2020-12-29 06:49:17 +05:30
|
|
|
:target: https://www.wandb.ai/
|
2020-07-30 22:09:03 +02:00
|
|
|
|
|
|
|
|
Ray Tune currently offers two lightweight integrations for Weights & Biases.
|
2020-11-17 00:08:37 +01:00
|
|
|
One is the :ref:`WandbLoggerCallback <tune-wandb-logger>`, which automatically logs
|
2020-07-30 22:09:03 +02:00
|
|
|
metrics reported to Tune to the Wandb API.
|
|
|
|
|
|
|
|
|
|
The other one is the :ref:`@wandb_mixin <tune-wandb-mixin>` decorator, which can be
|
|
|
|
|
used with the function API. It automatically
|
|
|
|
|
initializes the Wandb API with Tune's training information. You can just use the
|
|
|
|
|
Wandb API like you would normally do, e.g. using ``wandb.log()`` to log your training
|
|
|
|
|
process.
|
|
|
|
|
|
|
|
|
|
Please :doc:`see here for a full example </tune/examples/wandb_example>`.
|
|
|
|
|
|
|
|
|
|
.. _tune-wandb-logger:
|
|
|
|
|
|
2020-11-17 00:08:37 +01:00
|
|
|
.. autoclass:: ray.tune.integration.wandb.WandbLoggerCallback
|
2020-08-31 23:30:48 +01:00
|
|
|
:noindex:
|
2020-07-30 22:09:03 +02:00
|
|
|
|
|
|
|
|
.. _tune-wandb-mixin:
|
|
|
|
|
|
|
|
|
|
.. autofunction:: ray.tune.integration.wandb.wandb_mixin
|
2020-08-31 23:30:48 +01:00
|
|
|
:noindex:
|
