Skip to content

Conversation

@jacanchaplais
Copy link
Contributor

@jacanchaplais jacanchaplais commented Apr 24, 2025

Description of changes

Basic demo:

  • Added heading structure
  • Stated intended learning outcomes
  • Included description of function composition with JAX compatibility

CFD demo:

  • Added heading structure
  • Stated intended learning outcomes
  • Brief explanation of what's going on
  • Replaced verbose print output with tqdm
  • Included @jpbrodrick89's very cool LBFGS optimiser
  • Embedded animation for interactive play in Jupyter Notebook

Testing done

None.

License

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
  • I sign the Developer Certificate of Origin below by adding my name and email address to the Signed-off-by line.
Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Signed-off-by: [YOUR NAME] <[YOUR EMAIL]>

@jacanchaplais jacanchaplais added the documentation Improvements or additions to documentation label Apr 24, 2025
@codecov
Copy link

codecov bot commented Apr 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.00%. Comparing base (613c84d) to head (78bf3d9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #16   +/-   ##
=======================================
  Coverage   89.00%   89.00%           
=======================================
  Files           3        3           
  Lines         200      200           
  Branches       24       24           
=======================================
  Hits          178      178           
  Misses         11       11           
  Partials       11       11           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jacanchaplais
Copy link
Contributor Author

Apologies for the incorrect title, and the lack of running pre-commit hooks. I just installed them, so the next push should rectify.

I am currently working on the unchecked boxes in the PR description.

For the animation display, it does work in the Notebook, however as it renders an interactive widget, the GitHub preview does not display it. I could just display it as a GIF, which might work better for people perusing on GitHub?

@dionhaefner dionhaefner changed the title docs: improve example notebook presentation doc: improve example notebook presentation Apr 24, 2025
@dionhaefner dionhaefner enabled auto-merge (squash) April 24, 2025 23:06
@dionhaefner dionhaefner merged commit 8185cd1 into main Apr 24, 2025
10 checks passed
@dionhaefner dionhaefner deleted the jacan/demos branch April 24, 2025 23:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants