A metadata template
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3
- Forks
- 0
- Avg merge
- 1h 19m
- Merged PRs (30d)
- 5
Description
Right now we have prospective data (NodeRecipe) and retrospective data (NodeData), but no retrospective metadata template, e.g. to hold things like runtimes.
Such a thing exists in the pyiron_workflow.execution.Run object. This actually pulls out extremely cleanly, needing only the class itself, the lighweight Steps class which is an iterable collection of these, a simple enum on run status, a type var bound on NodeData, and a helper class for the LexicalPath -- which is its own sub-module but anyhow depends only on flowrep!
Flowrep-compliant WfMS would then commit to producing these Run objects instead of the meta-data-free NodeData objects they currently produce. @samwaseda and I currently see this as a nice change. One of the motivators is that we want semantikon to strictly digest flowrep objects, but Sam would like semantikon knowledge graphs to include some metadata, so we'd better have space for the metadata in flowrep too!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the referenced execution.py definitions for Run, Steps, run status, and NodeData, then inspect lexical.py for the LexicalPath dependency. Determine how these pieces should be separated into flowrep and how existing consumers produce NodeData; done means flowrep-compliant workflow systems can produce retrospective Run metadata objects for downstream semantikon use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100