Struct ort::IoBinding

source ·
pub struct IoBinding<'s> { /* private fields */ }
Expand description

Enables binding of session inputs and/or outputs to pre-allocated memory.

Note that this arrangement is designed to minimize data copies, and to that effect, your memory allocations must match what is expected by the model, whether you run on CPU or GPU. Data will still be copied if the pre-allocated memory location does not match the one expected by the model. However, copies with IoBindings are only done once, at the time of the binding, not at run time. This means, that if your input data required a copy, your further input modifications would not be seen by ONNX Runtime unless you rebind it, even if it is the same buffer. If your scenario requires that the data is copied, IoBinding may not be the best match for your use case. The fact that data copy is not made during runtime may also have performance implications.

Implementations§

source§

impl<'s> IoBinding<'s>

source

pub fn bind_input<'i: 's, T: ValueTypeMarker, S: AsRef<str>>( &mut self, name: S, ort_value: &'i mut Value<T> ) -> Result<ValueRefMut<'i, T>>

Bind a Value to a session input.

source

pub fn bind_output<'o: 's, T: ValueTypeMarker, S: AsRef<str>>( &mut self, name: S, ort_value: &'o mut Value<T> ) -> Result<ValueRefMut<'o, T>>

Bind a session output to a pre-allocated Value.

source

pub fn bind_output_to_device<S: AsRef<str>>( &mut self, name: S, mem_info: &MemoryInfo ) -> Result<()>

Bind a session output to a device which is specified by mem_info.

source

pub fn run<'i: 's>(&'i self) -> Result<SessionOutputs<'s>>

source

pub fn run_with_options<'i: 's>( &'i self, run_options: Arc<RunOptions> ) -> Result<SessionOutputs<'s>>

Trait Implementations§

source§

impl<'s> Debug for IoBinding<'s>

source§

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

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

impl<'s> Drop for IoBinding<'s>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'s> Freeze for IoBinding<'s>

§

impl<'s> !RefUnwindSafe for IoBinding<'s>

§

impl<'s> !Send for IoBinding<'s>

§

impl<'s> !Sync for IoBinding<'s>

§

impl<'s> Unpin for IoBinding<'s>

§

impl<'s> !UnwindSafe for IoBinding<'s>

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

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

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, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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