Struct ExampleParser 

pub struct ExampleParser {

    pub input: PathBuf,
    pub support: usize,
    pub depth: usize,
    pub timeout: f64,
    pub metric: f64,
    pub restart_interval: f64,
    pub max_error: f64,
    pub dynamic: bool,
    pub max_k: Option<usize>,
    pub epsilon: f64,
    pub fast_d2: OptimalDepth2Policy,
    pub cache: CacheType,
    pub print_stats: bool,
    pub always_sort: bool,
    pub heuristic: SearchHeuristic,
    pub step: SearchStepStrategy,
    pub result: PathBuf,
    pub print_tree: bool,
    pub overwrite: bool,
}

Command line arguments of the anytime examples.

Fields

input: PathBuf

Dataset file: one instance per line, label first, binary features

support: usize

Minimum number of instances in each leaf

depth: usize

Maximum depth of the tree

timeout: f64

Time limit in seconds

metric: f64

Not used by the current examples

restart_interval: f64

Length in seconds of one pass of the restart and iterative examples; 0 runs the search uninterrupted and records every improvement

max_error: f64

Initial upper bound on the tree error: only strictly better trees are searched. Used by the restart example (warm start from a known tree)

dynamic: bool

Top-k example: halve k at each level of the tree (Top-k*)

max_k: Option<usize>

Top-k example: stop relaxing at this k instead of the number of features (the incomplete Top-k baseline)

epsilon: f64

Step of the gain and purity rules

fast_d2: OptimalDepth2Policy

Whether to use the depth-2 solver

cache: CacheType

Cache of the subproblems

print_stats: bool

Print the search statistics

always_sort: bool

Sort the features by the heuristic at every node

heuristic: SearchHeuristic

Heuristic used to order the features

step: SearchStepStrategy

How the budget of the search rule grows between passes

result: PathBuf

Directory where the JSON results are written

print_tree: bool

Print the tree

overwrite: bool

Overwrite existing results

Implementations

impl ExampleParser

pub fn new_cache(&self) -> Box<dyn Caching>

A new cache of the chosen type.

pub fn method_name(&self, method: String) -> String

method, followed by -cover with the cover cache so that the results of both caches are kept apart.

Trait Implementations

impl Args for ExampleParser

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 CommandFactory for ExampleParser

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for ExampleParser

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

Formats the value using the given formatter.

impl FromArgMatches for ExampleParser

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.

impl Parser for ExampleParser

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.