Skip to main content

Execution

Struct Execution 

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

Resolved resources and policies used to execute models.

Implementations§

Source§

impl Execution

Source

pub fn local(options: ExecutionOptions) -> RuntimeResult<Self>

Creates a non-distributed execution context from options.

§Errors

Returns [RuntimeError] when the requested backend or precision is unavailable, GPU initialization fails, or the CPU thread pool cannot be created.

Source

pub fn requested_device(&self) -> &Device

Returns the device requested when this context was created.

Source

pub fn precision(&self) -> Precision

Returns the resolved numeric precision.

Source

pub fn autodiff_mode(&self) -> AutodiffMode

Returns the automatic-differentiation strategy.

Source

pub fn normalization_mode(&self) -> NormalizationMode

Returns the accepted-normalization policy.

Source

pub fn thread_policy(&self) -> ThreadPolicy

Returns the CPU worker-thread policy.

Source

pub fn jit_policy(&self) -> JitPolicy

Returns the CPU JIT policy.

Source

pub fn partitioning(&self) -> Partitioning

Returns the distributed dataset-partitioning strategy.

Source

pub fn memory_state(&self) -> &MemoryState

Returns the live memory state shared by this execution.

Source

pub fn host_memory(&self) -> &MemoryPool

Returns the resolved host-memory pool.

Source

pub fn device_memory(&self) -> Option<&MemoryPool>

Returns the resolved accelerator-memory pool, if any.

Source

pub fn memory_report(&self) -> MemoryReport

Returns current physical-resource memory information.

Source

pub fn memory_pool_reports(&self) -> Vec<MemoryPoolReport>

Returns the resolved execution-pool reports.

Source

pub fn memory_decisions(&self) -> Vec<MemoryDecision>

Returns memory-derived decisions recorded by this execution.

Source

pub fn record_memory_decision(&self, decision: MemoryDecision)

Records a memory-planning decision for later diagnostics.

Source

pub fn rank(&self) -> usize

Returns the zero-based rank of this process.

Source

pub fn nranks(&self) -> usize

Returns the number of participating ranks.

Source

pub fn is_distributed(&self) -> bool

Returns whether this context spans more than one rank.

Trait Implementations§

Source§

impl Clone for Execution

Source§

fn clone(&self) -> Execution

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 Execution

Source§

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

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

impl Default for Execution

Source§

fn default() -> Self

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> Any for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Source§

fn type_name(&self) -> &'static str

Source§

impl<T> AnySync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.