Document Radical
#3787
Merged
Document Radical
#3787
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shrit
reviewed
Sep 8, 2024
Comment on lines
+74
to
+77
| template<typename MatType = arma::mat> | ||
| [[deprecated("Will be removed in mlpack 5.0.0. Use Apply() instead.")]] | ||
| void DoRadical(const MatType& matX, | ||
| MatType& matY, |
Comment on lines
116
to
122
| template<typename MatType> | ||
| typename MatType::elem_type DoRadical2D( | ||
| const MatType& matX, | ||
| const size_t m, | ||
| MatType& perturbed, // auxiliary memory | ||
| MatType& candidate, // auxiliary memory | ||
| util::Timers& timers = IO::GetTimers()); |
There was a problem hiding this comment.
Can we deprecate this one in favour of Apply2D? So we have an API compatibility, especially when we are in mlpack 5 no one will understand why we have Apply and DoRadical2D
There was a problem hiding this comment.
You're right, that is a more consistent name. I don't consider DoRadical2D() a "public API" function, so it's ok to change. (For this reason I didn't document it.) So I just changed DoRadical2D() to Apply2D() in 6a2e9cb. 👍
shrit
approved these changes
Sep 10, 2024
|
The Windows build looks to be a spurious failure unrelated to RADICAL, so I will go ahead and merge. 🚀 |
This was referenced Sep 16, 2024
Closed
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I documented the RADICAL algorithm for ICA. This one actually turned out to be very easy to do. Changes:
Radical::DoRadical()in favor of the newRadical::Apply(), which matches classes likePCAand other transformations better.Radical::Apply()so users can use dense floating-point matrix types.Radical::Apply()function directly.mparameter (likeradical_main.cppdoes).SEE_ALSO()links for all the bindings I could find to point to Markdown files instead of C++ source.