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] Finish adding badges to changelog #3968

Merged
merged 4 commits into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/changes/0.1.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
Changelog
---------

The ``0.1.2`` release is a bugfix release, specifically to fix the :class:`~maskers.NiftiMapsMasker`.
- :bdg-dark:`Code` The ``0.1.2`` release is a bugfix release, specifically to fix the :class:`~maskers.NiftiMapsMasker`.
12 changes: 6 additions & 6 deletions doc/changes/0.1.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,21 @@ It also includes a full rewamp of the documentation, and support for Python 3.
Fixes
-----

- Dealing with ``NaNs`` in function :func:`~plotting.plot_connectome`.
- :bdg-dark:`Code` Dealing with ``NaNs`` in function :func:`~plotting.plot_connectome`.

- :bdg-info:`Plotting` Fix extreme values in colorbar were sometimes brok.

- Fix confounds removal with single confounds.
- :bdg-dark:`Code` Fix confounds removal with single confounds.

- Fix frequency filtering.
- :bdg-dark:`Code` Fix frequency filtering.

- Keep header information in images.
- :bdg-dark:`Code` Keep header information in images.

- ``add_overlay`` finds ``vmin`` and ``vmax`` automatically.
- :bdg-dark:`Code` ``add_overlay`` finds ``vmin`` and ``vmax`` automatically.

- :bdg-success:`API` Function :func:`~plotting.plot_connectome` now supports ``vmin`` and ``vmax``.

- Detrending 3D images no longer puts them to zero.
- :bdg-dark:`Code` Detrending 3D images no longer puts them to zero.


Contributors (from ``git shortlog -ns 0.1.2..0.1.3``):
Expand Down
4 changes: 2 additions & 2 deletions doc/changes/0.1.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Highlights

- :bdg-secondary:`Maint` Obey Debian packaging rules.

- Add the Destrieux 2009 and Power 2011 atlas.
- :bdg-dark:`Code` Add the Destrieux 2009 and Power 2011 atlas.

- Better caching in maskers.
- :bdg-dark:`Code` Better caching in maskers.


Contributors (from ``git shortlog -ns 0.1.3..0.1.4``):
Expand Down
20 changes: 10 additions & 10 deletions doc/changes/0.2.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ New features

- :bdg-success:`API` The new module :mod:`nilearn.connectome` now has class :class:`nilearn.connectome.ConnectivityMeasure` can be useful for computing functional connectivity matrices.

- The function ``nilearn.connectome.sym_to_vec`` in same module :mod:`nilearn.connectome` is also implemented as a helper function to class :class:`nilearn.connectome.ConnectivityMeasure`.
- :bdg-dark:`Code` The function ``nilearn.connectome.sym_to_vec`` in same module :mod:`nilearn.connectome` is also implemented as a helper function to class :class:`nilearn.connectome.ConnectivityMeasure`.

- The class :class:`decomposition.DictLearning` in :mod:`nilearn.decomposition` is a decomposition method similar to :term:`ICA` that imposes sparsity on components instead of independence between them.
- :bdg-dark:`Code` The class :class:`decomposition.DictLearning` in :mod:`nilearn.decomposition` is a decomposition method similar to :term:`ICA` that imposes sparsity on components instead of independence between them.

- :bdg-secondary:`Maint` Integrating back references template from ``sphinx-gallery`` of ``0.0.11`` version release.

- :bdg-success:`API` Globbing expressions can now be used in all nilearn functions expecting a list of files.

- The new module :mod:`nilearn.regions` now has class :class:`regions.RegionExtractor` which can be used for post processing brain regions of interest extraction.
- :bdg-success:`API` The new module :mod:`nilearn.regions` now has class :class:`regions.RegionExtractor` which can be used for post processing brain regions of interest extraction.

- The function :func:`~regions.connected_regions` in :mod:`nilearn.regions` is also implemented as a helper function to :class:`regions.RegionExtractor`.
- :bdg-success:`API` The function :func:`~regions.connected_regions` in :mod:`nilearn.regions` is also implemented as a helper function to :class:`regions.RegionExtractor`.

