Update README.md

README.md

@@ -20,3 +20,92 @@ language:
 This llama model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
 
 [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+
+
+
+# usage
+## -import
+```python
+# 必要なライブラリを読み込み
+from unsloth import FastLanguageModel
+from peft import PeftModel
+import torch
+import json
+from tqdm import tqdm
+import re
+```
+
+## -setting
+```python
+# Hugging Faceで取得したToken
+HF_TOKEN = "{Your hugging face token}"
+
+# モデルのIDと、LoRAのアダプタ名
+model_id = "llm-jp/llm-jp-3-13b"
+adapter_id = "nishimura999/llm-jp-3-13b-it-v106_lora"
+```
+
+## -load
+```python
+# unslothのFastLanguageModelで元のモデルをロード。
+dtype = None
+load_in_4bit = True
+model, tokenizer = FastLanguageModel.from_pretrained(
+    model_name=model_id,
+    dtype=dtype,
+    load_in_4bit=load_in_4bit,
+    trust_remote_code=True,
+)
+# 元のモデルにLoRAのアダプタを統合。
+model = PeftModel.from_pretrained(model, adapter_id, token = HF_TOKEN)
+```
+
+## -dataset
+```python
+# データセットの読み込み。
+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 = ""
+```
+
+## -generate
+```python
+# モデルを用いてタスクの推論。
+
+FastLanguageModel.for_inference(model)
+
+results = []
+for dt in tqdm(datasets):
+  input = dt["input"]
+
+  prompt = f"""### 指示\n{input}\n### 回答\n"""
+
+  inputs = tokenizer([prompt], return_tensors = "pt").to(model.device)
+
+  outputs = model.generate(**inputs, max_new_tokens = 1024, use_cache = True, do_sample=False, repetition_penalty=1.2)
+  prediction = tokenizer.decode(outputs[0], skip_special_tokens=True).split('\n### 回答')[-1]
+
+  results.append({"task_id": dt["task_id"], "input": input, "output": prediction})
+```
+
+## -output
+```python
+# 結果をjsonlで保存。
+json_file_id = re.sub(".*/", "", adapter_id)
+with open(f"./{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')
+```
+
+# ref
+### 本モデルは下記のデータを使ってファインチューニングしております。ここでデータ提供者に感謝申し上げます。
+  (https://liat-aip.sakura.ne.jp/wp/llmのための日本語インストラクションデータ作成/llmのための日本語インストラクションデータ-公開/)
+  関根聡, 安藤まや, 後藤美知子, 鈴木久美, 河原大輔, 井之上直也, 乾健太郎.
+  ichikara-instruction: LLMのための日本語インストラクションデータの構築. 言語処理学会第30回年次大会(2024)