From 8aafcb7ec9aff31c4cb5d9705beb39ed3cbafbb8 Mon Sep 17 00:00:00 2001 From: Ryan Curtin Date: Sat, 24 Aug 2024 13:12:47 -0400 Subject: [PATCH 1/5] Fix classification of mlpack_hoeffding_tree binding. --- src/mlpack/methods/CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/mlpack/methods/CMakeLists.txt b/src/mlpack/methods/CMakeLists.txt index 11e926ee69..7dc1c46ad5 100644 --- a/src/mlpack/methods/CMakeLists.txt +++ b/src/mlpack/methods/CMakeLists.txt @@ -26,7 +26,7 @@ add_all_bindings(hmm hmm_train "Misc. / Other") add_all_bindings(hmm hmm_generate "Misc. / Other") add_all_bindings(hmm hmm_loglik "Misc. / Other") add_all_bindings(hmm hmm_viterbi "Misc. / Other") -add_all_bindings(hoeffding_trees hoeffding_tree "Clustering") +add_all_bindings(hoeffding_trees hoeffding_tree "Classification") add_all_bindings(kde kde "Misc. / Other") add_all_bindings(kernel_pca kernel_pca "Transformations") add_all_bindings(kmeans kmeans "Clustering") From 7161eb512892f39fea5f172994655940457a265c Mon Sep 17 00:00:00 2001 From: Ryan Curtin Date: Sat, 24 Aug 2024 13:12:55 -0400 Subject: [PATCH 2/5] Add notes indicating that documentation is not yet complete. --- doc/index.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/index.md b/doc/index.md index 8fe5b875b1..34aa7fea2f 100644 --- a/doc/index.md +++ b/doc/index.md @@ -100,6 +100,11 @@ Predict continuous values. ### Clustering algorithms +***NOTE:*** this documentation is still under construction and so some +algorithms that mlpack implements are not yet listed here. For now, see +[the mlpack/methods directory](https://github.com/mlpack/mlpack/tree/master/src/mlpack/methods) +for a full list of algorithms. + Group points into clusters. * [`MeanShift`](user/methods/mean_shift.md): clustering with the density-based @@ -107,18 +112,33 @@ Group points into clusters. ### Geometric algorithms +***NOTE:*** this documentation is still under construction and so no geometric +algorithms in mlpack are documented yet. For now, see +[the mlpack/methods directory](https://github.com/mlpack/mlpack/tree/master/src/mlpack/methods) +for a full list of algorithms. + Computations based on distance metrics. ### Preprocessing utilities +***NOTE:*** this documentation is still under construction and so no +preprocessing utilities in mlpack are documented yet. For now, see +[the mlpack/methods/preprocess directory](https://github.com/mlpack/mlpack/tree/master/src/mlpack/methods) +for a full list of algorithms. + Prepare data for machine learning algorithms. ### Transformations +***NOTE:*** this documentation is still under construction and so some +algorithms that mlpack implements are not yet listed here. For now, see +[the mlpack/methods directory](https://github.com/mlpack/mlpack/tree/master/src/mlpack/methods) +for a full list of algorithms. + Transform data from one space to another. * [`AMF`](user/methods/amf.md): alternating matrix factorization From 4ac1dd8cc10738344335a523c0dda198efaae352 Mon Sep 17 00:00:00 2001 From: Ryan Curtin Date: Sat, 24 Aug 2024 11:18:44 -0400 Subject: [PATCH 3/5] Host locally because the other source has been hijacked. --- doc/user/methods/decision_tree_regressor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/methods/decision_tree_regressor.md b/doc/user/methods/decision_tree_regressor.md index b0a0cb8c21..68e07c6fc2 100644 --- a/doc/user/methods/decision_tree_regressor.md +++ b/doc/user/methods/decision_tree_regressor.md @@ -474,7 +474,7 @@ class CustomNumericSplit - ***Note***: `BestBinaryCategoricalSplit` should not be chosen when there are multiple classes and many categories. - ***Note***: for regression tasks, - [W. Fisher's proof of correctness](http://www.csiss.org/SPACE/workshops/2004/SAC/files/fisher.pdf) + [W. Fisher's proof of correctness](http://www.mlpack.org/files/fisher.pdf) only applies to when `FitnessFunction` is `MSEGain`; therefore, `BestBinaryCategoricalSplit` requires the use of `MSEGain`. * A custom class must take a [`FitnessFunction`](#fitnessfunction) as a From 0dffe34cdf5961e2baa488fed400c6929c5c98bd Mon Sep 17 00:00:00 2001 From: Ryan Curtin Date: Tue, 27 Aug 2024 12:16:46 -0400 Subject: [PATCH 4/5] Oops, fix location of PDF. --- doc/user/methods/decision_tree_regressor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/methods/decision_tree_regressor.md b/doc/user/methods/decision_tree_regressor.md index 68e07c6fc2..b630a8cff0 100644 --- a/doc/user/methods/decision_tree_regressor.md +++ b/doc/user/methods/decision_tree_regressor.md @@ -474,7 +474,7 @@ class CustomNumericSplit - ***Note***: `BestBinaryCategoricalSplit` should not be chosen when there are multiple classes and many categories. - ***Note***: for regression tasks, - [W. Fisher's proof of correctness](http://www.mlpack.org/files/fisher.pdf) + [W. Fisher's proof of correctness](http://www.mlpack.org/papers/fisher.pdf) only applies to when `FitnessFunction` is `MSEGain`; therefore, `BestBinaryCategoricalSplit` requires the use of `MSEGain`. * A custom class must take a [`FitnessFunction`](#fitnessfunction) as a From 952126a86212821c8e721c329b1ff2dbfd76a545 Mon Sep 17 00:00:00 2001 From: Ryan Curtin Date: Tue, 27 Aug 2024 14:58:30 -0400 Subject: [PATCH 5/5] Use HTTPS instead of HTTP. --- doc/user/methods/decision_tree_regressor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/methods/decision_tree_regressor.md b/doc/user/methods/decision_tree_regressor.md index b630a8cff0..b465a5f4f6 100644 --- a/doc/user/methods/decision_tree_regressor.md +++ b/doc/user/methods/decision_tree_regressor.md @@ -474,7 +474,7 @@ class CustomNumericSplit - ***Note***: `BestBinaryCategoricalSplit` should not be chosen when there are multiple classes and many categories. - ***Note***: for regression tasks, - [W. Fisher's proof of correctness](http://www.mlpack.org/papers/fisher.pdf) + [W. Fisher's proof of correctness](https://www.mlpack.org/papers/fisher.pdf) only applies to when `FitnessFunction` is `MSEGain`; therefore, `BestBinaryCategoricalSplit` requires the use of `MSEGain`. * A custom class must take a [`FitnessFunction`](#fitnessfunction) as a