Slowmokit

## ML kit in C++. Header-only library which can be used for machine learning in C++. ### Installation guide To use this library locally #### Prerequisites - [CMAKE](https://cmake.org/install/) - [CPP 17](https://codeforces.com/blog/entry/96040) - [Armadillo](https://arma.sourceforge.net/download.html) Then following command will install the library ```bash ./scripts/install ``` > If permission is required to execute, run the following command ``` chmod 705 ./scripts/install ``` ### Compile and run To compile and run the code written using this library, you need to add the following flags along with the standard commands. For example, you want to run `hello.cpp` and it has `slowmokit` dependencies. ```bash g++ -std=c++17 -larmadillo hello.cpp -o hello && ./hello ``` ### Steps to contribute Following are the steps to start contributing to our beautiful library: 1. Install an IDE, preferably [CLion](https://www.jetbrains.com/clion/download/). 2. Fork this repo. 3. Clone the forked repo, using `git clone https://github.com//slowmokit.git`. After this, You can directly use the executable file by running `./bin/nim` in the root folder of library, to do the required configurations. > If it does not work then you need to configure everything by your own. #### Configuring everything own 4. Make the model directory you want to implement in the `include/slowmokit//`. - `` is basically the class of your model, for example `linear_model` or `cluster`. 5. Create two files: - `.hpp` : the header file for the model, create the class of model here and include all the stuff required for the model here. - Include `core.hpp` for all the basic functionalities already added. - Make sure to add **doc comments above each function signature** (refer other files for the format) - Variable and function names should be in **camel case** and class names should be in **pascal case** in **all files**. - `.cpp` : implement the functions of the class here. 6. Add the header file `.hpp` in `src/slowmokit.hpp` under the documentation block as shown [here](./src/slowmokit/ducks/io/io.hpp). More on [documentation block](https://developer.lsst.io/cpp/api-docs.html#multi-line-documentation-delimiters-should-be-on-their-own-lines). 7. Test the working by building in IDE. > This step is mandatory 9. Format the files according to the convention. For simplicity, run `./scripts/clang-format-all include/` in gitbash(if on windows) or in terminal(if on linux/macos) _For this you need to have `clang-format` binaries installed in the machine._ To do that, run the following in the terminal ```bash # with npm (windows) npm install -g clang-format # you have to restart terminal in case of windows # with homebrew (macos) brew install clang-format # linux (Ubuntu) sudo apt install clang-format ``` > **NOTE:** Do **NOT** use `#include ` in any file, all the major header files are already included in `core.hpp`.] ### Example Once the algorithm is ready, run and test it. After testing, push it in the `examples` directory, with proper comments and instructions. With same directory structure as in `include`. ### Documentation Push the docs of the model in a `.md` file in same directory structure in `docs` folder. ### Pull Request (PR) format After code is ready, you can make PR to the main branch. PR will be accepted only if: - Code pass the CI tests. - Example is pushed. - Code has proper comments and instructions. ## GOOD LUCK!