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

PEtab result schema #578

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

PEtab result schema #578

wants to merge 1 commit into from

Conversation

PaulJonasJost
Copy link
Collaborator

@PaulJonasJost PaulJonasJost commented May 16, 2024

Here is a first draft of the petab result format. There are some open questions to it:

  • Which of the three versions should be keep? Personally I think all three have merit: the python description was used as a base and allows for changes later on. The json-schema is the actual resulting data schema and the yaml version is a much better readable version of the json schema.
  • Where should this deposited?
  • Should we add a description to the readthedocs in the documentation_data_format.rst file or make a separate file?
  • Should be allow for each datatype to be extended arbitarily or require tools that want to save more open an issue on it?
  • Certain things right now are non optional, there were discussion on whether to make anything non-optional. Opinion and at some point a vote are more then welcome.

Any feedback is welcome. As the PR was done mainly by pyPESTO users, we tried to extrapolate the essential things, but are aware that this might be biased. Therefore feedback from non-pypesto users is especially welcome.

The idea for the structure for the result follows this hierarchy:

  • Result
    • Metadata like system, programming language and tool with versions
    • Problem snapshot: A snapshot of the petab problem used for any result stored. Implicitly this also means that results that (e.g. differ in the fixed parameters) should be saved separately
    • TaskResult: tasks like profiling, optimization, sampling. Is a list of singular results, each of which saves relevant data (e.g. optimization: start point, endpoint, fval) and additional metadata.

@dweindl dweindl force-pushed the release/2.0.0 branch 2 times, most recently from 02716b3 to 06697a4 Compare July 3, 2024 16:51
@dweindl dweindl changed the base branch from release/2.0.0 to main July 3, 2024 17:14
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

Successfully merging this pull request may close these issues.

2 participants