Update README.md

README.md

@@ -1,22 +1,105 @@
 ---
-base_model: llm-jp/llm-jp-3-13b
-tags:
-- text-generation-inference
-- transformers
-- unsloth
-- llama
-- trl
-license: apache-2.0
 language:
-- en
+    - ja
+    - en
+tags:
+    - llm
+    - question answering
+    - text generation
 ---
 
-# Uploaded  model
+LLM-JP-3-13B ファインチューニングモデル
+
+# モデル詳細
+
+    ベースモデル: llm-jp/llm-jp-3-13b
+    量子化: 4ビット量子化 (QLoRA)
+
+
+# 事前準備
+Hugging Face Tokenを取得
+
+
+# インストール
+必要なパッケージのインストール：
+
+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
+
+# 使用方法
+以下は、モデルの基本的な使用例です：
+```
+# 必要なライブラリを読み込み
+from unsloth import FastLanguageModel
+from peft import PeftModel
+import torch
+import json
+from tqdm import tqdm
+import re
+
+# ベースとなるモデルと学習したLoRAのアダプタ（Hugging FaceのIDを指定）。
+model_id = "llm-jp/llm-jp-3-13b"
+adapter_id = ""
+
+# Hugging Face Token を指定。
+# 下記の URL から Hugging Face Token を取得できますので下記の HF_TOKEN に入れてください。
+# https://huggingface.co/settings/tokens
+HF_TOKEN = "" #@param {type:"string"}
+
+# unslothのFastLanguageModelで元のモデルをロード。
+dtype = None # Noneにしておけば自動で設定
+load_in_4bit = True # 今回は13Bモデルを扱うため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)
+
+# タスクとなるデータの読み込み。
+# 事前にデータをアップロードしてください。
+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 = ""
+
+
+### 使用例
+# モデルを用いてタスクの推論。
+
+# 推論するためにモデルのモードを変更
+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 = 512, use_cache = True, do_sample=False, repetition_penalty=1.2)
+  prediction = tokenizer.decode(outputs[0], skip_special_tokens=True).split('\n### 回答')[-1]
 
-- **Developed by:** jackofayame
-- **License:** apache-2.0
-- **Finetuned from model :** llm-jp/llm-jp-3-13b
+  results.append({"task_id": dt["task_id"], "input": input, "output": prediction})
 
-This llama model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+# 結果をjsonlで保存。
 
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+# ここではadapter_idを元にファイル名を決定しているが、ファイル名は任意で問題なし。
+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')
+```