- The function :func:`~image.threshold_img` in :mod:`nilearn.image` is implemented to use it for thresholding statistical maps.
- :bdg-success:`API` The function :func:`~image.threshold_img` in :mod:`nilearn.image` is implemented to use it for thresholding statistical maps.

Enhancements
------------
Expand All @@ -41,21 +41,21 @@ Enhancements

- :bdg-secondary:`Maint` Documentation enhancement by integrating ``sphinx-gallery`` notebook style examples.

- Documentation about class :class:`maskers.NiftiSpheresMasker`.
- :bdg-primary:`Doc` Documentation about class :class:`maskers.NiftiSpheresMasker`.

Bug fixes
---------

- Fixed bug to control the behaviour when ``cut_coords=0`` in function :func:`~plotting.plot_stat_map` in :mod:`nilearn.plotting` (See :gh:`784`).
- :bdg-dark:`Code` Fixed bug to control the behaviour when ``cut_coords=0`` in function :func:`~plotting.plot_stat_map` in :mod:`nilearn.plotting` (See :gh:`784`).

- Fixed bug in function :func:`~image.copy_img` occurred while caching the Nifti images (See :gh:`793`).
- :bdg-dark:`Code` Fixed bug in function :func:`~image.copy_img` occurred while caching the Nifti images (See :gh:`793`).

- Fixed bug causing an ``IndexError`` in ``fast_abs_percentile`` (See :gh:`875`).
- :bdg-dark:`Code` Fixed bug causing an ``IndexError`` in ``fast_abs_percentile`` (See :gh:`875`).

API changes summary
-------------------

- The utilities in function :func:`~connectome.group_sparse_covariance` have been moved into module :mod:`nilearn.connectome`.
- :bdg-secondary:`Maint` The utilities in function :func:`~connectome.group_sparse_covariance` have been moved into module :mod:`nilearn.connectome`.

- :bdg-success:`API` The default value for number of cuts (``n_cuts``) in function :func:`~plotting.find_cut_slices` in :mod:`nilearn.plotting` module has been changed from 12 to 7 i.e. ``n_cuts=7``.

Expand Down
2 changes: 1 addition & 1 deletion doc/changes/0.2.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
Changelog
---------

Small bugfix for more flexible input types (targetter in particular at making code easier in nistats).
- :bdg-dark:`Code` Small bugfix for more flexible input types (targetter in particular at making code easier in nistats).
18 changes: 9 additions & 9 deletions doc/changes/0.2.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,32 +30,32 @@ Enhancements
Fixes
-----

- Fix ``symmetric_split`` behavior in function :func:`~datasets.fetch_atlas_harvard_oxford`.
- :bdg-dark:`Code` Fix ``symmetric_split`` behavior in function :func:`~datasets.fetch_atlas_harvard_oxford`.

- Fix casting errors when providing integer data to function :func:`~image.high_variance_confounds`.
- :bdg-dark:`Code` Fix casting errors when providing integer data to function :func:`~image.high_variance_confounds`.

- :bdg-secondary:`Maint` Fix matplotlib ``1.5.0`` compatibility in function :func:`~plotting.plot_prob_atlas`.

- :bdg-secondary:`Maint` Fix matplotlib backend choice on Mac OS X.

- :bdg-info:`Plotting` Function :func:`~plotting.find_xyz_cut_coords` raises a meaningful error when 4D data is provided instead of 3D.

- Class :class:`~maskers.NiftiSpheresMasker` handles radius smaller than the size of a :term:`voxel`.
- :bdg-dark:`Code` Class :class:`~maskers.NiftiSpheresMasker` handles radius smaller than the size of a :term:`voxel`.

- Class :class:`~regions.RegionExtractor` handles data containing ``Nans``.
- :bdg-dark:`Code` Class :class:`~regions.RegionExtractor` handles data containing ``Nans``.

