bintensors 0.1.1

Bintensors is a high-performance binary tensor serialization format designed to be faster eliminating use of JSON serialization metadata.
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

#![deny(missing_docs)]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/GnosisFoundation/bintensors/refs/heads/master/.github/assets/bintensors-logo.png"
)]
#![doc = include_str!("../DOC_README.md")]
#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(any(feature = "std", feature = "alloc"))]
#[cfg(feature = "slice")]
pub mod slice;
pub mod tensor;
/// serialize_to_file only valid in std
#[cfg(feature = "std")]
pub use tensor::serialize_to_file;
pub use tensor::{serialize, serialize_with_checksum, BinTensorError, BinTensors, Dtype, View};

// TODO: uncomment when all of no_std is ready
#[cfg(feature = "alloc")]
#[macro_use]
extern crate alloc;

#[cfg(all(feature = "std", feature = "alloc"))]
compile_error!("must choose either the `std` or `alloc` feature, but not both.");
#[cfg(all(not(feature = "std"), not(feature = "alloc")))]
compile_error!("must choose either the `std` or `alloc` feature");
#[cfg(all(not(feature = "std"), not(feature = "alloc"), feature = "slice"))]
compile_error!("must choose either the `std` or `alloc` feature to use the slice feature.");

/// A facade around all the types we need from the `std`, `core`, and `alloc`
/// crates. This avoids elaborate import wrangling having to happen in every
/// module.
mod lib {
    // TODO: uncomment when add non-std
    #[cfg(not(feature = "std"))]
    mod no_stds {
        pub use alloc::borrow::Cow;
        pub use alloc::collections::BTreeMap;
        pub use alloc::string::{String, ToString};
        pub use alloc::vec::Vec;
        pub use hashbrown::HashMap;
    }

    #[cfg(feature = "std")]
    mod stds {
        pub use std::borrow::Cow;
        pub use std::collections::{BTreeMap, HashMap};
        pub use std::string::{String, ToString};
        pub use std::vec::Vec;
    }

    /// choose std or no_std to export by feature flag
    #[cfg(not(feature = "std"))]
    pub use no_stds::*;
    #[cfg(feature = "std")]
    pub use stds::*;
}