Process or Operation class
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 12
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
We will need a very lightweight abstract class that standardizes the API for algorithms. This class will not include code for supporting embarrassingly parallel computation like pyUSID.Process does. However, it should have a write_to_disk(writer) where writer is a Writer object that needs to be implemented by pyNSID and pyUSID. The idea is that algorithms which are functions right now would be converted to / used in light-weight classes. Whenever a user uses a Process, the computation will be performed and returned in memory only. If the user wants, they could choose to write the results to disk and capture all the provenance. write_results() will be the only thing that developers need to implement to enable provenance tracking in the HDF5 file
Contributor guide
No contributing guide indexed for this repository
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
Review pyUSID.Process and the current algorithm functions first; no file or test is named in the issue. Clarify the lightweight Process and Writer boundary, including in-memory execution, write_to_disk(writer), and provenance capture. Done means the API and developer responsibilities are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100