Benjamin-Lee / Benjamin-Lee/deep-rules
add a tip about appropriate documentation, publication, and sharing to ensure reproducibility and enable reuse
- Dominant language
- HTML
- Stars
- 226
- Forks
- 44
- PR merge metrics
- No merged PRs in 30d
Description
**Have you checked the [list of proposed tips](https://github.com/Benjamin-Lee/deep-rules/issues?q=is%3Aissue+is%3Aopen+label%3Atip) to see if the tip has already been proposed?**
- [ x] Yes
**Did you add yourself as a [contributor](https://github.com/Benjamin-Lee/deep-rules/blob/master/contributors.md) by making a pull request if this is your first contribution?**
- [x ] Yes, I added myself or am already a contributor
**Feel free to elaborate, rant, and/or ramble.**
I think it could be very good to include a tip section that deals with the issue of scientific reproducibility and data sharing. What are the best practices for documentation to ensure that others can reproduce the work for independent evaluation and also future use in other domains, how should the datasets and trained models be published/made available, which meta-data should be attached, etc (e.g. data used for training should be made available in appropriate repositories according to FAIR principles)?
**Any citations for the rule?** (peer-reviewed literature preferred but not required)
- [DOI](doi.org/DOI_goes_here)
Contributor guide
Research direction
Start by reviewing the existing proposed tips list linked in the issue and the contributor guidance in contributors.md. Define the scope and supporting citations for a reproducibility and data-sharing tip, then ensure the finished documentation explains appropriate documentation, dataset and model availability, and metadata practices.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- machine-learning
- Domain
- data, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100