Struct AskArgs 

pub struct AskArgs {
    pub study: Option<PathBuf>,
    pub name: String,
    pub spec: String,
    pub seed: u64,
    pub maximize: bool,
    pub sampler: SamplerKind,
    pub study_name: Option<String>,
}

atune ask — sample one parameter for the current (or a fresh) trial.

Fields

study: Option<PathBuf>

The journal file (defaults to $ATUNE_JOURNAL).

Journal files are plaintext. Require restrictive file permissions, an encrypted volume, and protected backups (encrypted when transferred).

name: String

The parameter name.

spec: String

The distribution, as a DSL spec — e.g. loguniform(1e-4,1e-1).

seed: u64

The study seed — only used when the study is first created.

maximize: bool

Maximize (first-create only; matters for best, not for sampling).

sampler: SamplerKind

Which sampler chooses the value.

study_name: Option<String>

A name for the study — only used when the study is first created.

Trait Implementations

impl Args for AskArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Debug for AskArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for AskArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.