Files
mlpack/doc/sidebar.html
T
Ryan CurtinandDirk Eddelbuettel e70a04fbba Add Docker deployment documentation (#3907)
* Add a first attempt at explicitly using Jenkinsfiles.

* A first attempt...

* Put code in a script block.

* Add first attempt at link check job pipeline.

* Hopefully correct shell block.

* Install git.

* Install packages as root.

* Use custom image that already has dependencies installed.

* Try processing the JUnit results.

* Fix syntax (hopefully).

* Try to get the build to set its status on Github.

* Try and see if I can get the snippet build to run too.

* A first attempt at reviving the static code analysis build.

* Refactor style check job a bit.

* Try to clean up other files and have them set statuses.

* Set status in script blocks.

* Fix directory (this may not fix my problem).

* Should I load in the script step?

* Maybe I can just load it without a name.

* Maybe I have my path wrong.

* Will this work?  Just a test...

* Try using a plugin instead.

* And if I define the function manually at the top?

* Maybe this will fix the load.

* Try to turn unstable into failed.

* Hopefully fix documentation builds.

* Fix script blocks.

* Maybe fix static code analysis job.

* Try to adapt PR number variable.

* First attempt at cross-compilation job.

* Try to fix some syntax.

* Clean workspaces after build.

* Try to put the matrix in the right place.

* Another attempt at the matrix configuration.

* Maybe I have to nest it deeper.

* Maybe I have to clean always?

* What we need is more tabbing.

* Use try/catch to handle failed junit processing.

* Better handling of environment variables.

* Try a differernt approach than try/catch.

* Try to get some more information about ccache.

* Is it possible we could store the ccache at a higher level?

* Maybe I have the variable name wrong.

* Clean the cross-compilation workspace.

* Try mounting the ccache so it can be shared across multiple jobs.

* Always pull images.

* We need to run on the same node.

* Run on only one core.

* Try building in the Docker container in a different way.

* Do I have the order backwards?

* Can I run anything at all in the container?

* The static code analysis job isn't helpful.

* Try to set the user of the docker container.

* Rebuild the Docker container instead.

* Always pull an updated image.

* Download any necessary dependencies too.

* Oops, use the correct CMake options.

* Fix line break in the wrong place.

* Make sure to use the correct architecture.

* We can't use MATCHES, that is a regex.

* Oops, we need to use STREQUAL.

* Bump to an older version since newer versions don't have gfortran.

* Try to run the tests on the target.

* Correct syntax.

* Okay, I'm not allowed to generate a stage name.

* Try cleaning the workspace at the start of the build.

* Okay, so I just can't depend on the workspace cleaning job, wonderful.

* Try and add the passphrase correctly.

* Fix path for memory checks.

* Fix path to test.

* Fix PR number variable.

* Try to fix path for test copying.

* Try to get the PR number correct.

* Try and centralize where the link cache is stored.

* Why is it being printed strangely?

* Is there some weird restriction where this all has to be on one line?

* Always publish the HTML, and fix a link.

* Try to fix SSH host key check.

* Make the reports directory.

* Try to fix file parsing.

* Try to enable ccache.

* Try to set ccache directory correctly.

* Try to get the full pipeline set up correctly for cross-compilation.

* Fix path to test data.

* Allow debug builds when cross-compiling.

* Remember to unpack all the test data!

* Fail tests when the data isn't there.

* Maybe I can use find instead.

* Double escape for backslash?

* What if we just run the test?

* Port Catch2 improvement for junit runner.

See https://github.com/catchorg/Catch2/commit/c29e198eab0ccdb190495397854b937677385e2e.

* Re-enable junit testing (hopefully it will work now).

* Output directly to the xml file.

* Try to clean up regex.

* Try to set IN PROGRESS status.

* Could it be called RUNNING?

* I guess I don't get access to set jobs in progress through this API.

* Fix regex for test name extraction.

* Try to clean up Jenkinsfiles.

* Fix parameter name.

* Maybe fix syntax?

* Does it work without keyword arguments?

* Correctly accept named parameters.

* Abort previous builds to reduce load on Jenkins.

* Use optimization when compiling.

* Fix syntax for abortPrevious.

* Fix missing closing brace...

* Update links in CI documentation and try to fix memory check job.

* Add Docker deployment page.

* Fix link.

* Fix missing link in pipeline.

* Apply suggestions from code review

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>

* Try to get some more information on the build failure.

* Fix link that now redirects.

* Try to get some more information about why we are not linking against OpenBLAS.

* I think the variable name was wrong, we will see...

* Clean things up since the build should work now.

---------

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>
2025-03-12 16:49:34 -04:00

632 lines
18 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>
<li>
<a href="LINKROOTuser/core/trees/cover_tree.html">
<code>CoverTree</code>
</a>
</li>
<li>
<a href="LINKROOTuser/core/trees/octree.html">
<code>Octree</code>
</a>
</li>
<li>
<a href="LINKROOTuser/core/trees/r_tree.html">
<code>RTree</code>
</a>
</li>
<li>
<a href="LINKROOTuser/core/trees/r_star_tree.html">
<code>RStarTree</code>
</a>
</li>
<li>
<a href="LINKROOTuser/core/trees/x_tree.html">
<code>XTree</code>
</a>
</li>
<li>
<a href="LINKROOTuser/core/trees/r_plus_tree.html">
<code>RPlusTree</code>
</a>
</li>
<li>
<a href="LINKROOTuser/core/trees/r_plus_plus_tree.html">
<code>RPlusPlusTree</code>
</a>
</li>
<li>
<a href="LINKROOTuser/core/trees/hilbert_r_tree.html">
<code>HilbertRTree</code>
</a>
</li>
<li>
<a href="LINKROOTuser/core/trees/rectangle_tree.html">
<code>RectangleTree</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>
<li>
<a href="LINKROOTuser/deploy_docker.html">
Deploying with Docker
</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. -->