hpcaitech
[DOC]: Too little documentation to use
📚 The doc issue
Documentation falls into a little, but not a lot of state. The official tutorial documentation is very brief, and even many methods and classes in the examples will not explain the purpose. I mean a systematic and comprehensive explanation. The tutorial is not well written, so let’s go to the code comments. Unexpectedly, there are almost no states. There are no input and output samples for the usage scenarios of classes and interfaces. Is it possible for us to read the code line by line, understand the whole framework, and be our own copycat Colossal-AI? I really don't understand, why start a large-scale publicity stunt without doing these necessary things well? Let me use deepspeed, slow me down.
Hi @BeyonderXX Thanks for the feedback. As a new project, there are still deficiencies, and the priority of document issues has been raised. Could you please provide more details which specific documents/examples are causing trouble to you, and we will fix them with higher priority, thank you.
This issue was closed due to inactivity. We have updated a lot. You can open a new issue if you have other specific questions. Thanks.