Commit Graph
365 Commits
Author SHA1 Message Date
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
821a95ff56 Stb (#3823)
* Move STB internally, comment functions if not

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Comment for now STB including macros

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Modify CMake and tests accordingly

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the license and update the date.

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Move STB to its own directory

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Adding the functrions of image resize and crop

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Update the API not finished yet

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Start adding tests

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Add flowers images for test

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Bring image from the coco dataset

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Include all of STB header in this file

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix STB configs

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Clean CMakeLists and look for stb_resize

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Make it compile with STB integrated

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix stb path

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the endif at the end of the file

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Update LICENSE.txt

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update CMakeLists.txt

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/config.hpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Adding the function and test, not finished

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Remove crop from this PR, and add tests

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Update LICENSE.txt

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

* Update CMakeLists.txt

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

* merge master

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Add @rcutin suggestion for stb

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Improve the logic to include edge cases

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the bundle that if we are using system stb

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Make it possible to disable the entire build with STB

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the else if condition

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the else condition

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the tests accordindly

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Add dummpy functions and complete the Resize function

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Reorder to see if this fix the problem

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the resize for a set of images

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Add STATIC for resize and write

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix all the problem with this function

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Be able to resize N images easily

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Add the tests, already passing

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Use sheep instead of Umbrella

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Fix STB directory

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Fix Cmake and docs

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Apply comments from @rcurtin

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Integrate @rcurtin comments

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Fix tests and remove generated images

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Add docs

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Update the API with new resize version

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Fix to resize2

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Adding resize2

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Add the necessary fix to avoid linker errors

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Add configs to allow correct repacking

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Redo the ResizeImages function

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Pack the images as tzr.bz2

Signed-off-by: Omar Shrit <omar@shrit.fr>

* Fix the function calls and create an internal one

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Make the message shorter to have under 80 chars

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Solve linter errors

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Solve linter error

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix linter issues

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Update doc/user/load_save.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/tests/image_test.cpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/core/data/image_resize_crop.hpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/core/data/image_resize_crop.hpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update doc/user/load_save.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update doc/user/load_save.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/tests/image_test.cpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/tests/image_test.cpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/tests/image_test.cpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/tests/image_test.cpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/core/data/image_resize_crop.hpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Apply @rcurtin comments

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Add an example usage of these two functions

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Apply @rcurtin comments

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Re-organize directories for STB

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Apply rcurtin comments

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Merge two resize functions into one

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Get rid of MLPACK_DISABLE_STB

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix forgetting docs

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Update CMake/FindStbImage.cmake

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update CMake/FindStbImage.cmake

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update doc/user/install.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update doc/user/compile.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/core/data/image_resize_crop.hpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update doc/user/load_save.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update doc/user/load_save.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update doc/user/load_save.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update doc/user/load_save.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/core/data/image_resize_crop.hpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/core/data/image_resize_crop.hpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update src/mlpack/core/data/image_resize_crop.hpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update doc/user/load_save.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Apply comments from @rcurtin

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Adding the test to test if it is identical

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix image tests

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the example

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Add the link and the patch to download the images

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the script and make all of them green

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Remove wget not needed

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Minor style fixes.

* Avoid temporary matrices, and test with multiple different types.

* Update src/mlpack/config.hpp

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Update HISTORY.md

Co-authored-by: Ryan Curtin <ryan@ratml.org>

* Fix R build by including bundled STB headers in package.

---------

Signed-off-by: Omar Shrit <omar@avontech.fr>
Signed-off-by: Omar Shrit <omar@shrit.fr>
Co-authored-by: Ryan Curtin <ryan@ratml.org>
Co-authored-by: Dirk Eddelbuettel <edd@debian.org>
2025-02-05 21:06:26 +01:00
Ryan CurtinandDirk Eddelbuettel 9fd815144d Add a cache to documentation check job (#3882)
* A first attempt at overhauling the documentation job with a cache.

* Actually remove files we don't need anymore.

* Fix output from local link checks to give it all at once.

* Add sparse matrices to the set of detected matrix types.

* Fix comparison condition.

* Make a pass to try and re-validate cached links that have not yet expired.

* Compile and link separately so that ccache can take effect.

* Be a little bit smarter about caching.

* Ensure libicu$SO is installed so 'stringi' can be used

Also collapse to remotes calls into one

* Fix style issues that cpplint 2 found (#3884)

* Try to workaround the libicu issue for now.

* Mention new dependency.

---------

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>
2025-02-04 08:04:42 -05:00
Ryan Curtin 6daac5027d Add documentation for Octree (#3880) 2025-01-28 05:47:21 +01:00
Omar Shrit 04aafc3c47 Use Debug and Release variables from CMake (#3865)
* Use Debug and Release variables from CMake

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Bring back the debug option

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Remove automatically set options

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Document the new option and remove the deprecated ones

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix missing endif ()

Signed-off-by: Omar Shrit <omar@avontech.fr>

* Fix the history, typo and docs

Signed-off-by: Omar Shrit <omar@avontech.fr>

---------

Signed-off-by: Omar Shrit <omar@avontech.fr>
2025-01-16 22:26:03 +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
Omar Shrit 916229f6c9 Move it to functionality section
Signed-off-by: Omar Shrit <omar@avontech.fr>
2025-01-08 16:16:18 +01:00
Omar ShritandRyan Curtin 2ca9811439 Update doc/user/compile.md
Co-authored-by: Ryan Curtin <ryan@ratml.org>
2025-01-08 16:13:37 +01:00
Omar Shrit eecc9c9e34 Document the new added option
Signed-off-by: Omar Shrit <omar@avontech.fr>
2025-01-08 15:13:17 +01: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 43e6363b85 Attempt to work around OpenBLAS thread thrashing issue (#3860)
* Update documentation and CI configurations to work around OpenBLAS OpenMP thrashing issue.

* Update out-of-date link.

* Clarify the situation on Ubuntu and Debian.

* Clarify about pthread compilation.

* Add a bit about the OpenMP variant.

* Make the verbiage consistent everywhere.

* Try to see if the fix works on macOS too.

* Homebrew packages OpenBLAS 0.3.28, so no workaround is needed.
2024-12-29 10:29:29 -06: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 4498706851 Update and release version 4.5.1. 2024-12-04 14:03:31 -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 ca27fa52f7 Merge pull request #3808 from rcurtin/doc-vptree
Document `VPTree`
2024-10-22 17:37:41 -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
Martin Lambertsen f05ae22d60 Merge remote-tracking branch 'origin/master' into feature/modernize-type-traits 2024-10-17 06:56:56 +02: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
Martin Lambertsen 471a3daa27 Modernize STL type traits
With newer standards the readability of template heavy code can
be improved a lot by using a form with trailing _t for ::type and
_v for ::value respectively. Especially for ::type it also makes
the additional typename before the trait dispensable.

This PR combines multiple commits that modernize the traits,
starting with what clang-tidy could achieve while analyzing test files
and continuing by regex replaces with few manual corrections.

While it does not guarantee that all current occurrences are modernized,
it moves the codebase considerably into the modern direction. Note that
also before this PR both notations were used, so missing a few should
be acceptable.
2024-10-14 08:28:05 +02: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