Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup documentation #573

Open
akotlar opened this issue Sep 18, 2024 · 0 comments
Open

Cleanup documentation #573

akotlar opened this issue Sep 18, 2024 · 0 comments

Comments

@akotlar
Copy link
Collaborator

akotlar commented Sep 18, 2024

Background:

A concise description of why we're pursuing this task.

Our repo is really 3 projects:

  1. High dimensional ML Python library
  2. Bioinformatics methods that use the HDML library
  3. 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

This was referenced Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant