Skip to main content

ShaderAction

Enum ShaderAction 

Source
pub enum ShaderAction {
    ListKernels,
    Doctor,
    Roofline {
        kernel: String,
        n: u64,
        json: bool,
    },
    ProfileHardware {
        export: Option<PathBuf>,
        json: bool,
    },
    Generate {
        kernel: String,
        target: String,
        schedule: ScheduleArgs,
        out: Option<PathBuf>,
        json: bool,
    },
    Validate {
        input: Option<PathBuf>,
        kernel: String,
        target: String,
        schedule: ScheduleArgs,
        manifest: Option<PathBuf>,
        json: bool,
    },
    Certify {
        kernel: String,
        schedule: ScheduleArgs,
        length: usize,
        warmups: usize,
        samples: usize,
        manifest: Option<PathBuf>,
        cache_dir: Option<PathBuf>,
        dry_run: bool,
    },
    Tune {
        kernel: String,
        length: usize,
        warmups: usize,
        initial_samples: usize,
        finalist_samples: usize,
        finalists: usize,
        max_candidates: usize,
        manifest: Option<PathBuf>,
        cache_dir: Option<PathBuf>,
        dry_run: bool,
    },
    AutoTuneAll {
        length: usize,
        warmups: usize,
        max_candidates: usize,
        cache_dir: Option<PathBuf>,
        update_local_manifest: bool,
        dry_run: bool,
        budget_ms: Option<u64>,
        thermal_limit: Option<f32>,
    },
}

Variants§

§

ListKernels

List deterministic kernels currently known to WGSL Forge.

§

Doctor

Check that the native backend toolchains (wgpu adapter, DXC, CUDA) are present and report how the Forge will degrade if any are missing.

§

Roofline

Print the roofline estimate (FLOP/byte, memory- vs compute-bound) for a kernel.

Fields

§kernel: String
§n: u64

Representative problem size (output elements / records).

§json: bool
§

ProfileHardware

Probe the local adapter and print a rich hardware/topology profile.

Fields

§export: Option<PathBuf>

Write the profile JSON to this path (also prints the topology hash).

§json: bool
§

Generate

Generate one deterministic WGSL module.

Fields

§kernel: String
§target: String

Target backend (wgsl, msl, hlsl, ptx, cuda, spirv)

§schedule: ScheduleArgs
§out: Option<PathBuf>

Write WGSL to this path instead of stdout.

§json: bool

Emit the complete generated record as JSON.

§

Validate

Run Naga parsing and semantic validation.

Fields

§input: Option<PathBuf>

Validate an existing WGSL file; otherwise generate the selected kernel.

§kernel: String
§target: String

Target backend (wgsl, msl, hlsl, ptx, cuda, spirv)

§schedule: ScheduleArgs
§manifest: Option<PathBuf>

Write a Naga-level certification manifest.

§json: bool
§

Certify

Create a real pipeline, compare GPU output with the CPU oracle, and profile it.

Fields

§kernel: String
§schedule: ScheduleArgs
§length: usize
§warmups: usize
§samples: usize
§manifest: Option<PathBuf>
§cache_dir: Option<PathBuf>

Also store the adapter-keyed certification in this cache directory.

§dry_run: bool

Prune/emit/validate only; do not dispatch on the GPU.

§

Tune

Search the bounded schedule space and certify the fastest correct variant.

Fields

§kernel: String
§length: usize
§warmups: usize
§initial_samples: usize
§finalist_samples: usize
§finalists: usize
§max_candidates: usize
§manifest: Option<PathBuf>
§cache_dir: Option<PathBuf>

Also store the adapter-keyed tuning record in this cache directory.

§dry_run: bool

Report adapter-pruned candidate counts only; do not dispatch on the GPU.

§

AutoTuneAll

Tune every GPU-certifiable kernel, reusing the topology-keyed cache.

Fields

§length: usize
§warmups: usize
§max_candidates: usize
§cache_dir: Option<PathBuf>

Cache directory to read existing manifests from and (with –update-local-manifest) write new ones to.

§update_local_manifest: bool

Persist freshly tuned manifests to the cache, keyed by topology.

§dry_run: bool

List what would be tuned vs. served from cache; do not dispatch.

§budget_ms: Option<u64>

Wall-clock tuning budget in milliseconds. Tuning stops before starting a kernel once this elapses (kernel-granular; a true mid-dispatch interrupt is not possible with the synchronous wgpu poll). Remaining kernels are reported as skipped-due-to-budget.

§thermal_limit: Option<f32>

GPU thermal ceiling in degrees Celsius. Between kernels, if the GPU temperature (read via nvidia-smi) is at/above this, tuning waits and re-polls before continuing. Without an nvidia-smi sensor this flag has no effect and a single warning is printed.

Trait Implementations§

Source§

impl Debug for ShaderAction

Source§

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

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

impl FromArgMatches for ShaderAction

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 ShaderAction

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§

§

impl<S, A> Aggregate<Result<S, Error>> for A
where A: Aggregate<S>,

§

fn from_shares<T>(iter: T) -> Result<A, Error>
where T: IntoIterator<Item = Result<S, Error>>,

Aggregate shares in an MPC protocol.
Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,