From e8e2b8c634ee8eb62e153105c808d1826e5ca11b Mon Sep 17 00:00:00 2001 From: SUKI Date: Sun, 7 Jul 2024 16:30:05 -0400 Subject: [PATCH] fix docs, add notes about the name change in README --- README.md | 4 +++- doc/whats_new/v0.9.rst | 5 +++-- examples/sklearn_vs_sktree/README.txt | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 060b562be..12c7ee641 100644 --- a/README.md +++ b/README.md @@ -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 . + Documentation ============= diff --git a/doc/whats_new/v0.9.rst b/doc/whats_new/v0.9.rst index a4035ebd9..8d6b9b041 100644 --- a/doc/whats_new/v0.9.rst +++ b/doc/whats_new/v0.9.rst @@ -13,7 +13,8 @@ Version 0.9 Changelog --------- -- +- |MNT| Rename the package to ``treeple``. By `SUKI-O`_ (:pr:`#292`) + Code and Documentation Contributors ----------------------------------- @@ -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`_ diff --git a/examples/sklearn_vs_sktree/README.txt b/examples/sklearn_vs_sktree/README.txt index 15b61c43c..7794faad7 100644 --- a/examples/sklearn_vs_sktree/README.txt +++ b/examples/sklearn_vs_sktree/README.txt @@ -1,6 +1,6 @@ .. _sklearn_examples: Comparing sklearn and treeple decision trees -------------------------------------------- +-------------------------------------------- Examples demonstrating the difference between sklearn and treeple decision trees.