-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature/take optional kernel_mean_row_sum in refine() #266
Conversation
@tp832944 thanks in advance for your review. This unit tests are currently failing, and I believe this is down to circular imports. Unfortunately, I haven't been able to resolve this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of documentation changes please. Then, copy refine.py into a new pull request.
coreax/refine.py
Outdated
:param kernel_mean_row_sum: (Optional) Mean vector over rows for the Gram matrix, | ||
a :math:`1 \times n` array. If this variable has been pre-calculated, pass | ||
it to refine() to reduce computational load. If this variable is passed, | ||
```self.approximate_kernel_row_sum` is ignored. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only one opening quote.
Copy this edit into each of the three concrete classes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I got this one wrong. It should be
:attr:`approximate_kernel_row_sum`
No self
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry @bk958178, I got my ReST syntax wrong. So many ways of writing it look nice but just don't work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @bk958178. Another step done in OOPing.
Refs #264
PR Type
Description
Refine.refine()
currently calculateskernel_mean_row_sum
with no option to use an already-calculated value. This PR adds this as an optional argument torefine()
, taking a default value ofNone
to indicate that it still needs to be calculated.How Has This Been Tested?
No formal testing. Current refine.py unit tests need to be extended to reflect the changes.
Does this PR introduce a breaking change?
No.
Screenshots
(Write your answer here.)
Checklist before requesting a review