search

hiyouga / LLaMA-Factory

A WebUI for Efficient Fine-Tuning of 100+ LLMs (ACL 2024)
https://arxiv.org/abs/2403.13372
Apache License 2.0
27.18k stars 3.34k forks source link

Plan for Documentation? #4703

Closed sangttruong closed 1 week ago

sangttruong commented 2 weeks ago

My understanding is that this package has yet to have documentation. I wonder if we plan to release a documentation page to help users use the package. Without documentation, it could be difficult (especially for beginners) to understand what is required/expected by each function/class in the package or even discover what functionalities are supported by the package. I'm also happy to help create documentation if you think it's a good idea but don't have bandwidth.

hiyouga commented 2 weeks ago

Thank you for your concern about this project. In fact, we are currently working on the documentation for LlamaFactory, but initially, it will be primarily in Chinese. We plan to translate it once the documentation is nearly complete, and we also welcome contributions from the community. https://github.com/hiyouga/LLaMA-Factory-Doc

sangttruong commented 1 week ago

Thank you! Is there an established process for community contribution to the documentation (or to the codebase in general)?

hiyouga commented 1 week ago

feel free to make PRs to our repositories and we will give feedbacks in time