Skip to main content

Python package treeplot vizualizes a tree based on a randomforest or xgboost model.

Project description

treeplot

Python PyPI Version License Downloads Downloads

  • 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.

Have fun!

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.plot_tree() : Plot the decission tree model. Parameters can be specified.
  • 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

Contents

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.

Quick Start

pip install treeplot
  • Alternatively, install treeplot from the GitHub source:
git clone https://github.com/erdogant/treeplot.git
cd treeplot
python setup.py install

Import treeplot package

import treeplot

Example RandomForest:

# 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)
# Make plot
ax = treeplot.plot(model)
# or directly
ax = treeplot.randomforest(model)

# If more parameters needs to be specified, use the exact function:
ax = treeplot.randomforest(model, export='pdf')

Example XGboost:

# 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)
# Make plot
ax = treeplot.plot(model)
# or directly
ax = treeplot.xgboost(model)

# If more parameters needs to be specified, use the exact function:
ax = treeplot.xgboost(model, plottype='vertical')

Maintainers

Contribute

  • Contributions are welcome.

Licence

See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

treeplot-0.1.9.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

treeplot-0.1.9-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file treeplot-0.1.9.tar.gz.

File metadata

  • Download URL: treeplot-0.1.9.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for treeplot-0.1.9.tar.gz
Algorithm Hash digest
SHA256 e3ccd22e0bbbf10b6fe5659771ae0ef289f61c9538516986dedd0f5f301d5ac4
MD5 2a1523d9594cc24167c37f1e5a62d01e
BLAKE2b-256 5aa0c7cacc16c813057aeb0ec570b246991e08c80bbd86f8a5f86c81d18f9d92

See more details on using hashes here.

File details

Details for the file treeplot-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: treeplot-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for treeplot-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ea14d2981c2afdf138fcc6319dacbedab28fbbc025b5a0b7ea5e7a9ba65751c4
MD5 bde7864c6548d792efaeaf159434d5b9
BLAKE2b-256 82430c997e4fa7e00dbe054b7ace98c3408e1c660974f701d4f941122d4e3839

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page