Skip to content

Latest commit

 

History

History
358 lines (281 loc) · 23.8 KB

README_jp.md

File metadata and controls

358 lines (281 loc) · 23.8 KB

LMFlow

LMFlow

English | 简体中文 | Español | 日本語 | 한국어 | हिंदी

日文版はChatGPTによって翻訳されました。もし間違いがあれば、contributorに修正していただけると幸いです。また、英語版と内容に差異がある場合は、英語版を優先してください。

Code License Python 3.9+ Doc Embark slack badge WeChat badge

拡張性、利便性、効率性に優れた、大規模な機械学習モデルのファインチューニングに最適なツールボックスで、ユーザーフレンドリーで高速かつ信頼性があり、コミュニティ全体で利用可能な設計です。

すべての人のための大規模言語モデル。私たちのビジョンをご覧ください

LMFlow-features

Latest News

Demos

現在、私たちのチェックポイントダウンロードサービスはキャパシティに達しています。1つのサーバーを割り当ててサポートしています。もし「too many HTTP requests」のエラーが表示された場合は、数分待ってから再度お試しください。ご理解いただきありがとうございます。🙏

私たちは以下の4種類のデモを提供しています。

  • オンラインサービス：コードを実行する必要がなく、私たちのモデルを試したいだけの場合、説明にチューニングされたLLaMA-7BとLLaMA-33Bをデプロイしています。
  • Colabチャットボット（シェル）：対話型のシェルベースのチャットボットで、簡単にColab上でチャットボットをデプロイできます。
  • Colabチャットボット（Web）：対話型のWebベースのチャットボットで、簡単に自分自身のチャットボットをColab上でデプロイできます。
  • ローカルデプロイ：自分のモデル/チャットボットをローカルにデプロイする方法も提供しています。つまり、リソースが十分であれば、前述の3つの方法よりもはるかに大きなモデルをデプロイできます。

Code License colab badge colab badge

Online Service

Webサービスにアクセスしていただきありがとうございます。LLaMA-7B-tunedとLLaMA-33B-tunedをオンラインでプレビュー用にデプロイしています。ウェブサイトのトラフィックが高いため、サイトが応答しないことがあります。その場合は、「ローカルデプロイ」を参照してチャットボットをデプロイすることもできます。.

Colab chatbot(shell)

私たちは、Google ColabのT4/P100/V100 GPUを使用した、シンプルなシェルデモのチャットボットを提供しています。 提供されるgpt-neo-2.7bモデルは、かなり弱いモデルであり、英語のみをサポートしており、時には不十分な応答を生成することがあります。パフォーマンスを改善するには、ユーザー自身のデータセットを使用してファインチューニングを行い、LMFlowでより良いモデルを取得することができます。また、他の利用可能なデコーダー専用モデルも試すことができます。🤗 huggingfaceで提供されています。

./scripts/run_chatbot.sh {another-model-name}

Colab chatbot(web)

私たちは、Google ColabのT4/P100/V100 GPUを使用した、シンプルなウェブデモのチャットボットを提供しています。 提供されるgpt-neo-2.7bモデルは、かなり弱いモデルであり、英語のみをサポートしており、時には不十分な応答を生成することがあります。

Local Deploy

もしリソースを持っていてローカルに独自のモデルをデプロイしたい場合は、以下の手順で簡単にFlaskサーバーを実行してバックエンドを起動し、対話型のWebフロントエンドを起動することができます。

cd ./service
python app.py

Medical Performance

PubMedQA (ID) MedQA-USMLE (OOD) MedMCQA (ID) Average
Human (pass) 60.0 50.0
Human (expert) 78.0 87.0 90.0 85.0
InstructGPT 175B 73.2 46.0 44.0 54.4
ChatGPT 63.9 57.0 44.7 55.2
LLaMA 7B 5.2 27.1 24.3 18.9
LLaMA 33B 1.8 43.4 30.3 25.2
Task-tuned LLaMA 7B (Full) 75.1 44.5 49.9 56.5
Task-tuned LLaMA 33B (LoRA) 74.0 51.3 50.2 58.5

