bunsen 0.28.0

bunsen is a batteries included common library for burn
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

#![cfg_attr(feature = "wgpu", recursion_limit = "512")]
#![warn(missing_docs)]
//!# bunsen
//!
//! `bunsen` aims to be a "batteries included" complementary
//! community standard library for extending the [burn](https://burn.dev) tensor library.
//!
//! ## Organization
//!
//! ### Burn Extensions
//!
//! * [`burner`] - this is a library of [`burn::module::Module`] lifecycle
//!   components that extend the current functionality of burn.
//!   * [`module::reflection`](`burner::module::reflection`) has powerful tools
//!     for dynamic [`burn::module::Module`] reflection.
//!   * [`optim`](`burner::optim`) has parameter-group optimizer extensions.
//! * [`contracts`] - this is a library of runtime tensor-shape contracts.
//!
//! ### Component Libraries
//!
//! * [`blocks`] - this is a library of [`burn::module::Module`] components.
//!   This includes simple inner layers, recurrent utility blocks, and entire
//!   model families.
//! * [`ops`] - this is a library [`burn::tensor::Tensor`] operations.
//! * [`kits`] - this is a library of full models and simulation kits.
//!
//! ### App and Testing Support Libs
//!
//! * [`errors`] - this is a library of error types and tooling.
//! * [`support`] - this is a library of support functions for bunsen, including
//!   testing tooling which may be useful for clients.
//! * [`zspace`] - this is a library of z-space / index utilities.
//!
//! ## Crate Features
#![doc = document_features::document_features!()]

extern crate alloc;
extern crate core;

// Make the macro targets public.
// TODO: re-examine contracts publication.
#[doc(hidden)]
pub use bunsen_contracts_macros::shape_contract as __proc_shape_contract;

/// Re-exports public dependencies.
#[allow(unused_imports)]
#[allow(missing_docs)]
pub mod public {
    pub use burn;
    #[cfg(feature = "train")]
    pub use hashbrown;
}

pub mod blocks;
pub mod burner;
pub mod contracts;
pub mod data;
pub mod errors;
pub mod kits;
pub mod ops;
pub mod support;
pub mod zspace;