Update documentation for vector k in procrustes_scale function - #65
Merged
Conversation
Clarified comments in procrustes_scale function regarding scaling factors and element-wise multiplication.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Docs: Clarify that procrustes_scale returns vector k, not scalar
The documentation for
procrustes_scale()insrc/embkit/align.pysuggests thatkis a scalar value (the more common procrustes approach), when it actually returns a vector of per-dimension scaling factors.Changes
Updated docstring (lines 89, 92, 101) to clarify:
Implementation is unchanged. Only the documentation was misleading. I believe ths covers all mentions of scalar k.