Cleanup documentation #573
Description
Background:
A concise description of why we're pursuing this task.
Our repo is really 3 projects:
- High dimensional ML Python library
- Bioinformatics methods that use the HDML library
- Data curation and labeling, which we collectively call Annotation
#1 and #2 live in ./python, while #3 lives in ./perl
We need to clean up documentation explaining these separate but related projects.
Completion Criteria:
What is the goal, and how do we know this task is accomplished?
Documentation that makes the project structure clear, how to install each component, and how to make use of each component. We should highlight the ./python/python/bystro/examples examples, and outline use cases outside of genetics/proteomics when discussing the ML library, to make it clear the ML library is not specific to bioinformatics
Implementation Summary
Give enough technical detail for a teammate to understand the proposed solution.
N/A