Skip to content

Commit

Permalink
fix docs, add notes about the name change in README
Browse files Browse the repository at this point in the history
  • Loading branch information
SUKI-O committed Jul 7, 2024
1 parent 76a5bc6 commit e8e2b8c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@
[![DOI](https://zenodo.org/badge/491260497.svg)](https://zenodo.org/doi/10.5281/zenodo.8412279)

treeple
===========
=======

treeple is a scikit-learn compatible API for building state-of-the-art decision trees. These include unsupervised trees, oblique trees, uncertainty trees, quantile trees and causal trees.

Tree-models have withstood the test of time, and are consistently used for modern-day data science and machine learning applications. They especially perform well when there are limited samples for a problem and are flexible learners that can be applied to a wide variety of different settings, such as tabular, images, time-series, genomics, EEG data and more.

Note that this package was originally named ``scikit-tree`` but was renamed to ``treeple`` after version 0.9.0. version <0.9.0 is still available at <https://pypi.org/project/scikit-tree/>.

Documentation
=============

Expand Down
5 changes: 3 additions & 2 deletions doc/whats_new/v0.9.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Version 0.9
Changelog
---------

-
- |MNT| Rename the package to ``treeple``. By `SUKI-O`_ (:pr:`#292`)


Code and Documentation Contributors
-----------------------------------
Expand All @@ -22,4 +23,4 @@ Thanks to everyone who has contributed to the maintenance and improvement of
the project since version inception, including:

* `Adam Li`_

* `SUKI-O`_
2 changes: 1 addition & 1 deletion examples/sklearn_vs_sktree/README.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _sklearn_examples:

Comparing sklearn and treeple decision trees
-------------------------------------------
--------------------------------------------

Examples demonstrating the difference between sklearn and treeple decision trees.

0 comments on commit e8e2b8c

Please sign in to comment.