From 3d6c44ca726f398a45311068e3c14f6548c231b0 Mon Sep 17 00:00:00 2001 From: Nathanne Isip Date: Wed, 1 May 2024 23:44:40 +0800 Subject: [PATCH] Updated documentation pages and version badge. --- docs/classN2Coprocessor-members.html | 6 ++++-- docs/classN2Coprocessor.html | 6 ++++++ docs/index.html | 11 ++++++++--- docs/n2cmu_8h_source.html | 12 +++++++++--- docs/navtreedata.js | 3 ++- docs/navtreeindex0.js | 1 + 6 files changed, 30 insertions(+), 9 deletions(-) diff --git a/docs/classN2Coprocessor-members.html b/docs/classN2Coprocessor-members.html index ad99387..fe2fde9 100644 --- a/docs/classN2Coprocessor-members.html +++ b/docs/classN2Coprocessor-members.html @@ -106,8 +106,10 @@ getOutputWeights(float *outputWeights)N2Coprocessor handshake()N2Coprocessor infer(float *input, float *output)N2Coprocessor - N2Coprocessor(uint8_t rx=N2CMU_RX_PIN, uint8_t tx=N2CMU_TX_PIN)N2Coprocessorinline - resetNetwork()N2Coprocessor + loadFromFile(const char *modelFilename) (defined in N2Coprocessor)N2Coprocessor + N2Coprocessor(uint8_t rx=N2CMU_RX_PIN, uint8_t tx=N2CMU_TX_PIN)N2Coprocessorinline + resetNetwork()N2Coprocessor + saveToFile(const char *modelFilename) (defined in N2Coprocessor)N2Coprocessor setEpochCount(uint16_t epoch)N2Coprocessor setHiddenBias(float *hiddenBias)N2Coprocessor setHiddenCount(uint8_t hiddenCount)N2Coprocessor diff --git a/docs/classN2Coprocessor.html b/docs/classN2Coprocessor.html index b016f76..328a68d 100644 --- a/docs/classN2Coprocessor.html +++ b/docs/classN2Coprocessor.html @@ -193,6 +193,12 @@ void getOutputGradient (float *outputGrad)  Get output neuron gradients. More...
  + +void loadFromFile (const char *modelFilename) +  + +void saveToFile (const char *modelFilename) + 

Detailed Description

Class representing the N2CMU device.

diff --git a/docs/index.html b/docs/index.html index 5096d81..525a63f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -86,8 +86,10 @@
N2CMU Arduino Library
-

Arduino CI Arduino Lint Arduino Release License: GNU GPL v3.0

+

Arduino CI Arduino Lint Spellcheck CI Arduino Release License: GNU GPL v3.0

This is the official Arduino library for N2CMU (Neural Network Coprocessing Microcontroller Unit).

+

+

Arduino N2CMU Shield

Getting Started

To start using n2cmu-arduino library in your Arduino projects, follow these simple steps:

@@ -128,7 +130,7 @@

// Reset the CPU
if(coprocessor.cpuReset())
-
Serial.println(F("CPU Resetted!"));
+
Serial.println(F("CPU Reset!"));
else {
Serial.println(F("Something went wrong. Halting..."));
while(true);
@@ -164,7 +166,7 @@

Serial.print(F("]: "));
Serial.println(output[0]);
}
-
else Serial.println(F("Inference attemp failed."));
+
else Serial.println(F("Inference attempt failed."));
}
// Reset the network
@@ -185,6 +187,9 @@

N2Coprocessor::resetNetwork
void resetNetwork()
Reset the neural network parameters.
Definition: n2cmu.cpp:160
n2cmu.h
Header file for N2CMU (Neural Network Coprocessing Microcontroller Unit).

+PCB Schematic Diagram

+

Arduino N2CMU Shield Schematic Diagram

+

License

Copyright (c) 2024 Nathanne Isip

n2cmu-arduino is distributed under the GNU General Public License v3.0. For further details, refer to the LICENSE file.

diff --git a/docs/n2cmu_8h_source.html b/docs/n2cmu_8h_source.html index e3f447e..f051591 100644 --- a/docs/n2cmu_8h_source.html +++ b/docs/n2cmu_8h_source.html @@ -208,9 +208,15 @@
517 void getHiddenGradient(float* hiddenGrad);
518
530 void getOutputGradient(float* outputGrad);
-
531};
-
532
-
533#endif
+
531
+
532 // Not yet implemented.
+
533 void loadFromFile(const char *modelFilename);
+
534
+
535 // Not yet implemented.
+
536 void saveToFile(const char* modelFilename);
+
537};
+
538
+
539#endif
N2Coprocessor
Class representing the N2CMU device.
Definition: n2cmu.h:47
N2Coprocessor::setHiddenCount
void setHiddenCount(uint8_t hiddenCount)
Set the number of hidden neurons.
Definition: n2cmu.cpp:178
N2Coprocessor::infer
bool infer(float *input, float *output)
Make inference with the neural network using provided input data.
Definition: n2cmu.cpp:146
diff --git a/docs/navtreedata.js b/docs/navtreedata.js index d92d3e2..2596d20 100644 --- a/docs/navtreedata.js +++ b/docs/navtreedata.js @@ -28,7 +28,8 @@ var NAVTREE = [ "N2CMU Arduino Library", "index.html", [ [ "Getting Started", "index.html#autotoc_md1", null ], [ "Example Usage", "index.html#autotoc_md2", null ], - [ "License", "index.html#autotoc_md3", null ] + [ "PCB Schematic Diagram", "index.html#autotoc_md3", null ], + [ "License", "index.html#autotoc_md4", null ] ] ], [ "Classes", "annotated.html", [ [ "Class List", "annotated.html", "annotated_dup" ], diff --git a/docs/navtreeindex0.js b/docs/navtreeindex0.js index 070b2bc..40ed132 100644 --- a/docs/navtreeindex0.js +++ b/docs/navtreeindex0.js @@ -49,6 +49,7 @@ var NAVTREEINDEX0 = "index.html#autotoc_md1":[0,0], "index.html#autotoc_md2":[0,1], "index.html#autotoc_md3":[0,2], +"index.html#autotoc_md4":[0,3], "n2cmu_8h.html":[2,0,0,0], "n2cmu_8h.html#a66afc50ff26aace7f21713d756f63c57":[2,0,0,0,1], "n2cmu_8h.html#ac8118cdfd4100b5c0c1db9c38787915b":[2,0,0,0,3],