DeepSpeed icon indicating copy to clipboard operation
DeepSpeed copied to clipboard

[REQUEST] Please spend more time on the usability of the project, especially the doc.

Open tbwork opened this issue 2 years ago • 2 comments

Why is the documentation for such a great project so poor? It's just like the Windows operating system - it took decades of updates before Windows 11 finally caught up a little bit with MacOS. Your documentation lacks any logical structure, it's like a bunch of emotionally unintelligent engineers wrote it. I strongly suggest studying the open-source project Alpaca: https://github.com/cocktailpeanut/dalai. Spend more time on the usability of the project, because releasing something half-baked will only make all users suffer.

tbwork avatar Apr 14 '23 01:04 tbwork

We appreciate the feedback and we recognize that our documentation could be improved. Could you provide some examples of where our documentation is the worst? We love working on improving all aspects of DeepSpeed!

mrwyattii avatar Apr 14 '23 17:04 mrwyattii

I can provide some feedback. Go to https://www.deepspeed.ai/ it's just a list of news.

It doesn't say what the project does or how to work with it.

Then if I click tutorials there doesn't seem to be a structure you have to scroll down to find a 'Getting Started' tutorial.

Hope this helps.

9876691 avatar May 02 '23 10:05 9876691