Commit Graph
48 Commits
Author SHA1 Message Date
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 ade86a033f Merge branch 'core-into-multiple-pages' into kdtree-doc 2024-09-07 16:01:52 -04:00
Ryan Curtin 72309471d2 First attempt at splitting core.md into multiple pages. 2024-09-06 09:48:17 -04:00
Ryan Curtin d2a470b71d First pass at documenting kd-trees. 2024-09-05 11:32:02 -04:00
Ryan Curtin bc9079538e Fix missing descriptions. 2024-09-04 11:31:54 -04:00
Ryan Curtin 141bdc3418 Add documentation prototype for HRectBound; still in progress. 2024-08-29 16:10:21 -04:00
Ryan Curtin a6a6a29ef2 Merge remote-tracking branch 'origin/master' into distribution-doc 2024-08-23 10:58:36 -04:00
Ryan Curtin 4486c1246c Templatize the rest of the distributions and add relevant documentation. 2024-08-23 10:51:14 -04:00
Ryan Curtin 62b739b3af Document the remaining distributions (not fully tested yet). 2024-08-22 15:57:16 -04:00
Dejan Bogosavljev 8b152699c9 Fix SVM wikipedia hyperlink 2024-08-14 23:58:30 +02:00
Ryan Curtin fb9da0b892 Merge remote-tracking branch 'origin/master' into mean-shift-doc 2024-07-21 18:18:01 -04:00
Ryan Curtin 0c9702cb64 Finish MeanShift documentation and debug tests. 2024-07-17 22:06:06 -04:00
Ryan Curtin 8781589ac6 Fix links. 2024-07-08 15:40:13 -04:00
Ryan Curtin ab0ff99e27 Update links and rebuild Markdown documentation. 2024-07-06 14:36:41 -04:00
Ryan Curtin e9ace524bd Clarify example (and fix it). 2024-07-04 13:58:19 -04:00
Ryan Curtin 612273e861 Add an example of turning MahalanobisDistance::Q() back into a transformation matrix. 2024-07-04 13:33:11 -04:00
Ryan Curtin 141790ce20 More links to fix... 2024-06-16 11:52:27 -04:00
Ryan Curtin 8133c058a0 Fix minor documentation rendering issues. 2024-06-14 15:37:27 -04:00
Ryan Curtin cccf60d974 Move metrics to distances/ and dists to distributions/. And adapt... everything. 2024-06-14 15:14:48 -04:00
Ryan Curtin bdebab79ac Merge remote-tracking branch 'origin/master' into website-revamp 2024-05-24 20:48:59 -04:00
Ryan Curtin 3491695040 Add equation for spherical kernel. 2024-05-24 09:59:04 -04:00
Ryan Curtin 22ff9cb245 Merge branch 'master' into website-revamp 2024-05-24 07:22:00 -06:00
Ryan Curtin 921e09b6c5 Fix incorrect MakeAlias() links. 2024-05-21 19:28:12 -04:00
Ryan Curtin 66d47c55f7 Document all of kernels/ directory. 2024-05-21 10:07:00 -04:00
Omar ShritandRyan Curtin 58970a51f1 Update doc/user/core.md
Co-authored-by: Ryan Curtin <ryan@ratml.org>
2024-05-15 11:54:32 +02:00
Omar Shrit eef5b684a8 Fix the comments as requested
Signed-off-by: Omar Shrit <omar@avontech.fr>
2024-05-14 20:36:46 +02:00
Omar Shrit 0f2bc5cb0a Update Core with new MakeAlias signature
Signed-off-by: Omar Shrit <omar@avontech.fr>
2024-05-14 12:25:34 +02:00
Ryan Curtin f0f24cf881 Some minor additional cleanups. 2024-05-02 11:18:35 -04:00
Ryan Curtin e9be8af2cc Clean up MakeAlias() and put it in only one place. 2024-04-02 14:51:50 -04:00
Ryan Curtin 24e6c9383a Merge pull request #3652 from rcurtin/doc-sidebar
Add automatically-generated sidebar for documentation
2024-03-22 11:46:40 -04:00
Omar ShritandRyan Curtin 5c291b2d0d Update doc/user/core.md
Co-authored-by: Ryan Curtin <ryan@ratml.org>
2024-03-07 17:45:35 +01:00
Omar Shrit 0d206ae0a5 Fix the docs
Signed-off-by: Omar Shrit <omar@avontech.fr>
2024-03-07 14:03:06 +01:00
Ryan Curtin 2d1269edf7 Fix documentation that had snippets that would not build. 2024-02-28 16:54:46 -05:00
Ryan Curtin 72cf442586 Fix all broken links and handle a few other TODOs. 2024-02-26 20:13:04 -05:00
Ryan Curtin 08b3cd1e34 Minor wording changes and other fixes. 2024-01-31 10:21:51 -05:00
Ryan Curtin b5b8a13635 Handle some TODOs. 2024-01-31 10:13:21 -05:00
Ryan Curtin cee933d34d Fix minor compilation issues in examples. 2024-01-31 10:04:10 -05:00
Ryan Curtin 21b444034c Document last few remaining functions in core/math/. 2024-01-28 22:02:58 -05:00
Ryan Curtin 45f3bf87a5 Document RandomBasis() and add examples for random number utilities. 2024-01-23 15:40:07 -05:00
Ryan Curtin 81c59a1a94 Document random number utilities. 2024-01-23 15:16:48 -05:00
Ryan Curtin 50c475c1b6 Document logarithmic utilities. 2024-01-23 15:02:55 -05:00
Ryan Curtin 70cc7ae5dd Basic documentation outline for digamma/trigamma; still needs some work. 2024-01-23 13:58:37 -05:00
Ryan Curtin 163f2245bb Document ColumnsToBlocks. 2024-01-23 13:47:01 -05:00
Ryan Curtin 13b4d5321b Document ColumnCovariance(). 2024-01-23 12:18:28 -05:00
Ryan Curtin 0820672403 Don't use math:: namespace for Range; it doesn't exist anymore. 2024-01-23 12:18:09 -05:00
Ryan Curtin 6edd1104b5 Minor changes and fixes. 2024-01-13 12:39:36 -05:00
Ryan Curtin c8cf815f8b Document Gradient(). 2024-01-11 12:48:02 -05:00
Ryan Curtin bf5f0eaa96 Add first attempt at core documentation. 2024-01-11 11:28:30 -05:00