diwa.h

Go to the documentation of this file.

/*
 * This file is part of the Diwa library.
 * Copyright (c) 2024 Nathanne Isip
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#ifndef DIWA_H
#define DIWA_H
 
#ifdef ARDUINO
#   include <Arduino.h>
#   if defined(ARDUINO_ARCH_ESP32) || \
        defined(ARDUINO_ARCH_ESP8266) || \
        defined(ARDUINO_ARCH_RP2040)
#       include <FS.h>
#   else
#       include <SD.h>
#   endif
#elif defined(__GNUC__) || \
    defined(__GNUG__) || \
    defined(__clang__) || \
    defined(_MSC_VER)
#   include <fstream>
#   include <math.h>
#endif
 
#include <diwa_activations.h>
#include <stdint.h>
 
typedef enum {
    NO_ERROR,               
    INVALID_PARAM_VALUES,   
    MODEL_READ_ERROR,       
    MODEL_SAVE_ERROR,       
    INVALID_MAGIC_NUMBER,   
    STREAM_NOT_OPEN,        
    MALLOC_FAILED,          
} DiwaError;
 
class Diwa final {
private:
    int inputNeurons;   
    int hiddenNeurons;  
    int hiddenLayers;   
    int outputNeurons;  
    int weightCount;    
    int neuronCount;    
    double *weights;     
    double *outputs;     
    double *deltas;      
    diwa_activation activation; 
    void randomizeWeights();
 
    DiwaError initializeWeights();
 
    bool testInference(double *testInput, double *testExpectedOutput);
 
public:
    Diwa();
 
    ~Diwa();
 
    DiwaError initialize(
        int inputNeurons,
        int hiddenLayers,
        int hiddenNeurons,
        int outputNeurons,
        bool randomizeWeights = true
    );
 
    double* inference(double *inputs);
 
    void train(
        double learningRate,
        double *inputNeurons,
        double *outputNeurons
    );
 
    #ifdef ARDUINO
 
    DiwaError loadFromFile(File annFile);
 
    DiwaError saveToFile(File annFile);
 
    #elif DOXYGEN
 
    DiwaError loadFromFile(T annFile);
 
    DiwaError saveToFile(T annFile);
 
    #elif defined(__GNUC__) || \
        defined(__GNUG__) || \
        defined(__clang__) || \
        defined(_MSC_VER)
 
    DiwaError loadFromFile(std::ifstream& annFile);
 
    DiwaError saveToFile(std::ofstream& annFile);
 
    #endif
 
    double calculateAccuracy(double *testInput, double *testExpectedOutput, int epoch);
 
    double calculateLoss(double *testInput, double *testExpectedOutput, int epoch);
 
    void setActivationFunction(diwa_activation activation);
 
    diwa_activation getActivationFunction() const;
 
    int recommendedHiddenNeuronCount();
 
    int recommendedHiddenLayerCount(int numSamples, int alpha);
 
    int getInputNeurons() const;
 
    int getHiddenNeurons() const;
 
    int getHiddenLayers() const;
 
    int getOutputNeurons() const;
 
    int getWeightCount() const;
 
    int getNeuronCount() const;
 
    void getWeights(double* weights);
 
    void getOutputs(double* outputs);
};
 
#endif  // DIWA_H