Skip to main content

Module cli

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.
DoctorArgs
atune doctor — read a study and report findings that likely cost you budget.
ExportArgs
atune export --optuna — write a study as an Optuna journal file.
ImportArgs
atune import — read an Optuna journal file into an atune storage.
ImportanceArgs
atune importance — rank a study’s parameters by hyperparameter importance.
ReportArgs
atune report — write a study as a self-contained static HTML report.
RunArgs
atune run — the one-shot subprocess tuner.
ServeArgs
atune serve — expose a study over TCP for remote workers.
StudyQuery
atune best / atune trials — read a study back.
TellArgs
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§

AggregateKind
How the per-seed values of a multi-seed fan collapse into one objective.
Command
The subcommands.
OutputFormat
How to render a read command’s output.
PairingKind
How a replicate’s seed depends on the trial.
SamplerChoiceKind
Which sampler atune doctor --sampler names, for comparison against what the study should be using.
SamplerKind
Which sampler a subcommand uses.