Struct WithCpuCopy

Source
pub struct WithCpuCopy<T: AsModule> { /* private fields */ }
Expand description

Wraps a module to have a lazily-initialized CPU copy if not already in CPU memory.

This is useful for models used both in training and in simulation because large batch size training is most efficient on the GPU while batch-size-1 simulation is most efficient on the CPU.

Implementations§

Source§

impl<T: AsModule> WithCpuCopy<T>

Source

pub const fn new(inner: T, device: Device) -> Self

Source§

impl<T: AsModule> WithCpuCopy<T>

Source

pub const fn as_inner(&self) -> &T

Get a reference to the inner struct.

Source

pub fn as_inner_mut(&mut self) -> &mut T

Get a mutable reference to the inner struct. Invalidates the cached CPU copy if any.

Source

pub fn shallow_clone_module_cpu(&self) -> T::Module

Create a shallow clone of the module on CPU memory.

If the module is not already on the CPU device then a cached deep copy is created on the CPU first. This cached copy is reused on future calls.

Trait Implementations§

Source§

impl<T: AsModule> AsModule for WithCpuCopy<T>

Source§

fn as_module_mut(&mut self) -> &mut Self::Module

Get mutable reference to the module. Invalidates the cached CPU copy if any.

Source§

type Module = <T as AsModule>::Module

Source§

fn as_module(&self) -> &Self::Module

Source§

fn batch_map<F: Fn(Tensor) -> Tensor>(self, f: F) -> BatchMap<Self, F>
where Self: Sized,

Apply a batch-structure-preserving function to the module output.
Source§

impl<T: AsModule + Clone> Clone for WithCpuCopy<T>

Source§

fn clone(&self) -> Self

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<T: AsModule + Debug> Debug for WithCpuCopy<T>

Source§

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

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

impl<'de, T> Deserialize<'de> for WithCpuCopy<T>
where T: Deserialize<'de> + AsModule,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T: AsModule + PartialEq> PartialEq for WithCpuCopy<T>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<P: Policy> Policy for WithCpuCopy<P>

Source§

type PolicyModule = <P as Policy>::PolicyModule

Source§

fn update<AS: ParameterizedDistributionSpace<Tensor> + ?Sized>( &mut self, features: &dyn HistoryFeatures, advantages: PackedTensor, action_space: &AS, logger: &mut dyn StatsLogger, )

Update the policy module. Read more
Source§

fn actor<OS, AS>( &self, observation_space: NonEmptyFeatures<OS>, action_space: AS, ) -> PolicyActor<OS, AS, Self::Module>

Create an actor for the policy module.
Source§

impl<T> Serialize for WithCpuCopy<T>
where T: Serialize + AsModule,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for WithCpuCopy<T>

§

impl<T> !RefUnwindSafe for WithCpuCopy<T>

§

impl<T> Send for WithCpuCopy<T>
where T: Send, <T as AsModule>::Module: Send,

§

impl<T> !Sync for WithCpuCopy<T>

§

impl<T> Unpin for WithCpuCopy<T>
where T: Unpin, <T as AsModule>::Module: Unpin,

§

impl<T> UnwindSafe for WithCpuCopy<T>
where T: UnwindSafe, <T as AsModule>::Module: UnwindSafe,

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

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert into an Any trait reference.
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> 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> Same for T

Source§

type Output = T

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> Wrap for T

Source§

fn wrap<W>(self, wrapper: W) -> Wrapped<Self, W>

Wrap in the given wrapper.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,