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.

Sign up for GitHub

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

Jump to bottom

Improve Documentation #108

Open
fabianlim opened this issue Nov 8, 2024 · 0 comments
Open

Improve Documentation #108

fabianlim opened this issue Nov 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@fabianlim
Copy link
Contributor

@anhuong @willmj As we are expecting more collaborators, we need to improve the documentation.

Current Documentation

  • Design of framework: Integration with fms-hf-tuning, how to add new plugins
  • Benchmarks: How to run benches, measure memory,
  • plugin specific documentation, e.g, accelerated-peft : what plugins are maintained, citations, license concerns, known issues, running plugin specific benchmarks.

Perhaps we can first think about the documentation that is missing

  • Contributing.md: checking benches for regression. etc..
  • benches: creating new benches
@fabianlim fabianlim added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fabianlim