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

[MAINT] make proximal_operator a private module #4153

Merged
merged 3 commits into from Dec 13, 2023

Conversation

Remi-Gau
Copy link
Collaborator

Changes proposed in this pull request:

  • rename decoding/proximal_operator to decoding/_proximal_operator
  • adapt relevant imports

Copy link
Contributor

👋 @Remi-Gau Thanks for creating a PR!

Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft.

Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.

  • PR has an interpretable title.
  • PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
  • Code is PEP8-compliant (see our documentation on coding style)
  • Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

  • There is at least one unit test per new function / class (see our documentation on testing)
  • The new feature is demoed in at least one relevant example.

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

@Remi-Gau Remi-Gau changed the title [MAINT] make proximal operator a private module [MAINT] make proximal_operator a private module Dec 12, 2023
Copy link

codecov bot commented Dec 12, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (af37456) 91.71% compared to head (f890743) 91.92%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4153      +/-   ##
==========================================
+ Coverage   91.71%   91.92%   +0.20%     
==========================================
  Files         145      145              
  Lines       16337    16337              
  Branches     3407     3407              
==========================================
+ Hits        14983    15017      +34     
+ Misses        810      777      -33     
+ Partials      544      543       -1     
Flag Coverage Δ
macos-latest_3.10_test_plotting 91.69% <100.00%> (ø)
macos-latest_3.11_test_plotting 91.69% <100.00%> (ø)
macos-latest_3.12_test_plotting 91.69% <100.00%> (ø)
macos-latest_3.8_test_plotting 91.66% <100.00%> (ø)
macos-latest_3.9_test_plotting 91.66% <100.00%> (ø)
ubuntu-latest_3.10_test_plotting 91.69% <100.00%> (ø)
ubuntu-latest_3.11_test_plotting 91.69% <100.00%> (ø)
ubuntu-latest_3.12_test_plotting 91.69% <100.00%> (ø)
ubuntu-latest_3.12_test_pre 91.69% <100.00%> (ø)
ubuntu-latest_3.8_test_min 68.86% <100.00%> (?)
ubuntu-latest_3.8_test_plot_min 91.42% <100.00%> (?)
ubuntu-latest_3.8_test_plotting 91.66% <100.00%> (ø)
ubuntu-latest_3.9_test_plotting 91.66% <100.00%> (ø)
windows-latest_3.10_test_plotting 91.67% <100.00%> (ø)
windows-latest_3.11_test_plotting 91.67% <100.00%> (ø)
windows-latest_3.12_test_plotting 91.67% <100.00%> (ø)
windows-latest_3.8_test_plotting 91.63% <100.00%> (ø)
windows-latest_3.9_test_plotting 91.64% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@bthirion bthirion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR mixes heterogeneous stuff, but does what it should.

@@ -29,8 +29,8 @@ Enhancements
- :bdg-dark:`Code` :meth:`~maskers.NiftiLabelsMasker.generate_report` now uses appropriate cut coordinates when functional image is provided (:gh:`4099` by `Yasmin Mzayek`_ and `Nicolas Gensollen`_).
- :bdg-info:`Plotting` When plotting thresholded statistical maps with a colorbar, the threshold value(s) will now be displayed as tick labels on the colorbar (:gh:`#2833` by `Nicolas Gensollen`_).
- :bdg-success:`API` :class:`~maskers.NiftiSpheresMasker` now has ``generate_report`` method (:gh:`3102` by `Yasmin Mzayek`_ and `Nicolas Gensollen`_).
- :bdg-primary:`Doc` Mention the classification type (all-vs-one) in :ref:`sphx_glr_auto_examples_02_decoding_plot_haxby_glm_decoding.py` (:gh:`4122` by `Tamer Gezici`_).
- :bdg-primary:`Doc` Specify full form of LSS in :ref:`sphx_glr_auto_examples_07_advanced_plot_beta_series.py` (:gh:`4141` by `Tamer Gezici`_).
- :bdg-primary:`Doc` Mention the classification type (all-vs-one) in :ref:`sphx_glr_auto_examples_02_decoding_plot_haxby_glm_decoding.py` (:gh:`4122` by `Tamer Gezici`_).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This stuff is unrelated

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah: side effect of using pre-commit locally, in this case it cleaned up trailing white spaces when acting on this staged file

Copy link
Member

@ymzayek ymzayek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Remi-Gau Remi-Gau merged commit 98ad019 into nilearn:main Dec 13, 2023
32 checks passed
@Remi-Gau Remi-Gau deleted the proximal branch December 13, 2023 11:29
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.

Rename file to _proximal_operators.py
3 participants