Ray Tune API

Tip

We’d love to hear your feedback on using Tune - get in touch!

This section contains a reference for the Tune API. If there is anything missing, please open an issue on Github.

• Tune Execution (Tuner, tune.Experiment)
  • Tuner
  • tune.run_experiments
  • tune.Experiment
  • tune.SyncConfig
• Training in Tune (tune.Trainable, session.report)
  • Tune’s Function API
  • Tune’s Trainable Class API
  • Comparing Tune’s Function API and Class API
  • Advanced Resource Allocation
  • session (Function API)
  • tune.Trainable (Class API)
  • Utilities
  • tune.with_parameters
  • tune.with_resources
• Tune Search Space API
  • Random Distributions API
  • Grid Search API
  • References
• Tune Search Algorithms (tune.search)
  • Saving and Restoring Tune Runs
  • Random search and grid search (tune.search.basic_variant.BasicVariantGenerator)
  • Ax (tune.search.ax.AxSearch)
  • Bayesian Optimization (tune.search.bayesopt.BayesOptSearch)
  • BOHB (tune.search.bohb.TuneBOHB)
  • BlendSearch (tune.search.flaml.BlendSearch)
  • CFO (tune.search.flaml.CFO)
  • Dragonfly (tune.search.dragonfly.DragonflySearch)
  • HEBO (tune.search.hebo.HEBOSearch)
  • HyperOpt (tune.search.hyperopt.HyperOptSearch)
  • Nevergrad (tune.search.nevergrad.NevergradSearch)
  • Optuna (tune.search.optuna.OptunaSearch)
  • SigOpt (tune.search.sigopt.SigOptSearch)
  • Scikit-Optimize (tune.search.skopt.SkOptSearch)
  • ZOOpt (tune.search.zoopt.ZOOptSearch)
  • Repeated Evaluations (tune.search.Repeater)
  • ConcurrencyLimiter (tune.search.ConcurrencyLimiter)
  • Custom Search Algorithms (tune.search.Searcher)
  • Shim Instantiation (tune.create_searcher)
• Tune Trial Schedulers (tune.schedulers)
  • ASHA (tune.schedulers.ASHAScheduler)
  • HyperBand (tune.schedulers.HyperBandScheduler)
  • Median Stopping Rule (tune.schedulers.MedianStoppingRule)
  • Population Based Training (tune.schedulers.PopulationBasedTraining)
  • Population Based Training Replay (tune.schedulers.PopulationBasedTrainingReplay)
  • Population Based Bandits (PB2) (tune.schedulers.pb2.PB2)
  • BOHB (tune.schedulers.HyperBandForBOHB)
  • ResourceChangingScheduler
  • FIFOScheduler
  • TrialScheduler
  • Shim Instantiation (tune.create_scheduler)
• Tune Stopping mechanisms (tune.stopper)
  • Stopper (tune.Stopper)
  • MaximumIterationStopper (tune.stopper.MaximumIterationStopper)
  • ExperimentPlateauStopper (tune.stopper.ExperimentPlateauStopper)
  • TrialPlateauStopper (tune.stopper.TrialPlateauStopper)
  • TimeoutStopper (tune.stopper.TimeoutStopper)
  • CombinedStopper (tune.stopper.CombinedStopper)
• ResultGrid (tune.ResultGrid)
• Result (air.Result)
• ExperimentAnalysis (tune.ExperimentAnalysis)
• Tune Console Output (Reporters)
  • CLIReporter
  • JupyterNotebookReporter
  • ProgressReporter
• Syncing in Tune (tune.SyncConfig, tune.Syncer)
  • SyncConfig
  • Syncer
• Tune Loggers (tune.logger)
  • Viskit
  • TBXLogger
  • JsonLogger
  • CSVLogger
  • MLFlowLogger
  • WandbLogger
  • LoggerCallback
• Environment variables used by Ray Tune
• Tune Scikit-Learn API (tune.sklearn)
  • TuneGridSearchCV
  • TuneSearchCV
• External library integrations for Ray Tune (tune.integration)
  • Comet (tune.integration.comet)
  • Keras (tune.integration.keras)
  • MLflow (tune.integration.mlflow)
  • MXNet (tune.integration.mxnet)
  • PyTorch Lightning (tune.integration.pytorch_lightning)
  • Weights and Biases (tune.integration.wandb)
  • XGBoost (tune.integration.xgboost)
  • LightGBM (tune.integration.lightgbm)
• Tune Internals
  • RayTrialExecutor
  • TrialRunner
  • Trial
  • Callbacks
  • PlacementGroupFactory
  • Registry
• Tune Client API
• Tune CLI (Experimental)