Skip to content
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

[DOC] Fix misleading fit_transform docstrings #12827

Merged
merged 4 commits into from
Sep 6, 2024

Conversation

tsbinns
Copy link
Contributor

@tsbinns tsbinns commented Sep 5, 2024

Reference issue

Example: Addresses #12766.

What does this implement/fix?

Adds custom docstrings for the fit_transform method of the CSP, SPoC, and SSD classes of the decoding module. The docstrings now accurately reflect the parameters of the fit and transform methods for each class (previously used the generic docstring of TransformerMixin).

@tsbinns
Copy link
Contributor Author

tsbinns commented Sep 5, 2024

Some tests failing for unrelated parts of the decoding module with the sklearn dev branch on Windows. Will take a look.

@tsbinns
Copy link
Contributor Author

tsbinns commented Sep 5, 2024

A couple more sklearn compliance checks are being run in the dev version than the stable v1.5, including the following which are causing problems (there might be others, these are just the first ones to fail):

  • mne.decoding.LinearModel - check_dtype_object
  • mne.decoding.TimeDelayingRidge - check_complex_data
  • mne.decoding.ReceptiveField - check_complex_data

Is it sufficient that the failing ones are added to the list of ignored checks?

Also, when I checked the logs to see why this wasn't failing for the dev branch on Ubuntu, I see that the same tests are failing, but the operation gets cancelled before the tests can finish running and it reports a pass overall. Is this intended behaviour?

@larsoner
Copy link
Member

larsoner commented Sep 6, 2024

Working around the problem in #12832, once that's in I'll merge main into this branch. Marking for merge-when-green, thanks @tsbinns !

@drammock drammock enabled auto-merge (squash) September 6, 2024 17:37
@drammock drammock merged commit f3a3ca4 into mne-tools:main Sep 6, 2024
28 checks passed
@tsbinns tsbinns deleted the decomp_docstrings branch September 9, 2024 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants