dlpark 0.9.0-alpha.1

dlpack Rust binding for Python
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! Shape and stride metadata composed with managed tensor allocations.
//!
//! [`Fixed`](crate::metadata::Fixed) composes compile-time-rank shape and strides;
//! [`Dynamic`](crate::metadata::Dynamic) composes runtime-rank shape and strides.
//! Each part is wrapped in either [`Copied`](crate::metadata::Copied)
//! (values copied into the managed allocation; safe `prepare`) or
//! [`Borrowed`](crate::metadata::Borrowed) (caller-owned `i64` storage borrowed
//! zero-copy; unsafe `prepare_unchecked`, because the arrays must outlive the
//! managed tensor).
//!
//! `prepare::<M>()` returns a `PreparedFixed` / `PreparedDynamic`; calling
//! `initialize(ctx)` on it installs the context and deleter and returns an
//! [`crate::allocation::Initialized`]. `Copied` accepts any integer element
//! implementing `TryInto<i64>` (not just `i64`); an `i64` source takes a
//! `TypeId` fast path through `ptr::copy_nonoverlapping`.

use snafu::Snafu;
mod dynamic;
mod fixed;
mod storage;

pub use dynamic::{Dynamic, PreparedDynamic};
pub use fixed::{Fixed, PreparedFixed};
pub use storage::{Borrowed, Copied};

/// Errors raised while composing shape and stride metadata with an allocation.
#[derive(Debug, Snafu)]
pub enum Error {
    /// The underlying allocation failed.
    #[snafu(transparent)]
    Allocation {
        /// The underlying allocation error.
        source: crate::allocation::Error,
    },

    /// Shape and strides have different lengths.
    #[snafu(display("Mismatched length of shape ({shape_len}) and strides ({strides_len})"))]
    MismatchedLength {
        /// The number of shape dimensions.
        shape_len: usize,
        /// The number of stride entries.
        strides_len: usize,
    },

    /// The dimension count exceeds `i32::MAX`.
    #[snafu(display("Dimension count ({ndim}) exceeds i32::MAX"))]
    NdimOverflow {
        /// The offending dimension count.
        ndim: usize,
        /// The underlying conversion error.
        source: std::num::TryFromIntError,
    },

    /// A shape value at the given axis does not fit in `i64`.
    #[snafu(display("shape value at axis {axis} does not fit in i64"))]
    ShapeValueOverflow {
        /// The axis of the offending value.
        axis: usize,
    },

    /// A stride value at the given axis does not fit in `i64`.
    #[snafu(display("stride value at axis {axis} does not fit in i64"))]
    StrideValueOverflow {
        /// The axis of the offending value.
        axis: usize,
    },
}