Skip to main content

Commands

Enum Commands 

Source
pub enum Commands {
    Profile {
        target: ProfileTarget,
    },
    Bench {
        bench: String,
        counters: Option<String>,
        check_regression: bool,
        threshold: f64,
        roofline: bool,
    },
    Roofline {
        target: String,
        kernels: Option<String>,
        export: Option<String>,
        empirical: bool,
    },
    Diff {
        baseline: Option<String>,
        current: Option<String>,
        before: Option<String>,
        after: Option<String>,
    },
    Contract {
        action: ContractAction,
    },
    Trace {
        binary: String,
        duration: Option<String>,
    },
    Explain {
        target: String,
        kernel: Option<String>,
    },
    Tui,
    Baseline {
        save: Option<String>,
        load: Option<String>,
    },
    Doctor,
    Compete {
        workload: String,
        ours: String,
        theirs: Vec<String>,
        label: Option<String>,
    },
}
Expand description

Top-level cgp subcommands.

Variants§

§

Profile

Profile a kernel or function (runtime execution)

Fields

§

Bench

Enhanced criterion benchmarking with hardware counters

Fields

§bench: String

Benchmark name

§counters: Option<String>

Hardware counters to collect (comma-separated)

§check_regression: bool

Check regression against saved baseline

§threshold: f64

Regression threshold percentage

§roofline: bool

Overlay roofline model

§

Roofline

Generate roofline model for target hardware

Fields

§target: String

Target backend (cuda, avx2, avx512, neon, wgpu)

§kernels: Option<String>

Kernels to plot on roofline

§export: Option<String>

Export to file

§empirical: bool

Use empirical measurement instead of spec values

§

Diff

Compare two profiles (git integration)

Fields

§baseline: Option<String>

Baseline commit or profile path

§current: Option<String>

Current commit or profile path

§before: Option<String>

Before commit

§after: Option<String>

After commit

§

Contract

Verify performance contracts (CI/CD gate)

Fields

§

Trace

System-wide timeline (wraps nsys)

Fields

§binary: String

Binary to trace

§duration: Option<String>

Trace duration

§

Explain

Static code analysis (wraps trueno-explain)

Fields

§target: String

Analysis target (ptx, simd, wgsl)

§kernel: Option<String>

Kernel name

§

Tui

Interactive TUI exploration mode

§

Baseline

Save/load performance baselines

Fields

§save: Option<String>

Save current profile as baseline

§load: Option<String>

Load baseline from file

§

Doctor

Check tool availability and hardware capabilities

§

Compete

Head-to-head competitor comparison

Fields

§workload: String

Workload name (e.g., gemm)

§ours: String

Our command

§theirs: Vec<String>

Competitor commands (can be repeated)

§label: Option<String>

Labels for each entry (comma-separated)

Trait Implementations§

Source§

impl Clone for Commands

Source§

fn clone(&self) -> Commands

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Commands

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for Commands

Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Assign values from ArgMatches to self.
Source§

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

Assign values from ArgMatches to self.
Source§

impl Subcommand for Commands

Source§

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.