pub struct PyDevice { /* private fields */ }Expand description
Python wrapper for ToRSh devices
Represents a computational device where tensors can be allocated and operations executed. Supports CPU, CUDA (NVIDIA GPUs), Metal (Apple Silicon), and WGPU devices.
§Examples
# Create CPU device
cpu = rstorch.PyDevice("cpu")
# Create CUDA device (default index 0)
cuda = rstorch.PyDevice("cuda")
# Create CUDA device with specific index
cuda1 = rstorch.PyDevice("cuda:1")
# Create from integer (defaults to CUDA)
cuda2 = rstorch.PyDevice(2) # cuda:2
# Check device properties
print(cpu.type) # "cpu"
print(cuda1.type) # "cuda"
print(cuda1.index) # 1Trait Implementations§
Source§impl From<DeviceType> for PyDevice
impl From<DeviceType> for PyDevice
Source§fn from(device: DeviceType) -> Self
fn from(device: DeviceType) -> Self
Converts to this type from the input type.
Source§impl From<PyDevice> for DeviceType
impl From<PyDevice> for DeviceType
Source§impl<'a, 'py> FromPyObject<'a, 'py> for PyDevicewhere
Self: Clone,
impl<'a, 'py> FromPyObject<'a, 'py> for PyDevicewhere
Self: Clone,
Source§impl<'py> IntoPyObject<'py> for PyDevice
impl<'py> IntoPyObject<'py> for PyDevice
Source§type Output = Bound<'py, <PyDevice as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyDevice as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClassImpl for PyDevice
impl PyClassImpl for PyDevice
Source§const MODULE: Option<&str> = ::core::option::Option::None
const MODULE: Option<&str> = ::core::option::Option::None
Module which the class will be associated with. Read more
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// Python wrapper for ToRSh devices
///
/// Represents a computational device where tensors can be allocated and operations executed.
/// Supports CPU, CUDA (NVIDIA GPUs), Metal (Apple Silicon), and WGPU devices.
///
/// # Examples
///
/// ```python
/// # Create CPU device
/// cpu = rstorch.PyDevice("cpu")
///
/// # Create CUDA device (default index 0)
/// cuda = rstorch.PyDevice("cuda")
///
/// # Create CUDA device with specific index
/// cuda1 = rstorch.PyDevice("cuda:1")
///
/// # Create from integer (defaults to CUDA)
/// cuda2 = rstorch.PyDevice(2) # cuda:2
///
/// # Check device properties
/// print(cpu.type) # "cpu"
/// print(cuda1.type) # "cuda"
/// print(cuda1.index) # 1
/// ```
const RAW_DOC: &'static CStr = /// Python wrapper for ToRSh devices /// /// Represents a computational device where tensors can be allocated and operations executed. /// Supports CPU, CUDA (NVIDIA GPUs), Metal (Apple Silicon), and WGPU devices. /// /// # Examples /// /// ```python /// # Create CPU device /// cpu = rstorch.PyDevice("cpu") /// /// # Create CUDA device (default index 0) /// cuda = rstorch.PyDevice("cuda") /// /// # Create CUDA device with specific index /// cuda1 = rstorch.PyDevice("cuda:1") /// /// # Create from integer (defaults to CUDA) /// cuda2 = rstorch.PyDevice(2) # cuda:2 /// /// # Check device properties /// print(cpu.type) # "cpu" /// print(cuda1.type) # "cuda" /// print(cuda1.index) # 1 /// ```
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type Layout = <<PyDevice as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyDevice>
type Layout = <<PyDevice as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyDevice>
Description of how this class is laid out in memory
Source§type ThreadChecker = NoopThreadChecker
type ThreadChecker = NoopThreadChecker
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
The closest native ancestor. This is
PyAny by default, and when you declare
#[pyclass(extends=PyDict)], it’s PyDict.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
Source§fn dict_offset() -> Option<PyObjectOffset>
fn dict_offset() -> Option<PyObjectOffset>
Used to provide the dictoffset slot
(equivalent to tp_dictoffset)
Source§fn weaklist_offset() -> Option<PyObjectOffset>
fn weaklist_offset() -> Option<PyObjectOffset>
Used to provide the weaklistoffset slot
(equivalent to tp_weaklistoffset
Source§impl PyClassNewTextSignature for PyDevice
impl PyClassNewTextSignature for PyDevice
const TEXT_SIGNATURE: &'static str = "(device)"
Source§impl PyMethods<PyDevice> for PyClassImplCollector<PyDevice>
impl PyMethods<PyDevice> for PyClassImplCollector<PyDevice>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyDevice
impl PyTypeInfo for PyDevice
Source§const NAME: &str = <Self as ::pyo3::PyClass>::NAME
const NAME: &str = <Self as ::pyo3::PyClass>::NAME
👎Deprecated since 0.28.0:
prefer using ::type_object(py).name() to get the correct runtime value
Class name.
Source§const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
👎Deprecated since 0.28.0:
prefer using ::type_object(py).module() to get the correct runtime value
Module name, if any.
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
impl DerefToPyAny for PyDevice
Auto Trait Implementations§
impl Freeze for PyDevice
impl RefUnwindSafe for PyDevice
impl Send for PyDevice
impl Sync for PyDevice
impl Unpin for PyDevice
impl UnsafeUnpin for PyDevice
impl UnwindSafe for PyDevice
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
👎Deprecated since 0.27.0:
Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.