Make the McrAR API more sklearn-like #32
Open
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.
This makes the API more similar to sklearn's as discussed in hyperspy/hyperspy#2172 (comment).
The most drastic change to the API is moving most of the arguments of
fit()
to__init__()
. Alternatively, it would be possible to set those arguments both in__init__()
andfit()
, with the ones infit
overwriting the attributes given in__init__
. That would preserve the API, but I think that it risks confusing the users.It may be better to implement a
fit_transform
method instead of adding thetransform()
method as I have done, since in MCR there is no need for a finaltransform
step.Finally in this PR there are a couple of changes that have nothing to do with sklearn, but makes integration with hyperspy a lot easier. In particular, the automatic unfolding of the
C
andST
matrices and the internal call tonp.asanyarray
.I haven't adapted the tests, so they'll fail. I'll do it if I get positive feedback.