OpenFreeEnergy / OpenFreeEnergy/openfe

Checkpoint restoration

Open
#887 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
331
Forks
56
Avg merge
3d 9h
Merged PRs (30d)
13

Description

Dear OpenFE team developers,

Thanks for the great work on OpenFE. I have noted that, while the package saves checkpoints by default, there are no indications in the documentation (nor was I able to find instructions on the code) on how to resume an interrupted job from the checkpoint. Am I missing something?

If I am correct that there is no standard checkpointing restoration system, I suspect it wouldn't be too hard to implement one. The samplers could use the from_storage methods of the corresponding OpenMMTools samplers when a checkpoint is found. To make it more seamless, one could also modify the hash generation so they are uniformly generated (i.e. if, when rerunning the quickrun command, the generated shared/scratch folders were identical). Are there any plans to do something like this in the future, or can I have a go?

Best wishes,
Carlos

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the quickrun checkpoint and storage handling, then compare the corresponding OpenMMTools samplers' from_storage methods. Clarify how shared and scratch folder hashes should remain stable across reruns. Done means an interrupted quickrun can reliably restore from its checkpoint, with the behavior documented and tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.