- Confound regression does not force systematically the normalization of the confounds.
- :bdg-dark:`Code` Confound regression does not force systematically the normalization of the confounds.

- Force time series normalization in :class:`~connectome.ConnectivityMeasure` and check dimensionality of the input.
- :bdg-dark:`Code` Force time series normalization in :class:`~connectome.ConnectivityMeasure` and check dimensionality of the input.

- Function ``nilearn._utils.numpy_conversions.csv_to_array`` could consider valid CSV files as invalid.
- :bdg-dark:`Code` Function ``nilearn._utils.numpy_conversions.csv_to_array`` could consider valid CSV files as invalid.

Changes
-------

- Deprecated dataset downloading function have been removed.
- :bdg-danger:`Deprecation` Deprecated dataset downloading function have been removed.

- Download progression message refreshing rate has been lowered to sparsify CircleCI logs.
- :bdg-dark:`Code` Download progression message refreshing rate has been lowered to sparsify CircleCI logs.

Contributors
------------
Expand Down
10 changes: 5 additions & 5 deletions doc/changes/0.2.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ The ``0.2.3`` is a small feature release for BrainHack 2016.
New features
------------

- Mathematical formulas based on ``numpy`` functions can be applied on an image or a list of images using function :func:`~image.math_img`.
- :bdg-dark:`Code` Mathematical formulas based on ``numpy`` functions can be applied on an image or a list of images using function :func:`~image.math_img`.

- Downloader for COBRE datasets of 146 rest :term:`fMRI` subjects with function ``nilearn.datasets.fetch_cobre``.
- :bdg-dark:`Code` Downloader for COBRE datasets of 146 rest :term:`fMRI` subjects with function ``nilearn.datasets.fetch_cobre``.

- Downloader for Dosenbach atlas :func:`~datasets.fetch_coords_dosenbach_2010`.
- :bdg-dark:`Code` Downloader for Dosenbach atlas :func:`~datasets.fetch_coords_dosenbach_2010`.

- Fetcher for multiscale functional brain parcellations (BASC) :func:`~datasets.fetch_atlas_basc_multiscale_2015`.
- :bdg-dark:`Code` Fetcher for multiscale functional brain parcellations (BASC) :func:`~datasets.fetch_atlas_basc_multiscale_2015`.

Bug fixes
---------

- Better dimming on white background for plotting.
- :bdg-info:`Plotting` Better dimming on white background for plotting.
8 changes: 4 additions & 4 deletions doc/changes/0.2.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ The ``0.2.4`` is a small release focused on documentation for teaching.
New
---

- The path given to the ``memory`` argument of object now have their "~" expanded to the homedir.
- :bdg-success:`API` The path given to the ``memory`` argument of object now have their "~" expanded to the homedir.

- :bdg-success:`API` Display object created by plotting now uniformly expose an ``add_markers`` method.

- Function :func:`~plotting.plot_connectome` now plots connectome with colorbars.
- :bdg-info:`Plotting` Function :func:`~plotting.plot_connectome` now plots connectome with colorbars.

- :bdg-success:`API` New function :func:`~image.resample_to_img` to resample one image on another one (just resampling / interpolation, no coregistration).

Changes
-------

- Atlas fetcher :func:`~datasets.fetch_atlas_msdl` now returns directly labels of the regions in output variable ``labels`` and its coordinates in output variable ``region_coords`` and its type of network in ``networks``.
- :bdg-success:`API` Atlas fetcher :func:`~datasets.fetch_atlas_msdl` now returns directly labels of the regions in output variable ``labels`` and its coordinates in output variable ``region_coords`` and its type of network in ``networks``.

- :bdg-success:`API` The output variable name ``regions`` is now changed to ``maps`` in AAL atlas fetcher :func:`~datasets.fetch_atlas_aal`.

- AAL atlas now returns directly its labels in variable ``labels`` and its index values in variable ``indices``.
- :bdg-success:`API` AAL atlas now returns directly its labels in variable ``labels`` and its index values in variable ``indices``.
12 changes: 6 additions & 6 deletions doc/changes/0.2.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ The new minimum required version of ``scikit-learn`` is ``0.14.1``.
Changes
-------

