mlpack
|
#include <mlpack/prereqs.hpp>
#include <mlpack/core/util/io.hpp>
#include <mlpack/core/util/mlpack_main.hpp>
#include "dt_utils.hpp"
Functions | |
BINDING_NAME ("Density Estimation With Density Estimation Trees") | |
BINDING_SHORT_DESC ("An implementation of density estimation trees for the density estimation " "task. Density estimation trees can be trained or used to predict the " "density at locations given by query points.") | |
BINDING_LONG_DESC ("This program performs a number of functions related to Density Estimation " "Trees. The optimal Density Estimation Tree (DET) can be trained on a set " "of data (specified by "+PRINT_PARAM_STRING("training")+") using " "cross-validation (with number of folds specified with the "+PRINT_PARAM_STRING("folds")+" parameter). This trained density " "estimation tree may then be saved with the "+PRINT_PARAM_STRING("output_model")+" output parameter." "\" "The variable importances (that is, the feature importance values for each " "dimension) may be saved with the "+PRINT_PARAM_STRING("vi")+" output" " parameter, and the density estimates for each training point may be saved" " with the "+PRINT_PARAM_STRING("training_set_estimates")+" output " "parameter." "\" "Enabling path printing for each node outputs the path from the root node " "to a leaf for each entry in the test set, or training set (if a test set " "is not provided). Strings like 'LRLRLR' (indicating that traversal went " "to the left child, then the right child, then the left child, and so " "forth) will be output. If 'lr-id' or 'id-lr' are given as the "+PRINT_PARAM_STRING("path_format")+" parameter, then the ID (tag) of " "every node along the path will be printed after or before the L or R " "character indicating the direction of traversal, respectively." "\" "This program also can provide density estimates for a set of test points, " "specified in the "+PRINT_PARAM_STRING("test")+" parameter. The " "density estimation tree used for this task will be the tree that was " "trained on the given training points, or a tree given as the parameter "+PRINT_PARAM_STRING("input_model")+". The density estimates for the test" " points may be saved using the "+PRINT_PARAM_STRING("test_set_estimates")+" output parameter.") | |
BINDING_SEE_ALSO ("Density estimation tree (DET) tutorial", "@doxygen/dettutorial.html") | |
BINDING_SEE_ALSO ("Density estimation on Wikipedia", "https://en.wikipedia.org/wiki/Density_estimation") | |
BINDING_SEE_ALSO ("Density estimation trees (pdf)", "http://www.mlpack.org/papers/det.pdf") | |
BINDING_SEE_ALSO ("mlpack::tree::DTree class documentation", "@doxygen/classmlpack_1_1det_1_1DTree.html") | |
PARAM_MATRIX_IN ("training", "The data set on which to build a density " "estimation tree.", "t") | |
PARAM_MODEL_IN (DTree<>, "input_model", "Trained density estimation " "tree to load.", "m") | |
PARAM_MODEL_OUT (DTree<>, "output_model", "Output to save trained " "density estimation tree to.", "M") | |
PARAM_MATRIX_IN ("test", "A set of test points to estimate the density of.", "T") | |
PARAM_MATRIX_OUT ("training_set_estimates", "The output density estimates on " "the training set from the final optimally pruned tree.", "e") | |
PARAM_MATRIX_OUT ("test_set_estimates", "The output estimates on the test set " "from the final optimally pruned tree.", "E") | |
PARAM_MATRIX_OUT ("vi", "The output variable importance values for each " "feature.", "i") | |
PARAM_STRING_IN ("path_format", "The format of path printing: 'lr', 'id-lr', or " "'lr-id'.", "p", "lr") | |
PARAM_STRING_OUT ("tag_counters_file", "The file to output the number of points " "that went to each leaf.", "c") | |
PARAM_STRING_OUT ("tag_file", "The file to output the tags (and possibly paths)" " for each sample in the test set.", "g") | |
PARAM_FLAG ("skip_pruning", "Whether to bypass the pruning process and output " "the unpruned tree only.", "s") | |
PARAM_INT_IN ("folds", "The number of folds of cross-validation to perform for " "the estimation (0 is LOOCV)", "f", 10) | |
PARAM_INT_IN ("min_leaf_size", "The minimum size of a leaf in the unpruned, " "fully grown DET.", "l", 5) | |
PARAM_INT_IN ("max_leaf_size", "The maximum size of a leaf in the unpruned, " "fully grown DET.", "L", 10) | |
This file runs density estimation trees.
mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see http://www.opensource.org/licenses/BSD-3-Clause for more information.