hpcaitech
[DOC]: 文档这么少，几乎没法用
📚 The doc issue
文档属于有一点，但不是很多的状态。 官方的教程文档非常简略，甚至给出样例的很多方法和类都不会说明用途，我意思是系统和全面的说明。 教程写的不行，那去看代码注释吧，没想到也是几乎没有的状态，对于类和接口的使用场景，输入输出样例，一点都没有提供。 难不成要我们一行一行读代码，给整个框架读懂了，做自己的山寨Colossal-AI？ 真搞不懂，这些必要的东西没做好，就开始大规模宣传噱头干什么？ 还是让我用deepspeed吧，慢死我。
Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑🤝🧑👫🧑🏿🤝🧑🏻👩🏾🤝👨🏿👬🏿
Title: [DOC]: so little documentation that it's almost useless
📚 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.
Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑🤝🧑👫🧑🏿🤝🧑🏻👩🏾🤝👨🏿👬🏿
I feel the same, the key is that I can’t run many examples in it... I wasted a lot of time and made a lot of pits, but I still can’t use it smoothly...
Which examples are you referring to? Would you please point them out and let us enhance the documentation accordingly?
感谢反馈，作为新生项目，目前确实还有很多不足，已经提升文档问题的处理优先级。 您可以具体描述下是具体哪些文档/例子对您造成困扰，后续会尽快提供针对性修复，感谢。
Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑🤝🧑👫🧑🏿🤝🧑🏻👩🏾🤝👨🏿👬🏿
Thanks for the feedback. As a freshman project, there are still many deficiencies, and the priority of document issues has been raised. Please describe in detail which specific documents/examples are causing trouble to you, and we will provide targeted fixes as soon as possible, thank you.
This issue was closed due to inactivity. We have updated a lot. You can open a new issue if you have specific questions. Thanks.