Module cli
Expand description
The command-line surface, as clap derive types.
The subcommands (CLI reference):
run (the headline
one-shot tuner), the scripted ask/tell handshake, the best/trials
porcelain, export (the Optuna-journal writer — the phase-0
optuna-dashboard on-ramp), import (its M5.1 reverse — an Optuna-journal
reader), the phase-1 viewers top (a live terminal view) and report (a
self-contained static HTML report), importance (PED-ANOVA parameter
ranking), doctor (budget diagnostics), and serve (M5.2 — expose a study
over TCP so remote workers can share it through RemoteStorage).
Structs§
- AskArgs
atune ask— sample one parameter for the current (or a fresh) trial.- Cli
atune— tune any program through its flags, its environment, or a scripted ask/tell loop. The study lives in one journal file; there is no daemon.- Doctor
Args atune doctor— read a study and report findings that likely cost you budget.- Export
Args atune export --optuna— write a study as an Optuna journal file.- Import
Args atune import— read an Optuna journal file into an atune storage.- Importance
Args atune importance— rank a study’s parameters by hyperparameter importance.- Report
Args atune report— write a study as a self-contained static HTML report.- RunArgs
atune run— the one-shot subprocess tuner.- Serve
Args atune serve— expose a study over TCP for remote workers.- Study
Query atune best/atune trials— read a study back.- Tell
Args atune tell— complete the current trial with its objective value(s).- TopArgs
atune top— a live terminal view of a study, read from its journal.
Enums§
- Aggregate
Kind - How the per-seed values of a multi-seed fan collapse into one objective.
- Command
- The subcommands.
- Output
Format - How to render a read command’s output.
- Pairing
Kind - How a replicate’s seed depends on the trial.
- Sampler
Choice Kind - Which sampler
atune doctor --samplernames, for comparison against what the study should be using. - Sampler
Kind - Which sampler a subcommand uses.