Skip to main content

PlanPreference

Struct PlanPreference 

Source
pub struct PlanPreference {
    pub max_workspace_bytes: usize,
    pub allow_sm90a: bool,
    pub prefer_backend: Option<BackendKind>,
}
Expand description

Hints that influence kernel selection inside a plan’s select method.

The fields are intentionally generic across kernel families — each op category may layer its own *PlanPreference wrapper on top (e.g. GroupedPlanPreference adds grouped-specific knobs) that embeds this struct.

Fields§

§max_workspace_bytes: usize

Maximum workspace the caller is willing to provide. The selector only considers kernels whose workspace size for the descriptor fits in this budget. Use usize::MAX to disable the constraint.

§allow_sm90a: bool

Allow Hopper-specialized (sm_90a) kernels in selection. Has no effect when the sm90a feature is off in the underlying kernel crate (no such kernels exist in the build).

§prefer_backend: Option<BackendKind>

Force a particular backend at plan-selection time, bypassing the plan’s built-in heuristic.

None (the default) lets the plan’s per-op-category heuristic decide. Some(BackendKind::Cublas) / Some(BackendKind::Cutlass) override the heuristic when a caller has profiling-driven information the heuristic doesn’t have (or wants deterministic kernel selection for golden-output testing).

Plans surface their actual choice through their sku() accessor — inspect sku.backend to see what the heuristic picked.

Returns Error::Unsupported from select if the requested backend doesn’t have a kernel for the requested (layout, epilogue, element) triple. For example, the cuBLAS backend doesn’t support EpilogueKind::BiasRelu (cuBLAS has no fused-bias-activation GEMM); forcing it on a Bias* epilogue returns an error rather than silently falling back to CUTLASS.

Trait Implementations§

Source§

impl Clone for PlanPreference

Source§

fn clone(&self) -> PlanPreference

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 Copy for PlanPreference

Source§

impl Debug for PlanPreference

Source§

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

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

impl Default for PlanPreference

Source§

fn default() -> PlanPreference

Returns the “default value” for a type. Read more

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> 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.