Ryan Curtin
c8eb3dceac
* Add pipeline to documentation homepage. * Fix for mobile devices. * Add little pipelines to go at the top of each page. * Overhaul index page. * Overhaul README to remove redundant material. * Add installation documentation. * Update pipelines. * Allow nesting of deeper details. * Add a pipeline to the top of the load/save page. * Add prerequisites link to main pipeline. * Add better but not finished sidebar. * Add a couple new documentation pages. * Fix URLs in svg. * Incremental checkin. * Fix Youtube URLs. * Incremental checkin. * Minor fixes. * Add first pass at evaluation/deployment pages. * Minor spacing and link fixes. * Flesh out a number of additional pages and write basic compilation documentation. * Fix some minor issues, and add Docker deployment page (not totally finished yet). * Add developer documentation landing page. * Hopefully getting close to the final set of changes here. * Remove this documentation for now. * Fix a few links, and the size of the sidebar. * Fix some additional links. * Fix a bunch more links. * Fix another link that now has a better place. * Refactor test-docs.sh to handle documentation that is a standalone program. * Fix file exclusions. * Fully qualify typename. * Update name of file. * Fix syntax error. * Remove files that are not meant to be compiled. * Also skip the quickstart. * Move quickstart entry to the top. * Remove gray coloring of binding documentation. * Update name of sidebar link. * Update to working link. * Fix Wikipedia anchor.
582 lines
16 KiB
HTML
582 lines
16 KiB
HTML
<!--
|
|
sidebar.html
|
|
|
|
This file defines the documentation sidebar. If you are adding a new
|
|
documentation file, be sure to add the link here in the right section.
|
|
|
|
This is in pure HTML due to the kramdown parser not being able to read bulleted
|
|
lists with details.
|
|
|
|
All relative links should be prefixed with "LINKROOT". These will be replaced
|
|
when the sidebar is built for each page.
|
|
-->
|
|
|
|
<div id="sidebar">
|
|
<ul>
|
|
<li>
|
|
<details open="true"> <!-- default open for non-binding pages -->
|
|
<summary>
|
|
<a href="LINKROOTindex.html" class="textlink"><b>C++ API Documentation</b></a>
|
|
</summary>
|
|
|
|
<ul>
|
|
<!-- The "Prerequisites" section stays expanded at the top level. -->
|
|
<li>
|
|
<a href="LINKROOTquickstart/cpp.html">Quickstart</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/install.html">Installing mlpack</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTembedded/supported_boards.html">Cross-compilation setup</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/matrices.html">Data representation in mlpack</a>
|
|
</li>
|
|
<li class="bottom-space">
|
|
<a href="LINKROOTcitation.html">Citation</a>
|
|
</li>
|
|
|
|
<!-- Documentation for library core functions -->
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/tutorials.html">
|
|
Tutorials and Examples
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="https://github.com/mlpack/examples/">
|
|
mlpack examples repository
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://www.youtube.com/@mlpack">
|
|
mlpack Youtube channel
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/mlpack/models/">
|
|
mlpack models repository
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li class="bottom-space">
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/core.html">
|
|
Utility classes
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/core/math.html">
|
|
Math
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/distances.html">
|
|
Distances
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/distributions.html">
|
|
Distributions
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/kernels.html">
|
|
Kernels
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/core/trees.html">
|
|
Trees
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/core/trees/kdtree.html">
|
|
<code>KDTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/trees/mean_split_kdtree.html">
|
|
<code>MeanSplitKDTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/trees/ball_tree.html">
|
|
<code>BallTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/trees/mean_split_ball_tree.html">
|
|
<code>MeanSplitBallTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/trees/vptree.html">
|
|
<code>VPTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/trees/rp_tree.html">
|
|
<code>RPTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/trees/max_rp_tree.html">
|
|
<code>MaxRPTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/trees/ub_tree.html">
|
|
<code>UBTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/trees/binary_space_tree.html">
|
|
<code>BinarySpaceTree</code>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
<!-- Data loading and I/O -->
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/load_save.html">
|
|
Data loading and I/O
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/load_save.html#numeric-data">
|
|
Numeric data
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/load_save.html#mixed-categorical-data">
|
|
Mixed categorical data
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/load_save.html#image-data">
|
|
Image data
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/load_save.html#mlpack-objects">
|
|
mlpack models and objects
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
<!-- Preprocessing / feature extraction -->
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/preprocessing.html">
|
|
Preprocessing/feature extraction
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/core/normalizing_labels.html">
|
|
Normalizing labels
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/core/split.html">
|
|
Dataset splitting
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
<!-- Transformations -->
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/transformations.html">
|
|
Transformations
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/amf.html">
|
|
<code>AMF</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/local_coordinate_coding.html">
|
|
<code>LocalCoordinateCoding</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/lmnn.html">
|
|
<code>LMNN</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/nca.html">
|
|
<code>NCA</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/nmf.html">
|
|
<code>NMF</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/pca.html">
|
|
<code>PCA</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/radical.html">
|
|
<code>RADICAL</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/sparse_coding.html">
|
|
<code>SparseCoding</code>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
<!-- Classification algorithms -->
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/modeling.html">
|
|
Modeling
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/modeling.html#classification">
|
|
Classification
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/adaboost.html">
|
|
<code>AdaBoost</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/decision_tree.html">
|
|
<code>DecisionTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/hoeffding_tree.html">
|
|
<code>HoeffdingTree</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/linear_svm.html">
|
|
<code>LinearSVM</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/logistic_regression.html">
|
|
<code>LogisticRegression</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/naive_bayes_classifier.html">
|
|
<code>NaiveBayesClassifier</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/perceptron.html">
|
|
<code>Perceptron</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/random_forest.html">
|
|
<code>RandomForest</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/softmax_regression.html">
|
|
<code>SoftmaxRegression</code>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/modeling.html#regression">
|
|
Regression
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/bayesian_linear_regression.html">
|
|
<code>BayesianLinearRegression</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/decision_tree_regressor.html">
|
|
<code>DecisionTreeRegressor</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/lars.html">
|
|
<code>LARS</code>
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/linear_regression.html">
|
|
<code>LinearRegression</code>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/modeling.html#clustering">
|
|
Clustering
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/methods/mean_shift.html">
|
|
<code>MeanShift</code>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/modeling.html#geometric-algorithms">
|
|
Geometric algorithms
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
<!-- Evaluation -->
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/evaluation.html">
|
|
Evaluation
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/cv.html">
|
|
Cross-validation
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/hpt.html">
|
|
Hyperparameter tuning
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
<!-- Deployment -->
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTuser/deployment.html">
|
|
Deployment
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTuser/compile.html">
|
|
Compilation
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTembedded/crosscompile_armv7.html">
|
|
Cross-compile to RPi2
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/deploy_windows.html">
|
|
Deploying mlpack on Windows
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTdeveloper/developers.html">
|
|
Developers
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/community.html">
|
|
Community
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/gsoc.html">
|
|
GSoC
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/ci.html">
|
|
CI/CD
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/timer.html">
|
|
Timers
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/bindings.html">
|
|
Binding system
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/iodoc.html">
|
|
Writing a binding
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<details>
|
|
<summary>
|
|
<a href="LINKROOTdeveloper/policies.html">
|
|
Template policies
|
|
</a>
|
|
</summary>
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/elemtype.html">
|
|
ElemType
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/distances.html">
|
|
DistanceType
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/kernels.html">
|
|
KernelType
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTdeveloper/trees.html">
|
|
TreeType
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
</ul>
|
|
|
|
<!-- Binding documentation section -->
|
|
<ul id="binding_sidebar">
|
|
<li>
|
|
<details> <!-- default closed for non-binding pages -->
|
|
<summary>
|
|
<a href="LINKROOTuser/bindings.html" class="textlink"><b>Binding API</b></a>
|
|
</summary>
|
|
|
|
<ul>
|
|
<li>
|
|
<a href="LINKROOTquickstart/python.html">
|
|
Python quickstart
|
|
</a>
|
|
</li>
|
|
<li class="bottom-space">
|
|
<a href="LINKROOTuser/bindings/python.html">
|
|
Python binding documentation
|
|
</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="LINKROOTquickstart/julia.html">
|
|
Julia quickstart
|
|
</a>
|
|
</li>
|
|
<li class="bottom-space">
|
|
<a href="LINKROOTuser/bindings/julia.html">
|
|
Julia binding documentation
|
|
</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="LINKROOTquickstart/r.html">
|
|
R quickstart
|
|
</a>
|
|
</li>
|
|
<li class="bottom-space">
|
|
<a href="LINKROOTuser/bindings/r.html">
|
|
R binding documentation
|
|
</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="LINKROOTquickstart/cli.html">
|
|
CLI quickstart
|
|
</a>
|
|
</li>
|
|
<li class="bottom-space">
|
|
<a href="LINKROOTuser/bindings/cli.html">
|
|
CLI binding documentation
|
|
</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="LINKROOTquickstart/go.html">
|
|
Go quickstart
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LINKROOTuser/bindings/go.html">
|
|
Go binding documentation
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<!-- Page-specific sidebar section will go next, and will close the div. -->
|