concision_neural/
lib.rs

1/*
2    Appellation: concision-neural <library>
3    Contrib: @FL03
4*/
5//! The neural network abstractions used to create and train models.
6//!
7//! ## Features
8//!
9//! - [Model]: A trait for defining a neural network model.
10//! - [ModelParams]: A structure for storing the parameters of a neural network model.
11//! - [StandardModelConfig]: A standard configuration for the models
12//! - [Predict]: A trait extending the basic [Forward](cnc::Forward) pass
13//! - [Train]: A trait for training a neural network model.
14//!
15//! ### _Work in Progress_
16//!
17//! - [LayerBase]: Functional wrappers for the [ParamsBase](cnc::ParamsBase) structure.
18
19#![crate_name = "concision_neural"]
20#![crate_type = "lib"]
21
22extern crate concision_core as cnc;
23
24#[doc(inline)]
25pub use self::{
26    error::*,
27    layers::{Layer, LayerBase},
28    model::prelude::*,
29    traits::prelude::*,
30    types::prelude::*,
31};
32
33#[macro_use]
34pub(crate) mod macros;
35
36pub mod error;
37pub mod layers;
38pub mod model;
39pub mod utils;
40
41pub mod traits {
42    #[doc(inline)]
43    pub use self::prelude::*;
44
45    pub mod config;
46    pub mod predict;
47    pub mod train;
48
49    pub(crate) mod prelude {
50        #[doc(inline)]
51        pub use super::config::*;
52        #[doc(inline)]
53        pub use super::predict::*;
54        #[doc(inline)]
55        pub use super::train::*;
56    }
57}
58
59pub mod types {
60    #[doc(inline)]
61    pub use self::prelude::*;
62
63    pub mod dropout;
64    pub mod features;
65    pub mod hyperparameters;
66
67    pub(crate) mod prelude {
68        #[doc(inline)]
69        pub use super::dropout::*;
70        #[doc(inline)]
71        pub use super::features::*;
72        #[doc(inline)]
73        pub use super::hyperparameters::*;
74    }
75}
76
77pub mod prelude {
78    #[doc(no_inline)]
79    pub use crate::error::*;
80    #[doc(no_inline)]
81    pub use crate::layers::prelude::*;
82    #[doc(no_inline)]
83    pub use crate::model::prelude::*;
84    #[doc(no_inline)]
85    pub use crate::traits::prelude::*;
86    #[doc(no_inline)]
87    pub use crate::types::prelude::*;
88}