Documentation Index
Fetch the complete documentation index at: https://ray-preview.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Trial
A trial is one run of your training function with one configuration. Tune launches many trials and tracks each one’s metrics, checkpoints, and status.Search space
A search space is a dict of hyperparameter distributions. Tune samples a config from the space for each trial.Search algorithm
A search algorithm decides which configs to try next. Options include random search (default), grid search, Bayesian optimization (Optuna, Ax, BayesOpt), evolutionary search (Nevergrad), and more.Scheduler
A scheduler decides which trials to keep running and which to stop. ASHA, HyperBand, PBT, and PB2 are the most common.Tuner
ATuner ties together the objective, search space, search algorithm, and scheduler.
TuneConfig
| Field | Purpose |
|---|---|
metric / mode | Which metric to optimize, and whether higher or lower is better. |
num_samples | How many trials to run total. -1 means run forever. |
search_alg | Algorithm that proposes configs. |
scheduler | Algorithm that stops/promotes trials. |
max_concurrent_trials | Throttle concurrency. |
Result
tuner.fit() returns a ResultGrid. Inspect with:
Reporting
Inside the objective, push metrics withtune.report:
step.
Trial directory
Each trial has its own working directory with logs, checkpoints, and result.json. The location is<storage_path>/<run_name>/<trial_id>/.
Next steps
Search space
Build complex search spaces.
Search algorithms
Pick the right search algorithm.