ColossalAI icon indicating copy to clipboard operation
ColossalAI copied to clipboard

[DOC]: optimize readme of ChatGPT

Open ver217 opened this issue 2 years ago • 11 comments

📚 The doc issue

A new user is hard to start training after reading the readme.

I list some FAQs which users may concern:

  • How to prepare training dataset? What does the dataset look like?
  • How to save models?
  • How to use the fine-tuned models to generate?
  • How to use LoRA? How does it affect training?

ver217 avatar Feb 15 '23 06:02 ver217

The biggest question in my mind is: How to initialize optimizer states when finetuning a pre-trained model?

feifeibear avatar Feb 15 '23 06:02 feifeibear

Hi, I found this picture a little confusing. I think if there is some description, it would be much better.

Gy-Lu avatar Feb 15 '23 06:02 Gy-Lu

Hi, I found this picture a little confusing. I think if there is some description, it would be much better.

Yes, at least tell the readers: the green part is the trainable parameters and the rest parts are frozen parameters.

feifeibear avatar Feb 15 '23 06:02 feifeibear

I think we need a detail blog to tell user what is reward model, critic model, sft-model

Fazziekey avatar Feb 15 '23 06:02 Fazziekey

This picture is from InstructGPT, maybe there should be copyright information?

Gy-Lu avatar Feb 15 '23 06:02 Gy-Lu

I think instructs LM is better than chatgpt, chatgpt is a serving, instruct LM is an algorithm

Fazziekey avatar Feb 15 '23 06:02 Fazziekey

This picture is from InstructGPT, maybe there should be copyright information?

image Thanks for your remind, and we mention the reference here.

ht-zhou avatar Feb 15 '23 07:02 ht-zhou

##Todo

  • implement PPO training and fine-tuning

We should also mentioned PPO fine-tuning. This looks a lot like we haven't implemented finetune function yet, because we plan to implement PPO-ptx fine-tuning.

binmakeswell avatar Feb 15 '23 08:02 binmakeswell

c56c4ea7-c449-40ba-8b53-84d6cb9e647c Clear error message or doc to remind user 'pip install .'

binmakeswell avatar Feb 15 '23 09:02 binmakeswell

TODO ckpt Seriously affect the actual use of the user, need to be fixed as a priority

binmakeswell avatar Feb 15 '23 10:02 binmakeswell

Hi, I found this picture a little confusing. I think if there is some description, it would be much better.

Yes, at least tell the readers: the green part is the trainable parameters and the rest parts are frozen parameters.

I've already completed a detailed doc to explain about the training process, it will be released soon.

ht-zhou avatar Feb 15 '23 11:02 ht-zhou

We have updated a lot. Please check https://github.com/hpcaitech/ColossalAI/tree/main/applications/Chat This issue was closed due to inactivity. Thanks.

binmakeswell avatar Apr 18 '23 09:04 binmakeswell