burn-std 0.23.0-pre.1

Core types and utilities shared across the Burn ecosystem.
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

#![cfg_attr(not(feature = "std"), no_std)]
#![warn(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]

//! # Burn Standard Library
//!
//! Core types and utilities shared across the Burn crates.
//!
//! - [`Shape`], slicing ([`s!`]) and indexing helpers.
//! - [`DType`], the element traits and conversions, and [`TensorData`], the backend-independent
//!   representation of tensor contents.
//! - [`Distribution`] for random tensor initialization.
//! - [`DeviceSettings`], per-device defaults such as dtypes.
//! - Quantization schemes, [`Bytes`], identifiers and errors.
//! - [`config`]: runtime configuration read from `burn.toml`.
//! - `network`: file downloads with a progress bar (`network` feature).
//!
//! Applications use these through `burn::tensor`. The crate supports `no_std` with `alloc`.
//!
//! # Feature flags
//!
//! - `std` (default): standard library support.
//! - `network`: file downloads.
//! - `tracing`: instrument operations with the `tracing` crate.

#[macro_use]
extern crate derive_new;

extern crate alloc;

/// Id module contains types for unique identifiers.
pub mod id;

/// Tensor utilities.
pub mod tensor;
pub use tensor::*;

/// Tensor data representation and helpers.
pub mod data;
pub use data::*;

/// Random value distributions.
pub mod distribution;
pub use distribution::*;

/// Traits for tensor element types and conversions.
pub mod element;
pub use element::*;

mod device_settings;
pub use device_settings::*;

/// Runtime kind of the host program (async / sync / no-std).
pub mod runtime_kind;
pub use runtime_kind::*;

/// Distributed configurations.
pub mod distributed;

/// Configuration types for tensor operations (conv, pool, interpolate, pad, etc).
pub mod ops;
pub use ops::*;

/// Burn runtime configurations.
pub mod config;

/// Common Errors.
pub use cubecl_zspace::errors::{self, *};

/// Network utilities.
#[cfg(feature = "network")]
pub mod network;

pub use cubecl_common::device_handle::DeviceHandle;
pub use cubecl_common::*;
pub use cubecl_environment::bytes::*;

// Environment shims live in `cubecl-environment`. They are re-exported here so
// backends and other burn crates don't have to depend on it directly.
pub use cubecl_environment::future::reader;
pub use cubecl_environment::{backtrace, future, rand, stream, sync};

pub use half::{bf16, f16};

pub use cubecl_common::flex32;