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

Adding an example of using the package in practice #55

Closed
matt-graham opened this issue Jan 5, 2024 · 2 comments
Closed

Adding an example of using the package in practice #55

matt-graham opened this issue Jan 5, 2024 · 2 comments
Assignees

Comments

@matt-graham
Copy link

Raising as part of JOSS review openjournals/joss-reviews#6148

The tutorial example in https://github.com/firedrakeproject/checkpoint_schedules/blob/main/docs/notebooks/tutorial.ipynb is great at giving an understanding of the packages's API and an overview of the different checkpoint schedule algorithms implemented, however it would also be useful to have an example of how the package can be used in practice in actual adjoint computation, even if it's for a trivial problem / forward computation.

The paper indicates the package has been incoroporated in to tlm_adjoint (presumably once tlm-adjoint/tlm_adjoint#382 is merged in?) - even just linking to how the package is used there as a 'next steps' tutorial example could be useful.

@Ig-dolci Ig-dolci self-assigned this Jan 16, 2024
@Ig-dolci Ig-dolci linked a pull request Feb 7, 2024 that will close this issue
@Ig-dolci Ig-dolci removed a link to a pull request Feb 21, 2024
@Ig-dolci
Copy link
Contributor

Ig-dolci commented Mar 1, 2024

@matt-graham We appreciate your suggestion to include an example application in our documentation.

Following your suggestion and seeking to make the usage of checkpoint_schedules more accessible, we have included an example of checkpoint_schedules usage in an adjoint-based gradient problem. You can access it in the following notebook: checkpoint_schedule application: Adjoint-Based Gradient with the Burger's Equation.

We are also pleased to inform you that checkpoint_schedules is now incorporated into the pyadjoint package (PR 121).

@matt-graham
Copy link
Author

@Ig-dolci - thanks the new notebook is fantastic!

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

No branches or pull requests

2 participants