docs(deposits): state that deposits/ mirrors PSDI's latest version
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
Open deposits/README.md and review how directories and published model versions are currently described. Document the one-directory-per-record, update-in-place convention, including that superseded versions remain in git history, then verify the acceptance criteria before #70 publishes another version.
Written by the indexing model from the issue text.
Description
Problem
deposits/ holds one directory per published model, and the convention has
always been that a directory describes the record's current PSDI version —
the CGCNN v2 release replaced deposits/metallicity/is_metal/cgcnn in place
rather than adding a sibling directory. That convention was never written
down anywhere.
The 1-based k-index migration (#70) is about to publish a second version of
d5ds2-64f16. Without the rule stated, the obvious move is a v1/v2
directory split, which would leave the repository holding two descriptions
of one record, only one of which is true.
Proposed approach
Document the convention in deposits/README.md: one directory per record,
describing its current version; on a new PSDI version, update the directory
in place (new checksums, new numbers, same path); superseded versions stay in
git history, not as a sibling directory.
Acceptance criteria
deposits/README.mdstates the one-directory-per-record, update-in-place
rule before #70 produces a second version of any record.
Written by an agent on behalf of Junwen Yin.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- Avg merge
- 3h 17m
- Merged PRs (30d)
- 55
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.
More from stfc/goldilocks-ml
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
stfc/goldilocks-ml#71 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
stfc/goldilocks-ml#70 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 45/100
stfc/goldilocks-ml#68 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
stfc/goldilocks-ml#64 · 4 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 38/100
stfc/goldilocks-ml#62 · 2 comments ·
All issues in stfc/goldilocks-ml
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100