Skip to main content

KernelEnvelope

Struct KernelEnvelope 

Source
pub struct KernelEnvelope { /* private fields */ }
Expand description

Builder/configuration for a single run_kernel invocation.

Existing actors that call the free run_kernel function are unaffected — that path still constructs a default envelope internally. Actors that want observability migrate to KernelEnvelope::new(lib).with_trace(..).with_nvtx(..).run_kernel(..).

Implementations§

Source§

impl KernelEnvelope

Source

pub fn new(lib_tag: &'static str) -> Self

Construct a trace-less, NVTX-less envelope tagged with the given library. op_name defaults to lib_tag and can be refined via Self::with_op_name.

Source

pub fn with_op_name(self, op_name: &'static str) -> Self

Override the op identifier surfaced to the trace callback (e.g. "sgemm", "conv2d_forward").

Source

pub fn with_dtype(self, dtype: &'static str) -> Self

Tag the envelope with a dtype name (e.g. "f32", "f16"). Surfaced to trace callbacks as KernelInfo::dtype.

Source

pub fn with_trace(self, trace: Arc<dyn KernelTrace>) -> Self

Attach a KernelTrace callback. Cloning Arc<dyn KernelTrace> is cheap; the same object can be shared across many envelopes.

Source

pub fn with_nvtx(self, name: &'static str) -> Self

Attach an NVTX range label. No-op unless the nvtx cargo feature is enabled.

Source

pub fn run_kernel<O, KA, F>( self, stream: &Arc<CudaStream>, completion: &Arc<dyn CompletionStrategy>, output: O, reply: Sender<Result<O, GpuError>>, enqueue: F, )
where O: Send + 'static, KA: Send + 'static, F: FnOnce() -> Result<KA, GpuError>,

Builder-style equivalent of the free run_kernel function with observability hooks layered in.

Behaviour without a trace and without an NVTX range is byte-for-byte identical to run_kernel.

Trait Implementations§

Source§

impl Clone for KernelEnvelope

Source§

fn clone(&self) -> KernelEnvelope

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KernelEnvelope

Source§

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

Formats the value using the given formatter. 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.

§

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

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<T> Extension for T
where T: Any + Send + Sync,