Update README.md

README.md

@@ -6,17 +6,193 @@ tags:
 - unsloth
 - llama
 - trl
-license: apache-2.0
+license: cc-by-nc-3.0
 language:
 - en
 ---
 
-# Uploaded  model
+# How to use
 
 - **Developed by:** tabachain
-- **License:** apache-2.0
+- **License:** cc-by-nc-3.0
 - **Finetuned from model :** llm-jp/llm-jp-3-13b
 
-This llama model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+Colab L4での動作確認方法とOmnicampusでの動作確認方法をそれぞれ載せます。
+(動さ確認はColab L4中心で行っているため、可能な限りColab L4での利用を推奨します)
 
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+
+### Colab L4での動作確認方法
+```python
+# 必要なライブラリをインストール
+%%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
+
+# 必要なライブラリを読み込み
+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 = "tabachain/llm-jp-3-13b-it_output_r64"
+
+# colabのシークレットにHF_TOKENを入れておき、それを読み込む
+from google.colab import userdata
+HF_TOKEN=userdata.get('HF_TOKEN')
+
+# 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]
+  results.append({"task_id": dt["task_id"], "input": input, "output": prediction})
+
+# 結果をjsonlで保存。
+
+with open(f"/content/output.jsonl", 'w', encoding='utf-8') as f:
+    for result in results:
+        json.dump(result, f, ensure_ascii=False)
+        f.write('\n')
+```
+
+### Omnicampusでの動作確認方法
+```python
+!pip install -U bitsandbytes
+!pip install -U transformers
+!pip install -U accelerate
+!pip install -U datasets
+!pip install -U peft
+
+# notebookでインタラクティブな表示を可能とする（ただし、うまく動かない場合あり）
+!pip install ipywidgets --upgrade
+
+
+from transformers import (
+    AutoModelForCausalLM,
+    AutoTokenizer,
+    BitsAndBytesConfig,
+)
+from peft import PeftModel
+import torch
+from tqdm import tqdm
+import json
+
+
+# Hugging Faceで取得したTokenをこちらに貼る。
+HF_TOKEN = ""
+
+# ベースとなるモデルと学習したLoRAのアダプタ。
+# model_idの値はomnicampusの環境におけるモデルのパスを表しており、それ以外の環境で実行する場合は変更の必要があります。
+model_id = "models/models--llm-jp--llm-jp-3-13b/snapshots/cd3823f4c1fcbb0ad2e2af46036ab1b0ca13192a"
+adapter_id = "tabachain/llm-jp-3-13b-it_output_r64"
+
+# QLoRA config
+bnb_config = BitsAndBytesConfig(
+    load_in_4bit=True,
+    bnb_4bit_quant_type="nf4",
+    bnb_4bit_compute_dtype=torch.bfloat16,
+)
+
+# Load model
+model = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    quantization_config=bnb_config,
+    device_map="auto",
+    token = HF_TOKEN
+)
+
+# Load tokenizer
+tokenizer = AutoTokenizer.from_pretrained(model_id, trust_remote_code=True, token = HF_TOKEN)
+
+# 元のモデルにLoRAのアダプタを統合。
+model = PeftModel.from_pretrained(model, adapter_id, token = HF_TOKEN)
+
+# データセットの読み込み。
+# omnicampusの開発環境では、左にタスクのjsonlをドラッグアンドドロップしてから実行。
+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 = ""
+
+# llmjp
+results = []
+for data in tqdm(datasets):
+
+  input = data["input"]
+
+  prompt = f"""### 指示
+  {input}  簡潔に回答して 
+  ### 回答
+  """
+  print("\n" + input)
+  tokenized_input = tokenizer.encode(prompt, add_special_tokens=False, return_tensors="pt").to(model.device)
+  with torch.no_grad():
+      outputs = model.generate(
+          tokenized_input,
+          max_new_tokens=512,
+          use_cache = True, 
+          do_sample=False,
+          repetition_penalty=1.2,
+          pad_token_id=tokenizer.eos_token_id
+      )[0]
+  output = tokenizer.decode(outputs[tokenized_input.size(1):], skip_special_tokens=True)
+  print("\n" + output)
+
+  results.append({"task_id": data["task_id"], "input": input, "output": output})
+
+# こちらで生成されたjsonlを提出してください。
+# 本コードではinputとeval_aspectも含んでいますが、なくても問題ありません。
+# 必須なのはtask_idとoutputとなります。
+import re
+jsonl_id = re.sub(".*/", "", adapter_id)
+with open(f"./{jsonl_id}-outputs.jsonl", 'w', encoding='utf-8') as f:
+    for result in results:
+        json.dump(result, f, ensure_ascii=False)  # ensure_ascii=False for handling non-ASCII characters
+        f.write('\n')
+```