Module model

This module provides the scaffolding for creating models and layers in a neural network.

Modules

layout

params

trainer

Structs

ModelFeatures

The ModelFeatures provides a common way of defining the layout of a model. This is used to define the number of input features, the number of hidden layers, the number of hidden features, and the number of output features.

ModelParamsBase

The ModelParamsBase object is a generic ocntainer for storing the parameters of a neural network, regardless of the layout (e.g. shallow or deep). This is made possible through the introduction of a generic hidden layer type, H, that allows us to define aliases and additional traits for contraining the hidden layer type. That being said, we don’t reccoment using this type directly, but rather use the provided type aliases such as DeepModelParams or ShallowModelParams or their owned variants. These provide a much more straighforward interface for typing the parameters of a neural network. We aren’t too worried about the transumtation between the two since users desiring this ability should simply stick with a deep representation, initializing only a single layer within the respective container.

Trainer

Traits

DeepNeuralNetwork

The DeepNeuralNetwork trait is a specialization of the Model trait that provides additional functionality for deep neural networks. This trait is

Model

The base interface for all models; each model provides access to a configuration object defined as the associated type Config. The configuration object is used to provide hyperparameters and other control related parameters. In addition, the model’s layout is defined by the features method which aptly returns a copy of its [ModelFeatures] object.

ModelExt

ModelLayout

ModelTrainer

Type Aliases

DeepModelParams

a type alias for an owned representation of the DeepParamsBase generic of type A and the dimension D.

DeepParamsBase

a type alias for a deep representation of the ModelParamsBase using a vector of parameters as the hidden layers.

ShallowModelParams

a type alias for an owned representation of the DeepParamsBase generic of type A and the dimension D.

ShallowParamsBase

a type alias for a shallow representation of the ModelParamsBase using a single ParamsBase instance as the hidden layer.