Commit Graph
74 Commits
Author SHA1 Message Date
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
Ryan Curtin a44fbe4906 Move Jenkins job configuration into the repository (#3893)
* 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.
2025-03-12 08:34:59 -04:00
Ryan Curtin 0737eb0dc6 Document RPlusTree and RPlusPlusTree (#3897) 2025-03-03 01:13:53 +01:00
Ryan Curtin 097d3cc214 Document HilbertRTree (#3891) 2025-02-24 03:51:32 +01:00
Ryan Curtin 639244dc58 Document RStarTree (#3888) 2025-02-19 01:35:45 +01:00
Ryan Curtin e60b566e8c Document XTree (#3890) 2025-02-19 01:13:14 +01:00
Ryan CurtinandDirk Eddelbuettel e30f83c028 Document RectangleTree and RTree (#3885)
* First attempt at documenting the RectangleTree.

* Add Insert() and Delete() to RectangleTree; they have a nicer user interface than what was previously there.

* Add R-tree documentation.

* Fix default arguments for RectangleTree typedefs.

* Fix some minor documentation display issues.

* Fix link.

* Fix links.

* Try to clarify what trees are a little bit.

* Apply suggestions from code review

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

* Update doc/user/core/trees/r_tree.md

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

---------

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>
2025-02-12 15:17:21 -05:00
Ryan Curtin 6daac5027d Add documentation for Octree (#3880) 2025-01-28 05:47:21 +01:00
Ryan Curtin 5fd51720e7 Add support for weights to data::Split() and allow cube types. (#3869) 2025-01-10 10:56:33 -06:00
Ryan Curtin aca8af3ebc Document CoverTree (#3861)
* Document the cover tree.

* Fix links.

* Fix compilation issues in examples by allowing default construction of cover trees.
2025-01-03 16:34:45 -05:00
Ryan Curtin c8eb3dceac Overhaul documentation homepage (#3836)
* 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.
2024-12-20 13:36:12 -05:00
Ryan Curtin 3c4ead453b Merge remote-tracking branch 'origin/master' into doc-rp-trees 2024-11-04 09:13:38 -05:00
Omar Shrit 67ef37e3c6 Merge pull request #3815 from rcurtin/doc-ub-tree
Document `UBTree`
2024-10-31 17:09:02 +01:00
Ryan Curtin 7f952a8cb4 Fix link to a locally-hosted version. 2024-10-30 11:30:25 -04:00
Ryan Curtin 66bb13648d Merge remote-tracking branch 'origin/master' into doc-rp-trees 2024-10-25 10:20:38 -04:00
Ryan Curtin e1082148d6 Use using instead of typedef. 2024-10-25 08:57:56 -04:00
Ryan Curtin 017c39f1b2 Use using instead of typedef for clarity. 2024-10-25 08:57:24 -04:00
Martin Lambertsen 855a22f267 Modernize typedefs in docs 2024-10-25 11:20:47 +02:00
Ryan Curtin 92d21c85b5 Fix minor merge issues that remained. 2024-10-23 17:52:25 -04:00
Ryan Curtin f09846cc2b Merge remote-tracking branch 'origin/master' into doc-ub-tree 2024-10-23 17:37:52 -04:00
Ryan Curtin 48333f9110 Fix link to HMM regression PDF. 2024-10-22 11:59:43 -04:00
Ryan Curtin 8f5bf8da77 Just use the direct ACM paper link instead of archive.org. 2024-10-22 09:18:01 -04:00
Ryan Curtin c826d21aea Fix link to HMM regression PDF. 2024-10-21 21:31:26 -04:00
Ryan Curtin 6184424690 Fix link. 2024-10-21 21:29:34 -04:00
Ryan Curtin cac046a9c1 Add links to UBTree documentation. 2024-10-21 21:26:18 -04:00
Ryan Curtin 28734e4cf3 Fix incorrect tense. 2024-10-21 21:23:57 -04:00
Ryan Curtin c605720837 Document UB-tree. 2024-10-21 21:23:44 -04:00
Ryan Curtin 8853d2b860 Update list of trees. 2024-10-16 15:18:18 -04:00
Ryan Curtin 58a5cc0f5e Templatize RandVector() for use by RPTreeMaxSplit and RPTreeMeanSplit. 2024-10-16 15:17:21 -04:00
Ryan Curtin 4e98582dcf Fix wording for other trees. 2024-10-16 15:16:58 -04:00
Ryan Curtin c1c61579c8 Add documentation for RPTree and MaxRPTree. 2024-10-16 15:16:44 -04:00
Ryan Curtin 05281d6e17 Fix paper link. 2024-10-16 13:26:48 -04:00
Ryan Curtin 395c63383c Fix some minor links. 2024-10-16 12:33:00 -04:00
Ryan Curtin ef8d0df872 Merge remote-tracking branch 'origin/master' into doc-vptree 2024-10-16 12:26:53 -04:00
Ryan Curtin 96bf8e34f5 Merge pull request #3806 from rcurtin/doc-mean-split-ball-tree
Document `MeanSplitBallTree`
2024-10-10 09:52:36 -04:00
Ryan Curtin 6753194fee Merge pull request #3803 from rcurtin/doc-split
Add documentation for `Split()` and `StratifiedSplit()`
2024-10-10 09:51:17 -04:00
Ryan Curtin aa5ce1b888 Add default template parameters for each type of tree. 2024-10-04 15:20:21 -04:00
Ryan Curtin 7644d879fd Merge remote-tracking branch 'origin/master' into doc-mean-split-ball-tree 2024-10-04 15:18:01 -04:00
Ryan Curtin 5665e3f394 Minor fixes to HollowBallBound documentation. 2024-10-02 17:33:47 -04:00
Ryan Curtin b64d741147 Add documentation for VPTree. 2024-10-02 17:29:21 -04:00
Ryan Curtin 7a9ddb8370 Fix typo. 2024-10-02 15:28:04 -04:00
Ryan Curtin b9198aa182 Add separators and clarity about default parameters. 2024-10-02 14:37:05 -04:00
Ryan Curtin eca16f9adf Add an image representing the ball bound. 2024-10-02 14:30:46 -04:00
Ryan Curtin d8b7c6654f Add documentation for VantagePointSplit. 2024-10-02 12:49:16 -04:00
Ryan Curtin 4ccc2cf6bf First steps towards documenting VPTree. 2024-10-02 10:32:55 -04:00
Ryan Curtin 4d36b36f47 Clean up introductory text. 2024-09-30 17:30:39 -04:00
Ryan Curtin ebbee415e2 Merge remote-tracking branch 'origin/master' into doc-split 2024-09-30 16:11:38 -04:00
Ryan Curtin 299a80a307 Merge remote-tracking branch 'rcurtin/doc-ball-tree' into doc-mean-split-ball-tree 2024-09-30 14:50:07 -04:00
Ryan Curtin 1bbe494936 Merge remote-tracking branch 'origin/master' into doc-mean-split-ball-tree 2024-09-30 14:49:36 -04:00
Ryan Curtin 4e654ea321 Document MeanSplitBallTree. 2024-09-30 14:48:28 -04:00