Ray Train API

The Ray Train API reference documents Ray Train’s public Python API. Each page below covers one group of APIs, such as a framework integration or the configuration classes.

Important

These API references are for the revamped Ray Train V2 implementation that is available starting from Ray 2.43 by enabling the environment variable RAY_TRAIN_V2_ENABLED=1. These APIs assume that the environment variable has been enabled.

See Ray Train V1 API for the old API references and the Ray Train V2 Migration Guide.

• PyTorch
  • Trainer and configs
  • Training loop utilities
• PyTorch Lightning
• Hugging Face Transformers
• TensorFlow and Keras
• XGBoost
• LightGBM
• JAX
• Configuration
• Training function utilities
  • Classes
  • Functions
  • Collective operations
• Results
• Exceptions
• Ray Tune integration
• Developer APIs
  • Trainer base class
  • Backend base classes
  • Trainer callbacks