From f4ec440132e0aebfd46216a719418883aff5130e Mon Sep 17 00:00:00 2001 From: marc <78002988+novak-99@users.noreply.github.com> Date: Thu, 27 May 2021 22:55:41 -0700 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index f4c911b..ba9e0ca 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,29 @@ Machine learning is a vast and exiciting discipline, garnering attention from sp

## Usage +Please note that ML++ uses the ```std::vector``` data type for emulating vectors, and the ```std::vector>``` data type for emulating matricies. Begin by including the respective header file of your choice. ```cpp #include "MLPP/LinReg/LinReg.hpp" ``` +Next, instantiate an object of the class. Don't forget to pass the input set, output set as parameters. +```cpp +LinReg model(inputSet, outputSet); +``` +Next, call the optimizer that you would like to use. For iterative optimizers such as gradient descent, include the learning rate, epoch number, and whether or not to utilize the UI pannel. +```cpp +model.gradientDescent(0.001, 1000, 0); +``` +Great, you are now ready to test! To test a singular testing instance, utilize the following function: +```cpp +model.modelTest(testSetInstance); +``` +This will return the model's singular prediction for that example. +To test an entire dataset of instances, use the following function: +```cpp +model.modelSetTest(testSet); +``` +The result will be the model's predictions for the entire dataset. ## Contents of the Library