bunsen 0.21.0

bunsen is acceleration tooling 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

#![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.
//!
//! # Motivation
//!
//! I've been working on burn extensions and libs for coming on a year and a
//! half; and I've accumulated a number of interesting ideas and demos:
//!
//! * <https://github.com/zspacelabs/wordchipper>
//! * <https://github.com/zspacelabs/bimm>
//! * <https://github.com/zspacelabs/bimm-contracts>
//! * <https://github.com/zspacelabs/zsl-chat>
//! * <https://github.com/crutcher/clockmill>
//!
//! I've also contributed a fair amount of code to the burn ecosystem,
//! and I've written up the over motivation and history on my website: <https://zspacelabs.ai/history/>
//!
//! This library is a work in progress, and I'm working to fold the various
//! utilities and support code from these projects into a single place; where we
//! can closely track the burn release cycle, and minimize the dependency-hell
//! churn problem for writing extensions.
//!
//! I plan on continuing to work on this library, and recruit community
//! involvement for landing and publishing new operators and blocks in a place
//! we can lock down their testings and documentation.
//!
//! ## Organization
//!
//! * [`blocks`] - this is a library of [`burn::module::Module`] components.
//!   This includes simple inner layers, recurrent utility blocks, and entire
//!   model families.
//! * [`burner`] - this is a library of [`burn::module::Module`] lifecycle
//!   components which extend the current functionality of burn.
//! * [`ops`] - this is a library [`burn::tensor::Tensor`] operations.
//! * [`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.
//! * [`contracts`] - this is a library of runtime tensor-shape contracts.
//! * [`errors`] - this is a library of error types and tooling.
//!
//!
//! # Future Components
//!
//! The base libraries have significant features which haven't been polished and
//! stabilized for bunsen yet.
//!
//! * weight/data download disk cache - there are several implementations of
//!   this in my codebase so far, the most robust is probably in the
//!   `wordchipper` code.
//! * shard fetching - being able to bind a family of shards to URL template +
//!   range pattern; with information on the target format; and wire that
//!   smoothly into the download and cache layer. this is also currently in some
//!   of the LLM/chat codebases.
//! * LLM `DataLoader` - a high-performance burn data loader for LLM models,
//!   built on parquet/arrow; and `wordchipper`. This is currently in the
//!   `zsl-chat` codebase.
//! * Data transform pipeline - I did a pretty solid pass over an in-memory data
//!   transform pipeline for images, called `bimm-firehose`; and it is still in
//!   the `bimm` codebase. Something like it is needed to train image models.
//! * `clap` tooling - I've built a lot of burn-related clap tools, and I'm
//!   pretty sure some of the arguments/setup machinery could be shared.
//! * the rest of the `bimm` models.
//! * the `bimm` and `zsl-chat` training demos.
//!
//! ## Crate Features
#![doc = document_features::document_features!()]

extern crate alloc;
extern crate core;

/// Re-export public dependencies.
#[allow(unused_imports)]
#[allow(missing_docs)]
pub mod public {
    pub use burn;
    pub use hashbrown;
}

#[cfg(feature = "cache")]
pub use bunsen_cache as cache;
// Make the macro targets public.
// TODO: re-examine contracts publication.

pub mod blocks;
pub mod burner;
pub mod errors;
pub mod ops;
pub mod support;
pub mod zspace;

#[doc(hidden)]
pub use bunsen_contracts_macros::shape_contract as __proc_shape_contract;
pub mod contracts;