Merge https://github.com/gershonc/octopus-ml

README.md

@@ -2,12 +2,30 @@
 
 [![PyPI Latest Release](https://img.shields.io/pypi/v/octopus-ml.svg)](https://pypi.org/project/octopus-ml/)
 [![License](https://img.shields.io/pypi/l/octopus-ml.svg)](https://github.com/gershonc//octopus-ml/blob/master/LICENSE)
-[![Code Coverage](https://codecov.io/gh/pandas-profiling/octopus-ml/branch/master/graph/badge.svg?token=gMptB4YUnF)](https://codecov.io/gh/octopus/octopus)
 [![Python Version](https://img.shields.io/pypi/pyversions/pandas-profiling)](https://pypi.org/project/octopus-ml/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
+[![Binder](https://mybinder.org/badge.svg)](https://hub.gke2.mybinder.org/user/gershonc-octopus-ml-k5of97xu/tree)
+<!-- 
+[![Code Coverage](https://codecov.io/gh/pandas-profiling/octopus-ml/branch/master/graph/badge.svg?token=gMptB4YUnF)](https://codecov.io/gh/octopus/octopus)
+-->
+Set of handy ML and data tools - from data exploration, visualization, pre-processing, hyper parameter tuning, modeling and all the way to final Ml model evaluation 
+<br><center><img src="/images/octopus_know_your_data.png" width="570" height="480" /></center>
 
-https://pypi.org/project/octopus-ml/
-pip install octopus-ml
+## Installation
+The module can be easily installed with pip:
 
-Set of handy ML and data tools - from data exploration, visualization, pre-processing, hyper parameter tuning, modeling and all the way to final Ml model evaluation 
-![Image](/images/octopus_know_your_data.png)
+```conslole
+> pip install octopus-ml
+```
+
+This module depends on `Scikit-learn`, `NumPy`, `Pandas`, `TQDM`, `lightGBM` as defualt classifier. Optionally you can get also some nice visualisations if you have `Seaborn` installed.
+
+
+
+## Usage
+The module contains ML and Data related methods:
+
+```python
+from octopus_ml import plot_imp, adjusted_classes, cv,c v_plot, roc_curve_plot, ...
+
+```