MAINT, API Change trunk-classification into three separate functions …

…for generating trunk, trunk-mix, trunk-overlap and marron-wand (#227) * separate trunk_classification -> trunk_classification, marron_wand_classification and trunk_mixture_classification --------- Signed-off-by: Adam Li <[email protected]>
neurodata · Feb 23, 2024 · 928a855 · 928a855
1 parent 9e571bf
commit 928a855
Show file tree

Hide file tree

Showing 6 changed files with 378 additions and 136 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -168,6 +168,8 @@ those offered in scikit-learn.
    make_joint_factor_model
    make_quadratic_classification
    make_trunk_classification
+   make_trunk_mixture_classification
+   make_marron_wand_classification
    approximate_clf_mutual_information
    approximate_clf_mutual_information_with_monte_carlo
 

diff --git a/doc/whats_new/v0.7.rst b/doc/whats_new/v0.7.rst
@@ -27,6 +27,9 @@ Changelog
     by `Sambit Panda`_ (:pr:`#203`)
 - |Feature| :func:`sktree.stats.build_coleman_forest` and :func:`sktree.stats.build_permutation_forest`
     are added to compute p-values given an estimator and permutation-estimator, `Adam Li`_ (:pr:`#222`)
+- |API| :func:`sktree.datasets.make_trunk_classification` for generating trunk mixture and Marron-Wand
+    simulations are separated out into :func:`sktree.datasets.make_marron_wand_classification` and
+    :func:`sktree.datasets.make_trunk_mixture_classification`, `Adam Li`_ (:pr:`#227`)
 - |API| :class:`sktree.HonestForestClassifier` and :class:`sktree.tree.HonestTreeClassifier`
     now overwrite all parameters set by the underlying ``tree_estimator`` and allow you to directly
     pass any extra parameters that ``tree_estimator`` has compared to the original

diff --git a/sktree/datasets/__init__.py b/sktree/datasets/__init__.py
@@ -1,7 +1,9 @@
 from .hyppo import (
     approximate_clf_mutual_information,
     approximate_clf_mutual_information_with_monte_carlo,
+    make_marron_wand_classification,
     make_quadratic_classification,
     make_trunk_classification,
+    make_trunk_mixture_classification,
 )
 from .multiview import make_gaussian_mixture, make_joint_factor_model