zyx_core/lib.rs
1//! # zyx-core
2//!
3//! zyx-core is core part of zyx machine learning library.
4//! zyx-core contains definitions and functions for tensor, backend, generic
5//! runtime with autograd implementation, dtype, shape, scalar, axes, view
6//! and generic compiler for backends like opencl, cuda and wgpu.
7//!
8//!
9//! For README, quick tutorial and source code, please visit [https://www.github.com/zk4x/zyx].
10//!
11//! For more details, there is a [book](https://www.github.com/zk4x/zyx/tree/main/zyx-book).
12#![no_std]
13#![forbid(unsafe_code)]
14#![forbid(rustdoc::broken_intra_doc_links)]
15#![forbid(rustdoc::private_intra_doc_links)]
16#![forbid(missing_docs)]
17#![forbid(rustdoc::missing_crate_level_docs)]
18//#![forbid(rustdoc::missing_doc_code_examples)]
19#![forbid(rustdoc::private_doc_tests)]
20#![forbid(rustdoc::invalid_codeblock_attributes)]
21#![forbid(rustdoc::invalid_html_tags)]
22#![forbid(rustdoc::invalid_rust_codeblocks)]
23#![forbid(rustdoc::bare_urls)]
24#![forbid(rustdoc::unescaped_backticks)]
25#![forbid(rustdoc::redundant_explicit_links)]
26
27extern crate alloc;
28#[cfg(feature = "std")]
29extern crate std;
30
31/// See [Axes](axes::Axes)
32pub mod axes;
33/// See [Backend](backend::Backend)
34pub mod backend;
35/// See [DType](dtype::DType)
36pub mod dtype;
37/// See [ZyxError](error::ZyxError)
38pub mod error;
39/// Saving and loading of tensors from disk
40#[cfg(feature = "std")]
41pub mod io;
42/// See [Node](node::Node)
43pub mod node;
44/// See [Runtime](runtime::Runtime)
45pub mod runtime;
46/// See [Scalar](scalar::Scalar)
47pub mod scalar;
48/// See [Shape](shape::Shape)
49pub mod shape;
50/// See [Tensor](tensor::Tensor)
51pub mod tensor;
52/// Some common utilities.
53pub mod utils;
54/// See [View](view::View)
55pub mod view;