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
//! # NeuroLib
//!
//! Single entry point to the workspace: one crate, one `Cargo.toml` input, everything else is included
//! through features - in the same way that crate `burn` collects its subcrates.
//!
//! ```toml
//! [dependencies]
//! neurolib = { version = "0.1", features = ["snn", "wgpu"] }
//! ```
//!
//! | Module | Crate | Feature |
//! |---|---|---|
//! | [`snn`] | `neo-snn` | `snn` |
//! | [`nn`] | `neo-nn` | `nn` |
//! | [`quant`] | `neo-quantization` | `quant` |
//! | [`synk`] | `neo-synk` | `kernels` |
//! | [`store`] | `neo-store` | `store` |
//! | [`core`] | `neo-core` | `core` |
//! | [`io`] | `neo-io` | `io` (`zarr`, `neuro`) |
//! | [`view`] | `neo-view` | `view` |
//! | [`synapse`] | `neo-synapse` | `synapse` |
//!
//! Groups: `ml` (default), `signal`, `full`. GPU: `wgpu`, `cuda`, `rocm`, plus `fusion`.
//! `neo-gui` is an application, not a library, so it's not here.
//!
//! Kernels are reachable from the spiking module, no need to name `neo-synk`:
//!
//! ```ignore
//! use burn::tensor::{Device, Tensor};
//! use neurolib::snn::leaky_scan_forward;
//!
//! let device = Device::wgpu(Default::default());
//! let u = leaky_scan_forward(input, mem0, beta); // wgpu/CUDA/ROCm: fused CubeCL kernel
//! ```
//!
//! `burn` is not re-exported: declare it separately in the project (`burn = "0.22"`, as in workspace).
pub use neo_snn as snn;
pub use neo_nn as nn;
pub use neo_quantization as quant;
pub use neo_synk as synk;
pub use neo_store as store;
pub use neo_core as core;
pub use neo_io as io;
pub use neo_view as view;
pub use neo_synapse as synapse;
/// Everyday names: currently prelude `neo-snn`. The remaining crates are imported via
/// own modules (`neurolib::nn::...`) so that glob import does not produce name conflicts.