LLaMA 33B（LoRA）のパフォーマンスは、単一の8 \ * A100サーバーでPubMedQAおよびMedMCQAのトレーニングスプリットで約16時間のファインチューニングで達成されます。 Instruction tuningの結果を含む、より詳細なパフォーマンスについては、当社のドキュメンテーションを参照してください。

Model Zoo

当社はトレーニング済みのチェックポイントをオープンソース化し、誰でも追加のトレーニングや推論に使用できるようにしました。

Instruct-tuned Models Status Base Model Download
LLaMA-7B-tuned completed LLaMA-7B Google Drive
LLaMA-13B-tuned completed LLaMA-13B Google Drive
LLaMA-33B-tuned completed LLaMA-33B Google Drive
LLaMA-65B-tuned training LLaMA-65B Google Drive
LLaMA7B-medical completed LLaMA-7B Google Drive
LLaMA13B-medical completed LLaMA-13B Google Drive
LLaMA33B-medical completed LLaMA-33B Google Drive
LLaMA65B-medical training LLaMA-65B Google Drive

Supported Pipelines

Pipelines Status
Task Tuning ✅ Supported
Instruction Tuning ✅ Supported
Parameter-Efficient Tuning ✅ Supported
Large Model Inference ✅ Supported
Alignment Tuning 🔧 Developing

Supported Models

🤗 Hugging Faceのすべてのdecoder modelsを完全にサポートし、LLaMA、GPT2、GPT-Neo、Galacticaを完全にテストしました。エンコーダーモデルも近日中にサポートする予定です。

1.Setup

私たちのパッケージはLinuxオペレーティングシステム（Ubuntu 20.04）で全面的にテストされています。その他のオペレーティングシステムプラットフォーム（MacOS、Windows）はまだ全面的にテストされていません。 予期せぬエラーが発生する可能性があります。Linuxマシンで試したり、Google Colabを使って体験したりすることができます。

git clone https://github.com/OptimalScale/LMFlow.git
cd LMFlow
conda create -n lmflow python=3.9 -y
conda activate lmflow
conda install mpi4py
pip install -e .

2.Prepare Dataset

以下のコマンドを実行することで、簡単にトレーニング用のサンプルデータセットとテスト用データセットをダウンロードできます。

cd data
bash download.sh all
cd -

独自のデータセットを使用する場合は、以下の形式に変換するだけで使用できます。

{
  "type": "text2text",
  "instances": [
    {
      "input": "Question: The Transformer architecture [START_REF]",
      "output": "N/A"
    },
    ...
  ]
}
{
  "type": "text_only",
  "instances": [
    {
      "text": "Defintion: In this task, we ask you to write an answer to a question that involves events that may be stationary (not changing over time) or transient (changing over time). For example, the sentence \"he was born in the U.S.\" contains a stationary event since it will last forever; however, \"he is hungry\" contains a transient event since it will remain true for a short period of time. Note that a lot of the questions could have more than one correct answer. We only need a single most-likely answer. Please try to keep your \"answer\" as simple as possible. Concise and simple \"answer\" is preferred over those complex and verbose ones. \n Input: Question: Sentence: It's hail crackled across the comm, and Tara spun to retake her seat at the helm. \nQuestion: Will the hail storm ever end? \n Output: NA \n\n"
    },
    ...
  ]
}

3. Run Scripts

3.1 Run Finetuning

以下のように、GPT-2ベースモデルの微調整を実行するには、scripts/run_finetune.sh を実行できます。

./scripts/run_finetune.sh

もし、あなたのマシンの設定を反映するためにdeepspeedに引数を提供したい場合は、対応するdeepspeedの引数をスクリプトに渡すことができます。例えば、以下のようになります。

./scripts/run_finetune.sh "--num_gpus=8 --master_port 10001"

LoRAの微調整を有効にするには、以下を参照してください。

./scripts/run_finetune_with_lora.sh

同様の方法で実行できます。

詳細な設定については、これらのスクリプトを直接変更することができます。これらのスクリプトは実際には、Pythonスクリプトexamples/finetune.pyを呼び出しているだけです。以下のように実行することができます。

