Struct PyTree

pub struct PyTree<T> { /* private fields */ }

A Rust wrapper around A PyTorch pytree, which can be serialized and sent across the wire. https://github.com/pytorch/pytorch/blob/main/torch/utils/_pytree.py

Implementations

impl<T> PyTree<T>

pub fn is_leaf(&self) -> bool

pub fn into_leaf(self) -> Option<T>

pub fn leaves(&self) -> &[T]

pub fn into_leaves(self) -> Vec<T>

pub fn for_each<F>(&self, func: F)

where F: FnMut(&T),

pub fn iter<'a>(&'a self) -> Iter<'a, T>

pub fn iter_mut<'a>(&'a mut self) -> IterMut<'a, T>

pub fn into_map<U, F>(self, func: F) -> PyTree<U>

where F: FnMut(T) -> U,

Map leaf values with the given func.

pub fn try_map<U, F, E>(&self, func: F) -> Result<PyTree<U>, E>

where F: FnMut(&T) -> Result<U, E>,

Map the leaves of the pytree with the given fallible callback.

pub fn try_into_map<U, F, E>(self, func: F) -> Result<PyTree<U>, E>

where F: FnMut(T) -> Result<U, E>,

Map the leaves of the pytree with the given fallible callback.

impl<'a, T: FromPyObject<'a>> PyTree<T>

pub fn flatten(tree: &Bound<'a, PyAny>) -> PyResult<Self>

Trait Implementations

impl<T: Clone> Clone for PyTree<T>

fn clone(&self) -> PyTree<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PyTree<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for PyTree<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for PyTree<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<'a, T: FromPyObject<'a>> FromPyObject<'a> for PyTree<T>

Deserialize from a PyObject.

fn extract_bound(ob: &Bound<'a, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl<'a, 'py, T> IntoPyObject<'py> for &'a PyTree<T>

where &'a T: IntoPyObject<'py>, T: 'a,

type Target = PyAny

The Python output type

type Output = Bound<'py, <&'a PyTree<T> as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error>

Performs the conversion.

impl<'py, T> IntoPyObject<'py> for PyTree<T>

where T: IntoPyObject<'py>,

type Target = PyAny

The Python output type

type Output = Bound<'py, <PyTree<T> as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error>

Performs the conversion.

impl<T> Serialize for PyTree<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, 'py, T> TryIntoPyObjectUnsafe<'py, PyAny> for &'a PyTree<T>

where &'a T: TryIntoPyObjectUnsafe<'py, PyAny>, T: 'a,

Serialize into a PyObject.

unsafe fn try_to_object_unsafe( self, py: Python<'py>, ) -> PyResult<Bound<'py, PyAny>>