Merge remote-tracking branch 'origin/master'

Author: erdogant

README.md

@@ -6,97 +6,83 @@
 [![Downloads](https://pepy.tech/badge/treeplot)](https://pepy.tech/project/treeplot)
 [![Downloads](https://pepy.tech/badge/treeplot/month)](https://pepy.tech/project/treeplot/month)
 [![BuyMeCoffee](https://img.shields.io/badge/buymea-coffee-yellow.svg)](https://www.buymeacoffee.com/erdogant)
+[![Sphinx](https://img.shields.io/badge/Sphinx-Docs-Green)](https://erdogant.github.io/treeplot/)
 <!---[![Coffee](https://img.shields.io/badge/coffee-black-grey.svg)](https://erdogant.github.io/donate/?currency=USD&amount=5)-->
 
 * ``treeplot`` is Python package to easily plot the tree derived from models such as decisiontrees, randomforest and xgboost.
 Developing explainable machine learning models is becoming more important in many domains. The most popular and classical explainable models are still tree based. Think of decision trees or random forest. The tree that is learned can be visualized and then explained. However, it can be a challange to simply plot the tree. Think of configuration issues with dot files, path locations to graphviz, differences across operating systems, differences across editors such as jupyter notebook, colab, spyder etc. This frustration led to this library, an easy way to plot the decision trees 🌲. It works for Random-forest, decission trees, xgboost and gradient boosting models. Under the hood it makes many checks, downloads graphviz, sets the path and then plots the tree.
 
-# 
-**Star this repo if you like it! ⭐️**
-#
-
 ### Functions in treeplot
 
 Treeplot can plot the tree for Random-forest, decission trees, xgboost and gradient boosting models:
-  * treeplot.plot()         : Generic function to plot the tree of any of the four models with default settings
-  * treeplot.randomforest() : Plot the randomforest model. Parameters can be specified.
-  * treeplot.xgboost()      : Plot the xgboost model. Parameters can be specified.
-  * treeplot.import_example('iris') : Import example dataset
+  * .plot         : Generic function to plot the tree of any of the four models with default settings
+  * .randomforest : Plot the randomforest model. Parameters can be specified.
+  * .xgboost      : Plot the xgboost model. Parameters can be specified.
+  * .import_example('iris') : Import example dataset
 
-### Installation
-* Install treeplot from PyPI (recommended). treeplot is compatible with Python 3.6+ and runs on Linux, MacOS X and Windows. 
-* It is distributed under the MIT license.
+# 
+**⭐️ Star this repo if you like it ⭐️**
+#
 
-#### Quick Start
-```
+#### Install treeplot from PyPI
+
+```bash
 pip install treeplot
 ```
 
- 
 #### Import treeplot package
-```python
-import treeplot
-```
 
-### Example RandomForest:
 ```python
-# Load example dataset
-X,y = treeplot.import_example()
-# Learn model
-from sklearn.ensemble import RandomForestClassifier
-model = RandomForestClassifier(n_estimators=100, max_depth=2, random_state=0).fit(X, y)
+import treeplot as tree
 ```
+# 
 
-```python
-# Make plot
-ax = treeplot.plot(model)
-# or directly
-ax = treeplot.randomforest(model)
-```
-<p align="center">
-  <img src="https://github.com/erdogant/treeplot/blob/master/docs/figs/Figure_1.png" width="550" />
-</p>
 
-```python
-# If more parameters needs to be specified, use the exact function:
-ax = treeplot.randomforest(model, export='pdf')
-```
+### [Documentation pages](https://erdogant.github.io/treeplot/)
 
-#### Example XGboost:
-```python
-# Load example dataset
-X,y = treeplot.import_example()
-# Learn model
-from xgboost import XGBClassifier
-model = XGBClassifier(n_estimators=100, max_depth=2, random_state=0).fit(X, y)
-```
+On the [documentation pages](https://erdogant.github.io/treeplot/) you can find detailed information about the working of the ``treeplot`` with examples. 
 
-```python
-# Make plot
-ax = treeplot.plot(model)
-# or directly
-ax = treeplot.xgboost(model)
-```
-<p align="center">
-  <img src="https://github.com/erdogant/treeplot/blob/master/docs/figs/Figure2_xgboost_hor.png" width="550" />
-  <img src="https://github.com/erdogant/treeplot/blob/master/docs/figs/Figure2_featimportance.png" width="350" />
+<hr> 
+
+### Examples
+
+# 
+
+* [Example: RandomForest](https://erdogant.github.io/treeplot/pages/html/Examples.html#)
+
+<p align="left">
+  <a href="https://erdogant.github.io/treeplot/pages/html/Examples.html#">
+  <img src="https://github.com/erdogant/treeplot/blob/master/docs/figs/fig_breast_randomforest.png" width="600" />
+  </a>
 </p>
 
-```python
-# If more parameters needs to be specified, use the exact function:
-ax = treeplot.xgboost(model, plottype='vertical')
-```
-<p align="center">
-  <img src="https://github.com/erdogant/treeplot/blob/master/docs/figs/Figure2_xgboost_ver.png" width="550" />
+
+# 
+
+* [Example: XGboot](https://erdogant.github.io/treeplot/pages/html/Examples.html#xgboost)
+
+<p align="left">
+  <a href="https://erdogant.github.io/treeplot/pages/html/Examples.html#xgboost">
+  <img src="https://github.com/erdogant/treeplot/blob/master/docs/figs/fig_breast_xgboot_tree.png" width="600" />
+   <br>
+  <img src="https://github.com/erdogant/treeplot/blob/master/docs/figs/fig_breast_xgboot_weights.png" width="600" />
+  </a>
 </p>
 
 
+# 
+* [Example: gradientboostingclassifier](https://erdogant.github.io/treeplot/pages/html/Examples.html#gradientboostingclassifier)
+# 
+* [Example: lightbm](https://erdogant.github.io/treeplot/pages/html/Examples.html#lightbm)
+# 
+* [Example: Explore other trees such as second best tree etc](https://erdogant.github.io/treeplot/pages/html/Examples.html#plot-second-best-tree-and-other-trees)
+
+<hr>
+
 #### Maintainers
 * Erdogan Taskesen, github: [erdogant](https://github.com/erdogant)
 
 #### Contribute
 * Contributions are welcome.
 * If you wish to buy me a <a href="https://www.buymeacoffee.com/erdogant">Coffee</a> for this work, it is very appreciated :)
 
-#### Licence
-See [LICENSE](LICENSE) for details.