Struct CommandTemplate 

pub struct CommandTemplate { /* private fields */ }

A program plus its argument templates: the recipe for one child process.

The program is a literal path or name; each argument may embed {name} holes that a trial’s sampled parameters fill (see the executor documentation for the substitution rules and the trust model).

use atune_core::exec::CommandTemplate;

// `./train.sh --lr={lr} --opt {opt}` — three argv elements, two of which
// carry a hole. Nothing is a shell string.
let template = CommandTemplate::new("./train.sh", ["--lr={lr}", "--opt", "{opt}"])?;
assert_eq!(template.placeholder_names(), ["lr", "opt"]);

Implementations

impl CommandTemplate

pub fn new<P, I, S>(program: P, args: I) -> Result<Self>

where P: Into<OsString>, I: IntoIterator<Item = S>, S: AsRef<str>,

Builds a command template from a program and its argument templates.

Errors

Error::InvalidSpace if any argument has an unterminated, empty, or unbalanced brace.

pub fn program(&self) -> &OsStr

The program that will be spawned.

pub fn placeholder_names(&self) -> Vec<String>

Every placeholder name the arguments reference, in order, deduplicated.

The executor uses this to check, once, that the template only names parameters the search space declares.

Trait Implementations

impl Clone for CommandTemplate

fn clone(&self) -> CommandTemplate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandTemplate

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

Formats the value using the given formatter.

impl Eq for CommandTemplate

impl PartialEq for CommandTemplate

fn eq(&self, other: &CommandTemplate) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CommandTemplate