carpentries-incubator / deep-learning-intro

Learn Deep Learning with Python
https://carpentries-incubator.github.io/deep-learning-intro/
Other
30 stars 37 forks source link

improve figure captions for activation functions #465

Closed qualiaMachine closed 1 month ago

qualiaMachine commented 1 month ago

I didn't like the figure captions (activation function labels) showing up below each horizontal line -- was confusing to read. Added captions above each figure.

github-actions[bot] commented 1 month ago

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

Rendered Changes

:mag: Inspect the changes: https://github.com/carpentries-incubator/deep-learning-intro/compare/md-outputs..md-outputs-PR-465

The following changes were observed in the rendered markdown documents:

 1-introduction.md | 11 ++++----
 config.yaml (new) | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 md5sum.txt        |  3 +-
 3 files changed, 91 insertions(+), 7 deletions(-)
What does this mean? If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2024-05-17 15:48:12 +0000

qualiaMachine commented 1 month ago

Thanks, @svenvanderburg. It looks like we might need to add some newlines between the figure caption and where the figure appears now. Right now they are showing up inline. Could you play around with this, @svenvanderburg ? Might be easier to check your work with maintainer privileges. Otherwise I'll send another pull request soon.

svenvanderburg commented 1 month ago

@qualiaMachine fixed with https://github.com/carpentries-incubator/deep-learning-intro/pull/469

Tip: you can install the infrastructure locally and then preview your lesson locally.