-
shamboflow
index.html
Package
Package
PUBLIC
Shamboflow : a Tensorflow competitor
-
shamboflow.callbacks
shamboflow.callbacks.html
Module
Module
PUBLIC
A collection of common callback functions
-
shamboflow.engine
shamboflow.engine.html
Package
Package
PUBLIC
Modules for all utilities.
-
shamboflow.engine.activations
shamboflow.engine.activations.html
Module
Module
PUBLIC
Common Activation functions
-
shamboflow.engine.base_callback
shamboflow.engine.base_callback.html
Module
Module
PUBLIC
Base class file for callback methods
-
shamboflow.engine.base_layers
shamboflow.engine.base_layers.html
Module
Module
PUBLIC
Base class for layers
-
shamboflow.engine.base_models
shamboflow.engine.base_models.html
Module
Module
PUBLIC
Base class for models
-
shamboflow.engine.d_activations
shamboflow.engine.d_activations.html
Module
Module
PUBLIC
A Collection of derivatives for the activation functions
-
shamboflow.engine.d_losses
shamboflow.engine.d_losses.html
Module
Module
PUBLIC
Partial derivatives of loss functions
-
shamboflow.engine.losses
shamboflow.engine.losses.html
Module
Module
PUBLIC
A small collection of loss functions
-
shamboflow.layers
shamboflow.layers.html
Module
Module
PUBLIC
Several common layers used in Neural Networks
-
shamboflow.models
shamboflow.models.html
Module
Module
PUBLIC
Some common models
-
shamboflow.IS_CUDA
index.html#IS_CUDA
Attribute
Variable
PUBLIC
Constant to decide whether to use GPU for computations.
-
shamboflow._cuda_version
index.html#_cuda_version
Attribute
Variable
PRIVATE
Undocumented
-
shamboflow._driver_version
index.html#_driver_version
Attribute
Variable
PRIVATE
Undocumented
-
shamboflow._props
index.html#_props
Attribute
Variable
PRIVATE
Undocumented
-
shamboflow.engine.base_layers.BaseLayer
shamboflow.engine.base_layers.BaseLayer.html
Class
Class
PUBLIC
The base class for layers to inherit from.
-
shamboflow.engine.base_layers.BaseLayer.__init__
shamboflow.engine.base_layers.BaseLayer.html#__init__
Function
Method
PUBLIC
Constructor for the base layer class
-
shamboflow.engine.base_layers.BaseLayer.name
shamboflow.engine.base_layers.BaseLayer.html#name
Attribute
Instance Variable
PUBLIC
Name of the layer
-
shamboflow.engine.base_layers.BaseLayer.trainable
shamboflow.engine.base_layers.BaseLayer.html#trainable
Attribute
Instance Variable
PUBLIC
Is the layer trainable
-
shamboflow.engine.base_layers.BaseLayer.is_built
shamboflow.engine.base_layers.BaseLayer.html#is_built
Attribute
Instance Variable
PUBLIC
has the layer been built and compiled
-
shamboflow.engine.base_layers.BaseLayer.bias_array
shamboflow.engine.base_layers.BaseLayer.html#bias_array
Attribute
Instance Variable
PUBLIC
Bias values of the layer
-
shamboflow.engine.base_layers.BaseLayer.output_array
shamboflow.engine.base_layers.BaseLayer.html#output_array
Attribute
Instance Variable
PUBLIC
Output matrix of the layer
-
shamboflow.engine.base_layers.BaseLayer.midway
shamboflow.engine.base_layers.BaseLayer.html#midway
Attribute
Instance Variable
PUBLIC
Output value before applying avtivation function
-
shamboflow.engine.base_layers.BaseLayer.error_array
shamboflow.engine.base_layers.BaseLayer.html#error_array
Attribute
Instance Variable
PUBLIC
Error values of the layer
-
shamboflow.engine.base_layers.BaseLayer.leakyrelu_slope
shamboflow.engine.base_layers.BaseLayer.html#leakyrelu_slope
Attribute
Instance Variable
PUBLIC
Slope value if using leakyrelu activation function
-
shamboflow.engine.base_layers.BaseLayer.activation
shamboflow.engine.base_layers.BaseLayer.html#activation
Attribute
Instance Variable
PUBLIC
Activation function used by the layer
-
shamboflow.engine.base_layers.BaseLayer.activation_str
shamboflow.engine.base_layers.BaseLayer.html#activation_str
Attribute
Instance Variable
PUBLIC
The name of the activation function
-
shamboflow.engine.base_layers.BaseLayer.build
shamboflow.engine.base_layers.BaseLayer.html#build
Function
Method
PUBLIC
Method to build and initialize the layer.
-
shamboflow.engine.base_layers.BaseLayer.compute
shamboflow.engine.base_layers.BaseLayer.html#compute
Function
Method
PUBLIC
Method to compute various parameter
-
shamboflow.engine.base_models.BaseModel
shamboflow.engine.base_models.BaseModel.html
Class
Class
PUBLIC
The Base class for models
-
shamboflow.engine.base_models.BaseModel.__init__
shamboflow.engine.base_models.BaseModel.html#__init__
Function
Method
PUBLIC
Initialize the required attributes.
-
shamboflow.engine.base_models.BaseModel.layers
shamboflow.engine.base_models.BaseModel.html#layers
Attribute
Instance Variable
PUBLIC
A list of layers in the model
-
shamboflow.engine.base_models.BaseModel.weights
shamboflow.engine.base_models.BaseModel.html#weights
Attribute
Instance Variable
PUBLIC
A list of all weights between each layers
-
shamboflow.engine.base_models.BaseModel.loss
shamboflow.engine.base_models.BaseModel.html#loss
Attribute
Instance Variable
PUBLIC
The loss function used by the model
-
shamboflow.engine.base_models.BaseModel.loss_str
shamboflow.engine.base_models.BaseModel.html#loss_str
Attribute
Instance Variable
PUBLIC
The name of the loss function used
-
shamboflow.engine.base_models.BaseModel.learning_rate
shamboflow.engine.base_models.BaseModel.html#learning_rate
Attribute
Instance Variable
PUBLIC
The learning rate of the model
-
shamboflow.engine.base_models.BaseModel.train_data_x
shamboflow.engine.base_models.BaseModel.html#train_data_x
Attribute
Instance Variable
PUBLIC
The feature list of the dataset
-
shamboflow.engine.base_models.BaseModel.train_data_y
shamboflow.engine.base_models.BaseModel.html#train_data_y
Attribute
Instance Variable
PUBLIC
The labels for each data in the dataset
-
shamboflow.engine.base_models.BaseModel.validation_x
shamboflow.engine.base_models.BaseModel.html#validation_x
Attribute
Instance Variable
PUBLIC
Features of validation set
-
shamboflow.engine.base_models.BaseModel.validation_y
shamboflow.engine.base_models.BaseModel.html#validation_y
Attribute
Instance Variable
PUBLIC
Labels of the validation set
-
shamboflow.engine.base_models.BaseModel.has_validation_data
shamboflow.engine.base_models.BaseModel.html#has_validation_data
Attribute
Instance Variable
PUBLIC
Boolean flag fo if the the model has validation data
-
shamboflow.engine.base_models.BaseModel.test_data_x
shamboflow.engine.base_models.BaseModel.html#test_data_x
Attribute
Instance Variable
PUBLIC
Features of the test dataset
-
shamboflow.engine.base_models.BaseModel.test_data_y
shamboflow.engine.base_models.BaseModel.html#test_data_y
Attribute
Instance Variable
PUBLIC
Labels for the test dataset
-
shamboflow.engine.base_models.BaseModel.epochs
shamboflow.engine.base_models.BaseModel.html#epochs
Attribute
Instance Variable
PUBLIC
Number of epochs to train for
-
shamboflow.engine.base_models.BaseModel.callbacks
shamboflow.engine.base_models.BaseModel.html#callbacks
Attribute
Instance Variable
PUBLIC
A list of callback functions
-
shamboflow.engine.base_models.BaseModel.error_val
shamboflow.engine.base_models.BaseModel.html#error_val
Attribute
Instance Variable
PUBLIC
The loss value of the model at any instance
-
shamboflow.engine.base_models.BaseModel.accuracy_val
shamboflow.engine.base_models.BaseModel.html#accuracy_val
Attribute
Instance Variable
PUBLIC
The accuracy value of the model at any instance
-
shamboflow.engine.base_models.BaseModel.metrics
shamboflow.engine.base_models.BaseModel.html#metrics
Attribute
Instance Variable
PUBLIC
A dictionary of metrics for the model. Includes loss, acc, val_loss, val_acc
-
shamboflow.engine.base_models.BaseModel.current_epoch
shamboflow.engine.base_models.BaseModel.html#current_epoch
Attribute
Instance Variable
PUBLIC
The current epoch of the model during training
-
shamboflow.engine.base_models.BaseModel.is_fitting
shamboflow.engine.base_models.BaseModel.html#is_fitting
Attribute
Instance Variable
PUBLIC
Is the model training right now
-
shamboflow.engine.base_models.BaseModel.parameters
shamboflow.engine.base_models.BaseModel.html#parameters
Attribute
Instance Variable
PUBLIC
Amount of trainable parameters in the model
-
shamboflow.engine.base_models.BaseModel.is_compiled
shamboflow.engine.base_models.BaseModel.html#is_compiled
Attribute
Instance Variable
PUBLIC
Has the model been compiled
-
shamboflow.engine.base_models.BaseModel.add
shamboflow.engine.base_models.BaseModel.html#add
Function
Method
PUBLIC
Method to add layers to the model
-
shamboflow.engine.base_models.BaseModel.compile
shamboflow.engine.base_models.BaseModel.html#compile
Function
Method
PUBLIC
Model compilation method
-
shamboflow.engine.base_models.BaseModel.fit
shamboflow.engine.base_models.BaseModel.html#fit
Function
Method
PUBLIC
Method to train the model on data
-
shamboflow.engine.base_models.BaseModel.stop
shamboflow.engine.base_models.BaseModel.html#stop
Function
Method
PUBLIC
Method to stop the training
-
shamboflow.engine.base_models.BaseModel.summary
shamboflow.engine.base_models.BaseModel.html#summary
Function
Method
PUBLIC
Prints a summary of the model with all necessary details
-
shamboflow.engine.base_models.BaseModel.save
shamboflow.engine.base_models.BaseModel.html#save
Function
Method
PUBLIC
Saves the model to the disk
-
shamboflow.engine.base_models.BaseModel.evaluate
shamboflow.engine.base_models.BaseModel.html#evaluate
Function
Method
PUBLIC
Evaluates metrics based on a Test dataset
-
shamboflow.engine.base_models.BaseModel.predict
shamboflow.engine.base_models.BaseModel.html#predict
Function
Method
PUBLIC
Calculate inference using the trained model
-
shamboflow.engine.losses.MSE
shamboflow.engine.losses.html#MSE
Function
Function
PUBLIC
Mean Squared Error
-
shamboflow.engine.losses.get
shamboflow.engine.losses.html#get
Function
Function
PUBLIC
Helper function to get a loss function
-
shamboflow.engine.d_losses.d_MSE
shamboflow.engine.d_losses.html#d_MSE
Function
Function
PUBLIC
Derivative of Mean Squared Error loss function
-
shamboflow.engine.d_losses.get
shamboflow.engine.d_losses.html#get
Function
Function
PUBLIC
Helper function to get a loss function derivative
-
shamboflow.engine.activations.sigmoid
shamboflow.engine.activations.html#sigmoid
Function
Function
PUBLIC
Sigmoid acitvation function
-
shamboflow.engine.activations.tanh
shamboflow.engine.activations.html#tanh
Function
Function
PUBLIC
Hyperbolic tangent activation function
-
shamboflow.engine.activations.relu
shamboflow.engine.activations.html#relu
Function
Function
PUBLIC
ReLU activation function
-
shamboflow.engine.activations.leakyrelu
shamboflow.engine.activations.html#leakyrelu
Function
Function
PUBLIC
Leaky ReLU activation function
-
shamboflow.engine.activations.softmax
shamboflow.engine.activations.html#softmax
Function
Function
PUBLIC
SoftMax activation function
-
shamboflow.engine.activations.get
shamboflow.engine.activations.html#get
Function
Function
PUBLIC
Helper function to get an activation function
-
shamboflow.engine.d_activations.d_sigmoid
shamboflow.engine.d_activations.html#d_sigmoid
Function
Function
PUBLIC
The partial derivative of sigmoid function
-
shamboflow.engine.d_activations.d_tanh
shamboflow.engine.d_activations.html#d_tanh
Function
Function
PUBLIC
The partial derivative for hyperbolic tangent
-
shamboflow.engine.d_activations.d_relu
shamboflow.engine.d_activations.html#d_relu
Function
Function
PUBLIC
Partial derivative for relu function
-
shamboflow.engine.d_activations.d_leakyrelu
shamboflow.engine.d_activations.html#d_leakyrelu
Function
Function
PUBLIC
Partial derivative for leaky relu function
-
shamboflow.engine.d_activations.d_softmax
shamboflow.engine.d_activations.html#d_softmax
Function
Function
PUBLIC
Not implemented yet
-
shamboflow.engine.d_activations.get
shamboflow.engine.d_activations.html#get
Function
Function
PUBLIC
Helper function to get an activation function derivative
-
shamboflow.models.Sequential
shamboflow.models.Sequential.html
Class
Class
PUBLIC
A simple sequential model with multiple layers one after the other
-
shamboflow.models.Sequential.__init__
shamboflow.models.Sequential.html#__init__
Function
Method
PUBLIC
Initialize the required attributes.
-
shamboflow.models.Sequential.add
shamboflow.models.Sequential.html#add
Function
Method
PUBLIC
Method to add layers to the model
-
shamboflow.models.Sequential.compile
shamboflow.models.Sequential.html#compile
Function
Method
PUBLIC
Method to initialize and compile the model
-
shamboflow.models.Sequential.learning_rate
shamboflow.models.Sequential.html#learning_rate
Attribute
Instance Variable
PUBLIC
The learning rate of the model
-
shamboflow.models.Sequential.loss_str
shamboflow.models.Sequential.html#loss_str
Attribute
Instance Variable
PUBLIC
The name of the loss function used
-
shamboflow.models.Sequential.loss
shamboflow.models.Sequential.html#loss
Attribute
Instance Variable
PUBLIC
The loss function used by the model
-
shamboflow.models.Sequential.is_compiled
shamboflow.models.Sequential.html#is_compiled
Attribute
Instance Variable
PUBLIC
Has the model been compiled
-
shamboflow.models.Sequential.fit
shamboflow.models.Sequential.html#fit
Function
Method
PUBLIC
Method to train the model and fit the data
-
shamboflow.models.Sequential.train_data_x
shamboflow.models.Sequential.html#train_data_x
Attribute
Instance Variable
PUBLIC
The feature list of the dataset
-
shamboflow.models.Sequential.train_data_y
shamboflow.models.Sequential.html#train_data_y
Attribute
Instance Variable
PUBLIC
The labels for each data in the dataset
-
shamboflow.models.Sequential.epochs
shamboflow.models.Sequential.html#epochs
Attribute
Instance Variable
PUBLIC
Number of epochs to train for
-
shamboflow.models.Sequential.has_validation_data
shamboflow.models.Sequential.html#has_validation_data
Attribute
Instance Variable
PUBLIC
Boolean flag fo if the the model has validation data
-
shamboflow.models.Sequential.validation_x
shamboflow.models.Sequential.html#validation_x
Attribute
Instance Variable
PUBLIC
Features of validation set
-
shamboflow.models.Sequential.validation_y
shamboflow.models.Sequential.html#validation_y
Attribute
Instance Variable
PUBLIC
Labels of the validation set
-
shamboflow.models.Sequential.callbacks
shamboflow.models.Sequential.html#callbacks
Attribute
Instance Variable
PUBLIC
A list of callback functions
-
shamboflow.models.Sequential.evaluate
shamboflow.models.Sequential.html#evaluate
Function
Method
PUBLIC
Method to evaluate the model with test data
-
shamboflow.models.Sequential.summary
shamboflow.models.Sequential.html#summary
Function
Method
PUBLIC
Prints a summary of the model once compiled
-
shamboflow.models.Sequential.save
shamboflow.models.Sequential.html#save
Function
Method
PUBLIC
Method to save the model to disk
-
shamboflow.models.Sequential.predict
shamboflow.models.Sequential.html#predict
Function
Method
PUBLIC
Method to predict data labels
-
shamboflow.models.load_model
shamboflow.models.html#load_model
Function
Function
PUBLIC
Method to load a model from disk
-
shamboflow.layers.Dense
shamboflow.layers.Dense.html
Class
Class
PUBLIC
A Simple 1D layer
-
shamboflow.layers.Dense.__init__
shamboflow.layers.Dense.html#__init__
Function
Method
PUBLIC
Constructor for Dense Layer
-
shamboflow.layers.Dense.size
shamboflow.layers.Dense.html#size
Attribute
Instance Variable
PUBLIC
Size of the layer
-
shamboflow.layers.Dense.activation
shamboflow.layers.Dense.html#activation
Attribute
Instance Variable
PUBLIC
Activation function used by the layer
-
shamboflow.layers.Dense.activation_str
shamboflow.layers.Dense.html#activation_str
Attribute
Instance Variable
PUBLIC
The name of the activation function
-
shamboflow.layers.Dense.leakyrelu_slope
shamboflow.layers.Dense.html#leakyrelu_slope
Attribute
Instance Variable
PUBLIC
Slope value if using leakyrelu activation function
-
shamboflow.layers.Dense.build
shamboflow.layers.Dense.html#build
Function
Method
PUBLIC
Overidden Build method
-
shamboflow.layers.Dense.bias_array
shamboflow.layers.Dense.html#bias_array
Attribute
Instance Variable
PUBLIC
Bias values of the layer
-
shamboflow.layers.Dense.output_array
shamboflow.layers.Dense.html#output_array
Attribute
Instance Variable
PUBLIC
Output matrix of the layer
-
shamboflow.layers.Dense.compute
shamboflow.layers.Dense.html#compute
Function
Method
PUBLIC
Method to perform computation on data
-
shamboflow.layers.Dense.midway
shamboflow.layers.Dense.html#midway
Attribute
Instance Variable
PUBLIC
Output value before applying avtivation function
-
shamboflow.engine.base_callback.BaseCallback
shamboflow.engine.base_callback.BaseCallback.html
Class
Class
PUBLIC
Callback methods base class
-
shamboflow.engine.base_callback.BaseCallback.__init__
shamboflow.engine.base_callback.BaseCallback.html#__init__
Function
Method
PUBLIC
Undocumented
-
shamboflow.engine.base_callback.BaseCallback.run
shamboflow.engine.base_callback.BaseCallback.html#run
Function
Method
PUBLIC
Method that runs after each epoch
-
shamboflow.callbacks.EarlyStopping
shamboflow.callbacks.EarlyStopping.html
Class
Class
PUBLIC
Early Stopper
-
shamboflow.callbacks.EarlyStopping.__init__
shamboflow.callbacks.EarlyStopping.html#__init__
Function
Method
PUBLIC
Initialize
-
shamboflow.callbacks.EarlyStopping._monitor
shamboflow.callbacks.EarlyStopping.html#_monitor
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.EarlyStopping._patience
shamboflow.callbacks.EarlyStopping.html#_patience
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.EarlyStopping._verbose
shamboflow.callbacks.EarlyStopping.html#_verbose
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.EarlyStopping._metric_old
shamboflow.callbacks.EarlyStopping.html#_metric_old
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.EarlyStopping._patience_ctr
shamboflow.callbacks.EarlyStopping.html#_patience_ctr
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.EarlyStopping.run
shamboflow.callbacks.EarlyStopping.html#run
Function
Method
PUBLIC
The callback method that will be called after each epoch
-
shamboflow.callbacks.ReduceLROnPlateau
shamboflow.callbacks.ReduceLROnPlateau.html
Class
Class
PUBLIC
Reduce Learning Rate on Plateau callback
-
shamboflow.callbacks.ReduceLROnPlateau.__init__
shamboflow.callbacks.ReduceLROnPlateau.html#__init__
Function
Method
PUBLIC
Initialize
-
shamboflow.callbacks.ReduceLROnPlateau._monitor
shamboflow.callbacks.ReduceLROnPlateau.html#_monitor
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ReduceLROnPlateau._patience
shamboflow.callbacks.ReduceLROnPlateau.html#_patience
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ReduceLROnPlateau._factor
shamboflow.callbacks.ReduceLROnPlateau.html#_factor
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ReduceLROnPlateau._min_val
shamboflow.callbacks.ReduceLROnPlateau.html#_min_val
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ReduceLROnPlateau._verbose
shamboflow.callbacks.ReduceLROnPlateau.html#_verbose
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ReduceLROnPlateau._metric_old
shamboflow.callbacks.ReduceLROnPlateau.html#_metric_old
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ReduceLROnPlateau._patience_ctr
shamboflow.callbacks.ReduceLROnPlateau.html#_patience_ctr
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ReduceLROnPlateau.run
shamboflow.callbacks.ReduceLROnPlateau.html#run
Function
Method
PUBLIC
The callback method that will be called after each epoch
-
shamboflow.callbacks.ModelCheckpoint
shamboflow.callbacks.ModelCheckpoint.html
Class
Class
PUBLIC
Model Checkpointing
-
shamboflow.callbacks.ModelCheckpoint.__init__
shamboflow.callbacks.ModelCheckpoint.html#__init__
Function
Method
PUBLIC
Initialize
-
shamboflow.callbacks.ModelCheckpoint._save_path
shamboflow.callbacks.ModelCheckpoint.html#_save_path
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ModelCheckpoint._monitor
shamboflow.callbacks.ModelCheckpoint.html#_monitor
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ModelCheckpoint._save_best
shamboflow.callbacks.ModelCheckpoint.html#_save_best
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ModelCheckpoint._verbose
shamboflow.callbacks.ModelCheckpoint.html#_verbose
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ModelCheckpoint._metric_old
shamboflow.callbacks.ModelCheckpoint.html#_metric_old
Attribute
Instance Variable
PRIVATE
Undocumented
-
shamboflow.callbacks.ModelCheckpoint.run
shamboflow.callbacks.ModelCheckpoint.html#run
Function
Method
PUBLIC
The callback method that will be called after each epoch