rustyml 0.17.0

Machine learning models, neural networks, metrics, and data utilities in Rust
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

//! Convolutional layers and shared padding types
//!
//! Re-exports the 1D, 2D, and 3D convolution layers, their transposed counterparts, and the
//! depthwise and separable convolution layers in 1D and 2D. Defines
//! [`PaddingType`], which controls spatial padding, and re-exports [`ConvPadding`], which adds the
//! causal rule that only [`Conv1D`] accepts
//!
//! [`PaddingType`]: crate::neural_network::layers::convolution::PaddingType

/// Padding method used by convolutional and pooling layers
///
/// Determines how the layer pads its input before the operation runs. Defaults to
/// [`PaddingType::Valid`] (no padding)
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum PaddingType {
    /// Applies no padding. The convolution runs only where the filter fully overlaps the
    /// input. The output size depends on the kernel extent and stride
    #[default]
    Valid,

    /// Adds zeros around the input borders so the output keeps the same spatial dimensions
    /// as the input when the stride is 1. Pooling excludes padded cells from its reduction
    Same,
}

/// 1D convolutional layer
pub mod conv_1d;
/// 1D transposed convolutional layer
pub mod conv_1d_transpose;
/// 2D convolutional layer
pub mod conv_2d;
/// 2D transposed convolutional layer
pub mod conv_2d_transpose;
/// 3D convolutional layer
pub mod conv_3d;
/// 3D transposed convolutional layer
pub mod conv_3d_transpose;
/// Dimension-generic transposed-convolution engine shared by Conv1DTranspose, Conv2DTranspose,
/// and Conv3DTranspose
mod conv_transpose_engine;
/// Dimension-generic convolution engine shared by Conv1D, Conv2D, Conv3D, and the pointwise
/// stage of the separable convolutions
pub(crate) mod convolution_engine;
/// 1D depthwise convolutional layer
pub mod depthwise_conv_1d;
/// 2D depthwise convolutional layer
pub mod depthwise_conv_2d;
/// 1D separable convolutional layer
pub mod separable_conv_1d;
/// 2D separable convolutional layer
pub mod separable_conv_2d;
/// Parameter and input-shape validation shared by the convolution layers
mod validation;

pub use conv_1d::Conv1D;
pub use conv_1d_transpose::Conv1DTranspose;
pub use conv_2d::Conv2D;
pub use conv_2d_transpose::Conv2DTranspose;
pub use conv_3d::Conv3D;
pub use conv_3d_transpose::Conv3DTranspose;
pub use convolution_engine::ConvPadding;
pub use depthwise_conv_1d::DepthwiseConv1D;
pub use depthwise_conv_2d::DepthwiseConv2D;
pub use separable_conv_1d::SeparableConv1D;
pub use separable_conv_2d::SeparableConv2D;