Fix issue #594 related to the fontsize parameter in `plot` #596

Tmodrzyk · 2025-07-09T09:34:59Z

The fontsize parameter in plot has no effect (Issue #594). The fix was very simple, the size parameter in some matplotlib function calls was overwriting the config_matplotlib call.

python3 -m pytest deepinv/tests runs successfully.
black . runs successfully.
make html runs successfully (in the docs/ directory).
Updated docstrings related to the changes (as applicable).
Added an entry to the CHANGELOG.rst.

codecov · 2025-07-09T10:09:47Z

Codecov Report

Attention: Patch coverage is 73.33333% with 4 lines in your changes missing coverage. Please review.

Project coverage is 81.19%. Comparing base (464ec13) to head (c9c4ec4).

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
deepinv/utils/plotting.py	73.33%	4 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #596   +/-   ##
=======================================
  Coverage   81.18%   81.19%           
=======================================
  Files         195      195           
  Lines       17795    17805   +10     
  Branches     2377     2378    +1     
=======================================
+ Hits        14447    14456    +9     
- Misses       2546     2547    +1     
  Partials      802      802

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

samuro95

Thanks for the correction! Now the config_matplotlib sets the font.size to 17, when it was set to 9 or 12 before. Have you checked that it still looks good ? thanks

Moreover, I am wondering if there is a possibility to call config_matplotlib() in the setup.py file so that all the documentation is run with these options, rather than having it in every example file

Tmodrzyk · 2025-07-09T13:08:38Z

Hi Sam, thanks for your feedback, I did not think about the documentation, I'll check it.
As for the setup.py file you mention I can't seem to find it, where is it located in the library ?

samuro95 · 2025-07-09T13:46:40Z

Hi Sam, thanks for your feedback, I did not think about the documentation, I'll check it. As for the setup.py file you mention I can't seem to find it, where is it located in the library ?

Sorry I mean the conf.py file

… available. All tensors in the example are on the cpu, so if the system has an available GPU the example breaks and the associated doc can't be generated.

…ilable, mix up between cpu and cuda.

… lines containing \text{} compile correctly

…in plot parameters

Tmodrzyk · 2025-07-09T16:28:05Z

Now the config_matplotlib sets the font.size to 17, when it was set to 9 or 12 before. Have you checked that it still looks good ?

So indeed it was not looking good with fontsize 17. Now it's supposed to be set at 9 again in the examples.

Moreover, I am wondering if there is a possibility to call config_matplotlib() in the setup.py file so that all the documentation is run with these options, rather than having it in every example file

I did that at the top of the conf.py file. However, calling plot with default value fontsize=17 overwrites this setting, so I changed slightly the way this parameter is handled.

The default fontsize is back to 17 except when generating the doc examples, then the fontsize is 9.

…nfig_matplotlib`` When using seaborn, fontsize had again no effect on the fontsize of the titles, but only on suptitles. Now one can use seaborn and still control the fontsize of the titles.

Tmodrzyk · 2025-07-15T09:14:44Z

I built the doc locally and checked that everything looks ok.
Now the default fontsize is 9 for every title and suptitle in the doc's plots.
@Andrewwango @samuro95 could you maybe build the doc too just to double check that I did not break everything ? 😃

deepinv/utils/plotting.py

examples/basics/demo_remote_sensing.py

examples/basics/demo_tour_mri.py

examples/sampling/demo_diffpir.py

samuro95

I added new comments with the new changes.

mh-nguyen712 · 2025-07-16T11:34:19Z

We just updated the preview docs for pr. Can your merge with deepinv/main to generate the preview doc @Tmodrzyk ? Thanks!

Tmodrzyk · 2025-07-16T13:09:10Z

@mh-nguyen712 It seems I'm up to date with main, I'm not sure about what I should do ?
Also, is the CI broken ? I have a permission denied when building the docs

mh-nguyen712 · 2025-07-17T14:30:32Z

Sorry for this bug. We just fixed it @Tmodrzyk . Can you merge with main and push again, please? The generated docs then can be found in the Actions. Thanks!

…RUNet has a fixed number of scales. (deepinv#603)

* remove circle ci + modify docs push * hai comments + contributing guidelines * fix yaml * edit if message exists * yaml refix * prpreview cleanup * try sth * fix * fix again * fix * try sth 2 * fix again * try * and now * ahhh * add permission * fix link * fix link * move to end * add tip

* add size requirement for pretrained diffunet * Update deepinv/models/diffunet.py * Update deepinv/models/diffunet.py * Apply suggestions from code review * black trailing whitespaces * cosmit forward diffusion

* download url of built doc * syntax * comment artifact * comment not working * simple solution * update contrib guide * rm workflow * changes

Andrewwango · 2025-07-18T05:59:22Z

I've just merged from main to remove existing changes from this PR

Andrewwango

Looks good to me

Tmodrzyk · 2025-07-18T07:36:30Z

Looking at the docs generated by the CI, it seems the fontsize is back at 17 for some reasons. I'll double check locally.

My previous solution for the global fontsize was still overwritten by new calls to ``setup_matplotlib``

Tmodrzyk · 2025-07-21T07:41:21Z

Now the fontsize works as expected: 17 by default, fontsize if specified, and 9 in the docs.
I'm not sure that the solution was the most elegant but it works.

Tmodrzyk · 2025-07-23T08:04:39Z

@Andrewwango @samuro95 I think I'm done with this PR, let me know if there's any issue. :)

Andrewwango

LGTM, thanks!

jscanvic

Thanks for the fix!

The font size is really small in the generated docs for the page on 3D diffraction PSFs. Can you check it out?

main:

PR:

Tmodrzyk · 2025-08-08T10:38:44Z

I changed the CSS to fix Issue #673 causing figures to be plotted side by side instead of one after the other.
I also increased the default font size for the examples and fixed some errors in other plotting functions.
@jscanvic let me know if you spot any other issues in the examples :)

jscanvic

LGTM thanks for fixing that!

Ready to merge

Remove the size parameter in calls to plt.suptitle and set_title

542f730

samuro95 previously requested changes Jul 9, 2025

View reviewed changes

Tmodrzyk added 5 commits July 9, 2025 15:46

Add the cpu option in the trainer, the default being cuda if a gpu is…

ad45fe0

… available. All tensors in the example are on the cpu, so if the system has an available GPU the example breaks and the associated doc can't be generated.

Other errors in the examples, related to the device when a GPU is ava…

5d8912f

…ilable, mix up between cpu and cuda.

Add the ansmath package to the tex environment of matlplotlib so that…

d8228aa

… lines containing \text{} compile correctly

Further device errors in examples when building with a GPU available

c93736f

Call to config_matplotlib in conf.py + remove default fontsize value …

b46c932

…in plot parameters

Set figure title fontsize and axes title fontsize explicitely in ``co…

99402b1

…nfig_matplotlib`` When using seaborn, fontsize had again no effect on the fontsize of the titles, but only on suptitles. Now one can use seaborn and still control the fontsize of the titles.

Andrewwango linked an issue Jul 11, 2025 that may be closed by this pull request

fontsize parameter in deepinv.utils.plot has no effect #594

Closed

trigger CI docs rerun

cb289c1