- Default option for ``dim`` argument in plotting functions which uses :term:`MNI` template as a background image is now changed to 'auto' mode. Meaning that an automatic contrast setting on background image is applied by default.
- :bdg-dark:`Code` Default option for ``dim`` argument in plotting functions which uses :term:`MNI` template as a background image is now changed to 'auto' mode. Meaning that an automatic contrast setting on background image is applied by default.

- ``Scikit-learn`` validation tools have been imported and are now used to check consistency of input data, in SpaceNet for example.
- :bdg-dark:`Code` ``Scikit-learn`` validation tools have been imported and are now used to check consistency of input data, in SpaceNet for example.

New
---

- :bdg-success:`API` Add an option to select only off-diagonal elements in function ``sym_to_vec``. Also, the scaling of matrices is modified: we divide the diagonal by ``sqrt(2)`` instead of multiplying the off-diagonal elements.

- Connectivity examples rely on :class:`~connectome.ConnectivityMeasure`.
- :bdg-primary:`Doc` Connectivity examples rely on :class:`~connectome.ConnectivityMeasure`.

Fixes
-----

- ``Scipy 0.18`` introduces a bug in a corner-case of resampling. Nilearn ``0.2.5`` can give wrong results with ``scipy 0.18``, but this is fixed in ``0.2.6``.
- :bdg-dark:`Code` ``Scipy 0.18`` introduces a bug in a corner-case of resampling. Nilearn ``0.2.5`` can give wrong results with ``scipy 0.18``, but this is fixed in ``0.2.6``.

- :bdg-secondary:`Maint` Broken links and references fixed in docs.

Expand All @@ -45,7 +45,7 @@ improved documentation.
New
---

- N:bdg-success:`API` ew display_mode options in functions :func:`~plotting.plot_glass_brain` and :func:`~plotting.plot_connectome`. It is possible to plot right and left hemisphere projections separately.
- :bdg-success:`API` New display_mode options in functions :func:`~plotting.plot_glass_brain` and :func:`~plotting.plot_connectome`. It is possible to plot right and left hemisphere projections separately.

- :bdg-success:`API` New function :func:`~datasets.load_mni152_brain_mask` to load canonical brain mask image in :term:`MNI` template space.

Expand All @@ -57,7 +57,7 @@ New

- :bdg-success:`API` New simple data downloader :func:`~datasets.fetch_localizer_button_task` to simplify some examples.

- Function :func:`~datasets.fetch_localizer_contrasts` can now download a specific list of subjects rather than a range of subjects.
- :bdg-dark:`Code` Function :func:`~datasets.fetch_localizer_contrasts` can now download a specific list of subjects rather than a range of subjects.

- :bdg-success:`API` New function :func:`~datasets.get_data_dirs` to check where nilearn downloads data.

Expand Down
8 changes: 4 additions & 4 deletions doc/changes/0.2.6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Several bugs related to masks in Searchlight and ABIDE fetching have been resolv
Fixes
-----

- Change default ``dtype`` in function :func:`~image.concat_imgs` to be the original type of the data (see :gh:`1238`).
- :bdg-dark:`Code` Change default ``dtype`` in function :func:`~image.concat_imgs` to be the original type of the data (see :gh:`1238`).

- Fix ``SearchLight`` that did not run without ``process_mask`` or with one :term:`voxel` mask.
- :bdg-dark:`Code` Fix ``SearchLight`` that did not run without ``process_mask`` or with one :term:`voxel` mask.

- Fix flipping of left hemisphere when plotting glass brain.
- :bdg-info:`Plotting` Fix flipping of left hemisphere when plotting glass brain.

- Fix bug when downloading ABIDE timeseries.
- :bdg-dark:`Code` Fix bug when downloading ABIDE timeseries.

Enhancements
------------
Expand Down