Terazawa commited on
Commit
f3a8aa6
·
verified ·
1 Parent(s): ae56382

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +35 -249
README.md CHANGED
@@ -25,278 +25,64 @@ This llama model was trained 2x faster with [Unsloth](https://github.com/unsloth
25
 
26
 
27
 
28
- # Google Colab の場合は上記の環境構築手順を行なわず、単にこのセルから実行していってください。
29
- !pip uninstall unsloth -y
30
- !pip install --upgrade --no-cache-dir "unsloth[colab-new] @ git+https://github.com/unslothai/unsloth.git"
31
-
32
-
33
- # Google Colab のデフォルトで入っているパッケージをアップグレード(Moriyasu さんありがとうございます)
34
- !pip install --upgrade torch
35
- !pip install --upgrade xformers
36
-
37
-
38
- # notebookでインタラクティブな表示を可能とする(ただし、うまく動かない場合あり)
39
- # Google Colabでは実行不要
40
- !pip install ipywidgets --upgrade
41
-
42
 
43
- # Install Flash Attention 2 for softcapping support
44
- import torch
45
- if torch.cuda.get_device_capability()[0] >= 8:
46
- !pip install --no-deps packaging ninja einops "flash-attn>=2.6.3"
47
 
 
48
 
49
- # Hugging Face Token を指定
50
- # 下記の URL から Hugging Face Token を取得できますので下記の HF_TOKEN に入れてください。
51
- # Write権限を付与してください。
52
- # https://huggingface.co/settings/tokens
53
- HF_TOKEN = "Your Token" #@param {type:"string"}
54
 
55
- # あるいは Google Colab シークレットを使う場合、左のサイドバーより🔑マークをクリック
56
- # HF_TOKEN という名前で Value に Hugging Face Token を入れてください。
57
- # ノートブックからのアクセスのトグルをオンにし、下記の二行のコードのコメントアウトを外してください。
58
 
59
- # from google.colab import userdata
60
- # HF_TOKEN=userdata.get('HF_TOKEN')
61
 
 
 
62
 
63
- # llm-jp/llm-jp-3-13bを4bit量子化のqLoRA設定でロード。
 
64
 
65
- from unsloth import FastLanguageModel
66
- import torch
67
- max_seq_length = 512 # unslothではRoPEをサポートしているのでコンテキスト長は自由に設定可能
68
- dtype = None # Noneにしておけば自動で設定
69
- load_in_4bit = True # 今回は13Bモデルを扱うためTrue
70
 
71
- model_id = "llm-jp/llm-jp-3-13b"
72
- new_model_id = "llm-jp-3-13b-it" #Fine-Tuningしたモデルにつけたい名前、it: Instruction Tuning
73
- # FastLanguageModel インスタンスを作成
74
- model, tokenizer = FastLanguageModel.from_pretrained(
75
- model_name=model_id,
76
- dtype=dtype,
77
- load_in_4bit=load_in_4bit,
78
- trust_remote_code=True,
79
- )
80
 
81
- # SFT用のモデルを用意
82
- model = FastLanguageModel.get_peft_model(
83
- model,
84
- r = 32,
85
- target_modules = ["q_proj", "k_proj", "v_proj", "o_proj",
86
- "gate_proj", "up_proj", "down_proj",],
87
- lora_alpha = 32,
88
- lora_dropout = 0.05,
89
- bias = "none",
90
- use_gradient_checkpointing = "unsloth",
91
- random_state = 3407,
92
- use_rslora = False,
93
- loftq_config = None,
94
- max_seq_length = max_seq_length,
95
- )
96
 
 
 
97
 
98
- # 学習に用いるデータセットの指定
99
- # 今回はLLM-jp の公開している Ichikara Instruction を使います。データにアクセスするためには申請が必要ですので、使いたい方のみ申請をしてください。
100
- # Ichikara Instruciton Hugging Face Hub にて公開することはお控えください。
101
- # また、CC-BY-NC-SAですのでモデルはライセンスを継承する前提でお使いください。
102
 
103
- # 下記のリンクから申請を終えた先に Google Drive があり、Distribution20241221_all というフォルダごとダウンロードしてください。
104
- # 今回は「ichikara-instruction-003-001-1.json」を使います。必要であれば展開(!unzip など)し、データセットのパスを適切に指定してください。
105
- # omnicampusの開発環境では取得したデータを左側にドラッグアンドドロップしてお使いください。
106
- # Google Colab の場合も左のサイドバーよりドラッグ&ドロップでアップデートしてください。
107
-
108
- # https://liat-aip.sakura.ne.jp/wp/llmのための日本語インストラクションデータ作成/llmのための日本語インストラクションデータ-公開/
109
- # 関根聡, 安藤まや, 後藤美知子, 鈴木久美, 河原大輔, 井之上直也, 乾健太郎. ichikara-instruction: LLMのための日本語インストラクションデータの構築. 言語処理学会第30回年次大会(2024)
110
-
111
- from datasets import load_dataset
112
-
113
- dataset = load_dataset("json", data_files="./ichikara-instruction-003-001-1.json")
114
- # パスの指定にご注意ください。アップロードしたファイルを右クリックし、「パスをコピー」をクリック、上記の data_files と合致していることをご確認ください。Omnicampus のディレクトリ構造とは異なるかもしれません。
115
-
116
-
117
- # 学習時のプロンプトフォーマットの定義
118
- prompt = """### 指示
119
- {}
120
- ### 回答
121
- {}"""
122
-
123
-
124
- """
125
- formatting_prompts_func: 各データをプロンプトに合わせた形式に合わせる
126
- """
127
- EOS_TOKEN = tokenizer.eos_token # トークナイザーのEOSトークン(文末トークン)
128
- def formatting_prompts_func(examples):
129
- input = examples["text"] # 入力データ
130
- output = examples["output"] # 出力データ
131
- text = prompt.format(input, output) + EOS_TOKEN # プロンプトの作成
132
- return { "formatted_text" : text, } # 新しいフィールド "formatted_text" を返す
133
- pass
134
-
135
- # # 各データにフォーマットを適用
136
- dataset = dataset.map(
137
- formatting_prompts_func,
138
- num_proc= 4, # 並列処理数を指定
139
- )
140
-
141
- dataset
142
-
143
-
144
- # データを確認
145
- print(dataset["train"]["formatted_text"][3])
146
-
147
-
148
- """
149
- training_arguments: 学習の設定
150
-
151
- - output_dir:
152
- -トレーニング後のモデルを保存するディレクトリ
153
-
154
- - per_device_train_batch_size:
155
- - デバイスごとのトレーニングバッチサイズ
156
-
157
- - per_device_eval_batch_size:
158
- - デバイスごとの評価バッチサイズ
159
-
160
- - gradient_accumulation_steps:
161
- - 勾配を更新する前にステップを積み重ねる回数
162
-
163
- - optim:
164
- - オプティマイザの設定
165
-
166
- - num_train_epochs:
167
- - エポック数
168
-
169
- - eval_strategy:
170
- - 評価の戦略 ("no"/"steps"/"epoch")
171
-
172
- - eval_steps:
173
- - eval_strategyが"steps"のとき、評価を行うstep間隔
174
-
175
- - logging_strategy:
176
- - ログ記録の戦略
177
-
178
- - logging_steps:
179
- - ログを出力するステップ間隔
180
-
181
- - warmup_steps:
182
- - 学習率のウォームアップステップ数
183
-
184
- - save_steps:
185
- - モデルを保存するステップ間隔
186
-
187
- - save_total_limit:
188
- - 保存しておくcheckpointの数
189
-
190
- - max_steps:
191
- - トレーニングの最大ステップ数
192
-
193
- - learning_rate:
194
- - 学習率
195
-
196
- - fp16:
197
- - 16bit浮動小数点の使用設定(第8回演習を参考にすると良いです)
198
-
199
- - bf16:
200
- - BFloat16の使用設定
201
-
202
- - group_by_length:
203
- - 入力シーケンスの長さによりバッチをグループ化 (トレーニングの効率化)
204
-
205
- - report_to:
206
- - ログの送信先 ("wandb"/"tensorboard"など)
207
- """
208
- from trl import SFTTrainer
209
- from transformers import TrainingArguments
210
- from unsloth import is_bfloat16_supported
211
-
212
- trainer = SFTTrainer(
213
- model = model,
214
- tokenizer = tokenizer,
215
- train_dataset=dataset["train"],
216
- max_seq_length = max_seq_length,
217
- dataset_text_field="formatted_text",
218
- packing = False,
219
- args = TrainingArguments(
220
- per_device_train_batch_size = 2,
221
- gradient_accumulation_steps = 4,
222
- num_train_epochs = 1,
223
- logging_steps = 10,
224
- warmup_steps = 10,
225
- save_steps=100,
226
- save_total_limit=2,
227
- max_steps=-1,
228
- learning_rate = 2e-4,
229
- fp16 = not is_bfloat16_supported(),
230
- bf16 = is_bfloat16_supported(),
231
- group_by_length=True,
232
- seed = 3407,
233
- output_dir = "outputs",
234
- report_to = "none",
235
- ),
236
- )
237
-
238
-
239
- #@title 現在のメモリ使用量を表示
240
- gpu_stats = torch.cuda.get_device_properties(0)
241
- start_gpu_memory = round(torch.cuda.max_memory_reserved() / 1024 / 1024 / 1024, 3)
242
- max_memory = round(gpu_stats.total_memory / 1024 / 1024 / 1024, 3)
243
- print(f"GPU = {gpu_stats.name}. Max memory = {max_memory} GB.")
244
- print(f"{start_gpu_memory} GB of memory reserved.")
245
 
 
246
 
247
- #@title 学習実行
248
- trainer_stats = trainer.train()
249
-
250
-
251
- # ELYZA-tasks-100-TVの読み込み。事前にファイルをアップロードしてください
252
- # データセットの読み込み。
253
- # omnicampusの開発環境では、左にタスクのjsonlをドラッグアンドドロップしてから実行。
254
- import json
255
- datasets = []
256
- with open("/content//elyza-tasks-100-TV_0.jsonl", "r") as f:
257
- item = ""
258
- for line in f:
259
- line = line.strip()
260
- item += line
261
- if item.endswith("}"):
262
- datasets.append(json.loads(item))
263
- item = ""
264
-
265
-
266
- # 学習したモデルを用いてタスクを実行
267
- from tqdm import tqdm
268
-
269
- # 推論するためにモデルのモードを変更
270
- FastLanguageModel.for_inference(model)
271
 
272
- results = []
273
- for dt in tqdm(datasets):
274
- input = dt["input"]
275
 
276
- prompt = f"""### 指示\n{input}\n### 回答\n"""
277
 
278
- inputs = tokenizer([prompt], return_tensors = "pt").to(model.device)
279
 
280
- outputs = model.generate(**inputs, max_new_tokens = 512, use_cache = True, do_sample=False, repetition_penalty=1.2)
281
- prediction = tokenizer.decode(outputs[0], skip_special_tokens=True).split('\n### 回答')[-1]
 
282
 
283
- results.append({"task_id": dt["task_id"], "input": input, "output": prediction})
284
 
285
 
286
- # jsonlで保存
287
- with open(f"{new_model_id}_output.jsonl", 'w', encoding='utf-8') as f:
288
- for result in results:
289
- json.dump(result, f, ensure_ascii=False)
290
- f.write('\n')
291
 
292
 
293
- # LoRAアダプタだけ保存
294
- model.push_to_hub_merged(
295
- new_model_id+"_lora",
296
- tokenizer=tokenizer,
297
- save_method="lora",
298
- token=HF_TOKEN,
299
- private=True
300
- )
301
 
302
 
 
25
 
26
 
27
 
28
+ Sample Use
 
 
 
 
 
 
 
 
 
 
 
 
 
29
 
30
+ 以下は、elyza-tasks-100-TV_0.jsonlの回答のためのコードです。
 
 
 
31
 
32
+ 推論用コード
33
 
34
+ 本コードはunslothで学習したqLoRAのアダプタを用いてELYZA-tasks-100-TVの出力を得るためのコードです。
35
+ Hugging Faceにアダプタをアップロードしてあることが前提となります。 このコードはunslothライブラリを用いてモデルを読み込み、推論するためのコードとなります。 このコードで生成されたjsonlファイルは課題の成果として提出可能なフォーマットになっております。
 
 
 
36
 
37
+ ※本コードはGoogle Colabでの動作を想定しており、Omnicampusでの動作を想定しておりません。
 
 
38
 
39
+ 必要なライブラリをインストール
40
+ %%capture !pip install unsloth !pip uninstall unsloth -y && pip install --upgrade --no-cache-dir "unsloth[colab-new] @ git+https://github.com/unslothai/unsloth.git" !pip install -U torch !pip install -U peft
41
 
42
+ 必要なライブラリを読み込み
43
+ from unsloth import FastLanguageModel from peft import PeftModel import torch import json from tqdm import tqdm import re
44
 
45
+ ベースとなるモデルと学習したLoRAのアダプタ(Hugging FaceのIDを指定)。
46
+ model_id = "llm-jp/llm-jp-3-13b" adapter_id = ""
47
 
48
+ Hugging Face Token を指定。
49
+ 下記の URL から Hugging Face Token を取得できますので下記の HF_TOKEN に入れてください。
50
+ https://huggingface.co/settings/tokens
51
+ HF_TOKEN = "your Token" #@param {type:"string"}
 
52
 
53
+ unslothのFastLanguageModelで元のモデルをロード。
54
+ dtype = None # Noneにしておけば自動で設定 load_in_4bit = True # 今回は13Bモデルを扱うためTrue
 
 
 
 
 
 
 
55
 
56
+ model, tokenizer = FastLanguageModel.from_pretrained( model_name=model_id, dtype=dtype, load_in_4bit=load_in_4bit, trust_remote_code=True, )
 
 
 
 
 
 
 
 
 
 
 
 
 
 
57
 
58
+ 元のモデルにLoRAのアダプタを統合。
59
+ model = PeftModel.from_pretrained(model, adapter_id, token = HF_TOKEN)
60
 
61
+ タスクとなるデータの読み込み。
62
+ 事前にデータをアップロードしてください。
63
+ datasets = [] with open("./elyza-tasks-100-TV_0.jsonl", "r") as f: item = "" for line in f: line = line.strip() item += line if item.endswith("}"): datasets.append(json.loads(item)) item = ""
 
64
 
65
+ モデルを用いてタスクの推論。
66
+ 推論するためにモデルのモードを変更
67
+ FastLanguageModel.for_inference(model)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
68
 
69
+ results = [] for dt in tqdm(datasets): input = dt["input"]
70
 
71
+ prompt = f"""### 指示\n{input}\n### 回答\n"""
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
72
 
73
+ inputs = tokenizer([prompt], return_tensors = "pt").to(model.device)
 
 
74
 
75
+ outputs = model.generate(**inputs, max_new_tokens = 512, use_cache = True, do_sample=False, repetition_penalty=1.2) prediction = tokenizer.decode(outputs[0], skip_special_tokens=True).split('\n### 回答')[-1]
76
 
77
+ results.append({"task_id": dt["task_id"], "input": input, "output": prediction})
78
 
79
+ 結果をjsonlで保存。
80
+ ここではadapter_idを元にファイル名を決定しているが、ファイル名は任意で問題なし。
81
+ json_file_id = re.sub(".*/", "", adapter_id) with open(f"/content/{json_file_id}_output.jsonl", 'w', encoding='utf-8') as f: for result in results: json.dump(result, f, ensure_ascii=False) f.write('\n')
82
 
 
83
 
84
 
 
 
 
 
 
85
 
86
 
 
 
 
 
 
 
 
 
87
 
88