Merge pull request #3 from RichardScottOZ/patch-1

Update README.md
This commit is contained in:
marc 2022-02-14 14:29:05 -08:00 committed by GitHub
commit aac9bd6479
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -30,7 +30,7 @@ g++ main.cpp /usr/local/lib/MLPP.so --std=c++17
``` ```
## Usage ## Usage
Please note that ML++ uses the ```std::vector<double>``` data type for emulating vectors, and the ```std::vector<std::vector<double>>``` data type for emulating matricies. Please note that ML++ uses the ```std::vector<double>``` data type for emulating vectors, and the ```std::vector<std::vector<double>>``` data type for emulating matrices.
Begin by including the respective header file of your choice. Begin by including the respective header file of your choice.
```cpp ```cpp
@ -40,7 +40,7 @@ Next, instantiate an object of the class. Don't forget to pass the input set and
```cpp ```cpp
LinReg model(inputSet, outputSet); LinReg model(inputSet, outputSet);
``` ```
Afterwards, 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. Afterwards, 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 panel.
```cpp ```cpp
model.gradientDescent(0.001, 1000, 0); model.gradientDescent(0.001, 1000, 0);
``` ```