Expand description
§Burn Standard Library
This library contains core types and utilities shared across Burn, including shapes, indexing, and data types.
Re-exports§
pub use tensor::*;
Modules§
- benchmark
- Module for benchmark timings
- bytes
serde - Utilities module to manipulate bytes.
- device
- Device module.
- format
- Format utilities.
- future
- Future utils with a compatible API for native, non-std and wasm environments.
- id
- Id module contains types for unique identifiers.
- map
- Map utilities and implementations.
- profile
- Module for profiling any executable part
- quant
- Quantization primitives required outside of
cubecl-quant - rand
- Rand module contains types for random number generation for non-std environments and for std environments.
- reader
- Useful when you need to read async data without having to decorate each function with async notation.
- stream_
id - Stream id related utilities.
- stub
- Stub module contains types for stubs for non-std environments and for std environments.
- tensor
- Tensor utilities.
Macros§
- s
- Slice argument constructor for tensor indexing.
Structs§
- Bytes
- A buffer similar to
Box<[u8]>that supports custom memory alignment and allows trailing uninitialized bytes. - CubeDim
- bf16
- A 16-bit floating point type implementing the
bfloat16format. - e2m3
- A 6-bit floating point type with 2 exponent bits and 3 mantissa bits.
- e3m2
- A 6-bit floating point type with 3 exponent bits and 2 mantissa bits.
- e4m3
- A 8-bit floating point type with 4 exponent bits and 3 mantissa bits.
- e5m2
- A 8-bit floating point type with 5 exponent bits and 2 mantissa bits.
- f16
- A 16-bit floating point type implementing the IEEE 754-2008 standard
binary16a.k.a “half” format. - flex32
- A floating point type with relaxed precision, minimum
f16, max [f32]. - tf32
- A 19-bit floating point type implementing the
tfloat32format. - ue8m0
- An 8-bit unsigned floating point type with 8 exponent bits and no mantissa bits. Used for scaling factors.
Enums§
- Allocation
Error - Errors that may occur during memory allocation operations.
- Allocation
Property - The kind of allocation bahind the Bytes type.
- Execution
Mode - The kind of execution to be performed.
- Split
Error - Error when splitting an allocation.
Constants§
- PLANE_
DIM_ APPROX - An approximation of the plane dimension.
Traits§
- Allocation
Controller - Defines how an [Allocation] can be controlled.