timbertrek

A Python package to run TimberTrek in your computational notebooks.


Keywords
Jupyter, JupyterLab, JupyterLab3, Machine, Learning, Interpretable, ML, Visualization, Interactive, decision-tree, interactive-visualizations, interpretability, rashomon
License
MIT
Install
pip install timbertrek==0.1.7

Documentation

TimberTrek

Github Actions Status Binder Lite pypi license arxiv badge

Curate decision trees that align with your knowledge and values!

🚀 Live Demo 📺 Demo Video 👨🏻‍🏫 Conference Talk 📖 Research Paper

Web Demo

For a live web demo, visit: https://poloclub.github.io/timbertrek.

You can use the web demo to explore your own Rashomon Sets! You just need to choose the my own set tab below the tool and upload a JSON file containing all decision paths in your Rashomon Set.

Check out this example notebook to see how to generate the whole Rashomon Set and the JSON file.

Notebook Demos

You can directly use TimberTrek in your favorite computational notebooks (e.g. Jupyter Notebook/Lab, Google Colab, and VS Code Notebook).

Check out three live notebook demos below.

Jupyter Lite Binder Google Colab
Lite Binder Open In Colab

Install

To use TimberTrek in a notebook, you would need to install TimberTrek with pip:

pip install timbertrek

Development

Clone or download this repository:

git clone git@github.com:poloclub/timbertrek.git

Install the dependencies:

npm install

Then run TimberTrek:

npm run dev

Navigate to localhost:3000. You should see TimberTrek running in your browser :)

Credits

Led by Jay Wang, TimberTrek is a result of a collaboration between ML and visualization researchers from Georgia Tech, Duke University, Fujitsu Laboratories, and University of British Columbia. TimberTrek is created by Jay Wang, Chudi Zhong, Rui Xin, Takuya Takagi, Zhi Chen, Polo Chau, Cynthia Rudin, and Margo Seltzer.

Citation

To learn more about TimberTrek, please read our research paper (published at IEEE VIS 2022). To learn more about the algorithm to generate the whole Rashomon set of sparse decision trees, please read our TreeFARMS paper (published at NeurIPS'22). If you find TimberTrek useful for your research, please consider citing our paper. Thanks!

@inproceedings{wangTimberTrekExploringCurating2022,
  title = {{{TimberTrek}}: {{Exploring}} and {{Curating Trustworthy Decision Trees}} with {{Interactive Visualization}}},
  booktitle = {2022 {{IEEE Visualization Conference}} ({{VIS}})},
  author = {Wang, Zijie J. and Zhong, Chudi and Xin, Rui and Takagi, Takuya and Chen, Zhi and Chau, Duen Horng and Rudin, Cynthia and Seltzer, Margo},
  year = {2022}
}

License

The software is available under the MIT License.

Contact

If you have any questions, feel free to open an issue or contact Jay Wang.