mirror of
https://github.com/vale981/ray
synced 2025-03-09 04:46:38 -04:00
5cc9355303
Continuing docs overhaul, tune now has: - [x] better landing page - [x] a getting started guide - [x] user guide was cut down, partially merged with FAQ, and partially integrated with tutorials - [x] the new user guide contains guides to tune features and practical integrations - [x] we rewrote some of the feature guides for clarity - [x] we got rid of sphinx-gallery for this sub-project (only data and core left), as it looks bad and is unnecessarily complicated anyway (plus, makes the build slower) - [x] sphinx-gallery examples are now moved to markdown notebook, as started in #22030. - [x] Examples are tested in the new framework, of course. There's still a lot one can do, but this is already getting too large. Will follow up with more fine-tuning next week. Co-authored-by: Antoni Baum <antoni.baum@protonmail.com> Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
114 lines
2.8 KiB
ReStructuredText
114 lines
2.8 KiB
ReStructuredText
.. _tune-integration:
|
|
|
|
External library integrations (tune.integration)
|
|
================================================
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 1
|
|
|
|
|
|
.. _tune-integration-docker:
|
|
|
|
Docker (tune.integration.docker)
|
|
--------------------------------
|
|
|
|
.. autofunction:: ray.tune.integration.docker.DockerSyncer
|
|
|
|
|
|
.. _tune-integration-keras:
|
|
|
|
Keras (tune.integration.keras)
|
|
------------------------------------------------------
|
|
|
|
.. autoclass:: ray.tune.integration.keras.TuneReportCallback
|
|
|
|
.. autoclass:: ray.tune.integration.keras.TuneReportCheckpointCallback
|
|
|
|
.. _tune-integration-kubernetes:
|
|
|
|
Kubernetes (tune.integration.kubernetes)
|
|
----------------------------------------
|
|
|
|
.. autofunction:: ray.tune.integration.kubernetes.NamespacedKubernetesSyncer
|
|
|
|
.. _tune-integration-mlflow:
|
|
|
|
MLflow (tune.integration.mlflow)
|
|
--------------------------------
|
|
|
|
:ref:`See also here <tune-mlflow-ref>`.
|
|
|
|
.. autoclass:: ray.tune.integration.mlflow.MLflowLoggerCallback
|
|
|
|
.. autofunction:: ray.tune.integration.mlflow.mlflow_mixin
|
|
|
|
|
|
.. _tune-integration-mxnet:
|
|
|
|
MXNet (tune.integration.mxnet)
|
|
------------------------------
|
|
|
|
.. autoclass:: ray.tune.integration.mxnet.TuneReportCallback
|
|
|
|
.. autoclass:: ray.tune.integration.mxnet.TuneCheckpointCallback
|
|
|
|
|
|
.. _tune-integration-pytorch-lightning:
|
|
|
|
PyTorch Lightning (tune.integration.pytorch_lightning)
|
|
------------------------------------------------------
|
|
|
|
.. autoclass:: ray.tune.integration.pytorch_lightning.TuneReportCallback
|
|
|
|
.. autoclass:: ray.tune.integration.pytorch_lightning.TuneReportCheckpointCallback
|
|
|
|
.. _tune-integration-torch:
|
|
|
|
Torch (tune.integration.torch)
|
|
------------------------------
|
|
|
|
.. autofunction:: ray.tune.integration.torch.DistributedTrainableCreator
|
|
|
|
.. autofunction:: ray.tune.integration.torch.distributed_checkpoint_dir
|
|
|
|
.. autofunction:: ray.tune.integration.torch.is_distributed_trainable
|
|
|
|
|
|
.. _tune-integration-horovod:
|
|
|
|
Horovod (tune.integration.horovod)
|
|
----------------------------------
|
|
|
|
.. autofunction:: ray.tune.integration.horovod.DistributedTrainableCreator
|
|
|
|
.. _tune-integration-wandb:
|
|
|
|
Weights and Biases (tune.integration.wandb)
|
|
-------------------------------------------
|
|
|
|
:ref:`See also here <tune-wandb-ref>`.
|
|
|
|
.. autoclass:: ray.tune.integration.wandb.WandbLoggerCallback
|
|
|
|
.. autofunction:: ray.tune.integration.wandb.wandb_mixin
|
|
|
|
|
|
.. _tune-integration-xgboost:
|
|
|
|
XGBoost (tune.integration.xgboost)
|
|
----------------------------------
|
|
|
|
.. autoclass:: ray.tune.integration.xgboost.TuneReportCallback
|
|
|
|
.. autoclass:: ray.tune.integration.xgboost.TuneReportCheckpointCallback
|
|
|
|
|
|
.. _tune-integration-lightgbm:
|
|
|
|
LightGBM (tune.integration.lightgbm)
|
|
------------------------------------
|
|
|
|
.. autoclass:: ray.tune.integration.lightgbm.TuneReportCallback
|
|
|
|
.. autoclass:: ray.tune.integration.lightgbm.TuneReportCheckpointCallback
|