README.md 1.14 KB
Newer Older
Leodegario Lorenzo II's avatar
Leodegario Lorenzo II committed
1
# `mltools`: Your one stop shop for all your ML1 Models!
2
Are you tired of copy pasting ML codes scattered accross different notebooks? Want to run machine learning models but don't know how to iterate and cross validate your models? Don't know how to interpret the results of your model? Don't fret cause `mltools` got the tools that you need!
Leodegario Lorenzo II's avatar
Leodegario Lorenzo II committed
3

Lorenzo, Leodegario U. II's avatar
Lorenzo, Leodegario U. II committed
4
This library/code contains all the learnings taken from the ML1 class and some more. This includes all the machine learning models used, the cross validation strategy, interpretability strategies, and many more! The code was designed to be beginner friendly, easy to use, easy to integrate, and encourage collaboration across team members!
Leodegario Lorenzo II's avatar
Leodegario Lorenzo II committed
5

6
Please check the `recipe-book.ipynb` or `recipe-book.html` for a sample usage of `mltools.py`!
Leodegario Lorenzo II's avatar
Leodegario Lorenzo II committed
7

8
## Installation
Lorenzo, Leodegario U. II's avatar
Lorenzo, Leodegario U. II committed
9
For a quick and easy installation of `mltools`, perform the following steps:
Leodegario Lorenzo II's avatar
Leodegario Lorenzo II committed
10

11
1. Clone the `mltools` project on any local directory.
Lorenzo, Leodegario U. II's avatar
Lorenzo, Leodegario U. II committed
12 13 14 15 16
2. Execute:
    ```
    ~$ python setup.py
    ```
3. `import mltools` and enjoy!
Leodegario Lorenzo II's avatar
Leodegario Lorenzo II committed
17

Lorenzo, Leodegario U. II's avatar
Lorenzo, Leodegario U. II committed
18
All of `mltools.py` functionalities can now be used on your project. Remember to update the `mltools` repository once in a while for possible new features!