deepspeed ${deepspeed_args} \
  examples/finetune.py \
    --deepspeed configs/ds_config_zero3.json \
    --bf16 \
    --run_name finetune_with_lora \
    --model_name_or_path facebook/galactica-1.3b \
    --num_train_epochs 0.01 \
    --learning_rate 2e-5 \
    --dataset_path ${dataset_path} \
    --per_device_train_batch_size 1 \
    --per_device_eval_batch_size 1 \
    --validation_split_percentage 0 \
    --logging_steps 20 \
    --block_size 512 \
    --do_train \
    --output_dir output_models/finetune \
    --overwrite_output_dir \
    --ddp_timeout 72000 \
    --save_steps 5000 \
    --dataloader_num_workers 1

ここでは、エポック数--num_train_epochsを0.01に設定して、微調整プロセスを迅速に終了できるようにしています。より良い性能を持つモデルを取得したい場合は、これらのハイパーパラメータを自由に調整してください。すべての可能な微調整引数を表示するには、

python examples/finetune.py -h

を実行できます。微調整されたモデルのチェックポイントは、--output_dirで指定された引数に保存されます。上記の例では、output_models/finetuneに保存されます。

3.2 Run Evaluation

既存のHugging Faceモデルで直接評価を実行することができます。たとえば、GPT2 largeを実行するには、以下のように実行できます。

./scripts/run_evaluation.sh

または、対応するPythonスクリプトを実行することもできます

CUDA_VISIBLE_DEVICES=0 \
    deepspeed examples/evaluate.py \
    --answer_type medmcqa \
    --model_name_or_path gpt2-large \
    --dataset_path data/MedQA-USMLE/validation \
    --deepspeed examples/ds_config.json

微調整済みモデルをロードするには、保存されたモデルのチェックポイントディレクトリパスを--model_name_or_pathで指定します。

LoRAで微調整されたモデルについては、以下を参照してください

./scripts/run_evaluation_with_lora.sh

これらのスクリプトは、当社のAPIを基に構築された例examples/*.pyを呼び出します。APIに関連するより詳細な例については、testsのユニットテスト内のメソッドを参照してください。

4. Additional Notes

4.1 LLaMA Checkpoint

  1. まず、facebookresearch/llamaからLLaMAモデルへのアクセスを取得する必要があります。公式のチェックポイントをダウンロードし${llama-path}に保存します。

  2. 次に、公式のチェックポイント${llama-path}をHuggingFaceがサポートするチェックポイント${llama-hf-path}に変換するには、次を実行してください。 python ./scripts/convert_llama_weights_to_hf.py --input_dir ${llama-path} --model_size 7B --output_dir ${llama-hf-path}/llama-7b-hf

  3. これで、${llama-hf-path}/llama-7b-hfへのチェックポイントパスを設定することで、準備ができました。お楽しみください！

  4. （オプション）これで、元のllama-7b-hf事前学習モデルがあります。を

cd output_models && ./download.sh all && cd -

使用して、当社によって微調整されたモデルの差分を取得できます。./scripts/run_evaluation_with_lora.shと同様の方法で、以下を実行してください。

CUDA_VISIBLE_DEVICES=0 \
    deepspeed examples/evaluate.py \
    --answer_type text \
    --model_name_or_path ${llama-hf-path}/llama-7b-hf \
    --lora_model_path output_models/${llama-model-diff-path} \
    --dataset_path data/alpaca/test \
    --prompt_structure "Input: {input}" \
    --deepspeed examples/ds_config.json

これで、微調整されたllamaモデルで評価を実行できます。

4.2 DeepSpeed Config

configsフォルダー内でdeepspeedを設定できます。詳細については、DeepSpeed Configurationを参照してください。

5. Model Release

5.1 Medical Model Checkpoints

当社の医療モデルのチェックポイントをダウンロードするには、以下のスクリプトを実行できます:

cd output_models
bash download.sh medical_ckpt
cd -

また、以下のGoogleドライブリンクから直接当社のモデルをダウンロードすることもできます : medical_ckpt.tar.gz

5.2 Instruction Model Checkpoints

同様に、以下のスクリプトを実行して、当社の説明書モデルのチェックポイントをダウンロードできます:

cd output_models
bash download.sh instruction_ckpt
cd -

また、以下のGoogleドライブリンクから直接当社のモデルをダウンロードすることもできます:instruction_ckpt.tar.gz

5.3 Begin Reproduce

モデルのチェックポイントをダウンロードした後、LMFlow/scripts/run_evaluation_with_lora.sh内の--lora_model_pathをoutput_models/instruction_ckpt/llama7b-lora(instruction用の例)に置き換え、--model_name_or_pathを変換済みのllamaモデルに置き換えます。そして、このシェルスクリプトを実行して、結果を再現できます。

その後、Doc.でモデルのパフォーマンスを確認できます。

Documentation

より詳しいAPIリファレンスや実験結果については、ドキュメントを参照してください。

Vision

こんにちは！ 私たちは、完全なLLMトレーニングプロセスを含むコードリポジトリの近日リリースをお知らせできることを喜んでいます。これにより、ユーザーは自分自身の言語モデルを迅速に構築し、効果的にトレーニングすることができます。

私たちのコードリポジトリは単なるモデルだけでなく、完全なトレーニングワークフロー、モデルの最適化、およびテストツールを含んでいます。会話モデル、質問応答モデル、テキスト生成モデルなど、さまざまな種類の言語モデルを構築するために使用できます。

さらに、私たちは、人々がチェックポイントや経験を共有し、コミュニティのスキルを集団で向上させることができるオープンで民主的なLLM共有プラットフォームを作成することを目指しています。LLMに興味のある人は誰でも参加し、オープンでフレンドリーなコミュニティの構築に参加することを歓迎します！

初心者でもエキスパートでも、私たちはこのプラットフォームから利益を得ることができると信じています。一緒に活気ある革新的なLLMコミュニティを築いていきましょう！

Embark slack badge WeChat badge

Disclaimer

このパッケージは、大規模モデルの調整のための簡素化されたユーザーフレンドリーなパイプラインを提供することを目的としています。その機能はユーザーによって参照されることを意図しており、データと事前学習済みモデルの準備に関する責任はユーザーに完全にあります。このパッケージは、ユーザーの準備からのコンポーネントの正確性、完全性、適用性、および合法性を保証しません。ユーザーはモデルとデータの準備に関連するすべてのリスクと責任を認識し、本パッケージを利用する前に法的、商業的、および技術的なアドバイスを受ける必要があります。パイプラインは、ユーザーのデータと事前学習済みモデルの不適切な準備によって生じた直接的、間接的、特別な、付随的、または結果的な損害について責任を負いません。

私たちのチェックポイントには、英語版と中国語版の両方が含まれており、研究目的にのみ提供されています。これらのチェックポイントに含まれるトレーニングデータには、ChatGPT言語モデルから生成された結果が含まれています。これらのチェックポイントの配布や使用を商業目的で推奨または促進することはできません。これらのチェックポイントのユーザーは、正しく適切に使用されるように責任を負う必要があります。

モデルによって生成された結果は確率モデルに基づいており、このパイプラインと直接関係があるわけではありません。結果の正確性、信頼性、適用性、法的性質は、このパイプラインによって保証されるものではありません。したがって、ユーザーは結果に関連するリスクと責任を認識し、法的、商業的、技術的なアドバイスを受けてから、モデル生成の結果に依存する必要があります。このパイプラインは、ユーザーがモデル生成の結果に依存することによって生じる直接的、間接的、特別、偶発的、または結果的な損害について、一切責任を負いません。

Support

何かお困りのことがございましたら、Githubのissueにご投稿ください。

Contributors

Citation

もしこのリポジトリが役立った場合は、ぜひ⭐をつけて引用してください。

@misc{lmflow,
  author = {Shizhe Diao and Rui Pan and Hanze Dong and KaShun Shum and Jipeng Zhang and Wei Xiong and Tong Zhang},
  title = {LMFlow: An Extensible Toolkit for Finetuning and Inference of Large Foundation Models},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://optimalscale.github.io/LMFlow/}},
}