README.md

# llm-jp-3-13b-finetune-22_lora

[![Hugging Face Models](https://img.shields.io/badge/HuggingFace-Model-yellow)](https://huggingface.co/your-model-repo)

このモデルは [Hugging Face](https://huggingface.co) 上で提供されている llm-jp/llm-jp-3-13b をファインチューニングしたモデルです。
主に日本語の指示応答タスク向けに最適化されています。

## **モデルの概要**
- **タイプ**: Transformer-based Language Model
- **トレーニングデータ**: LLM-jp の公開している Ichikara Instruction  
  https://liat-aip.sakura.ne.jp/wp/llmのための日本語インストラクションデータ作成/llmのための日本語インストラクションデータ-公開/  
  関根聡, 安藤まや, 後藤美知子, 鈴木久美, 河原大輔, 井之上直也, 乾健太郎. ichikara-instruction: LLMのための日本語インストラクションデータの構築. 言語処理学会第30回年次大会(2024)
- **タスク**: elyza_100_tv のベンチマークに対する応答

## **モデルのファインチューニング**
- **コンテキスト長**: 1024
- **学習率**: 2e-4
- **バッチサイズ**: 2
- **勾配蓄積数**: 4

## **実行環境**
- GOOGLE Colaboratory
- Linux (例: Ubuntu 24.04　CUDA12.6)

## **Ubuntuでの環境設定方法と推論実行方法**
- 必要ライブラリのインストール
  ```
  pip install unsloth
  pip install -U torch
  pip install -U peft
  ```
- ベースとなるモデルのダウンロード(任意)
  ```
  from huggingface_hub import snapshot_download
  model_name = "llm-jp/llm-jp-3-13b"
  local_dir = f"./models/{model_name}"
  snapshot_download(repo_id=model_name, local_dir=local_dir, local_dir_use_symlinks=False)
  print(f"Model downloaded to: {local_dir}")
  ```
- 推論
  ```
  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-13 #HUGGINGFACEをよりダウンロードするときはこちらを使いください
  local_model_dir = "./models/llm-jp/llm-jp-3-13b"  # 事前にダウンロードしたモデルのローカルディレクトリ
  adapter_id = "takeofuture/llm-jp-3-13b-finetune-22_lora"
  HF_TOKEN = "HUGGINGFACEのTOKENを入れてください"
  #unslothのFastLanguageModelで元のモデルをロード。
  dtype = None # Noneにしておけば自動で設定
  load_in_4bit = True # 今回は13Bモデルを扱うためTrue
  model, tokenizer = FastLanguageModel.from_pretrained(
    #model_name=model_id,
    model_name=local_model_dir, 
    dtype=dtype,
    load_in_4bit=load_in_4bit,
    trust_remote_code=True,
  )
  model = PeftModel.from_pretrained(model, adapter_id, token = HF_TOKEN)
  #推論モードに切り替え
  FastLanguageModel.for_inference(model)
  prompt = f"""### 指示\n名古屋の有名なグルメは何ですか？\n### 回答\n"""
  inputs = tokenizer([prompt], return_tensors = "pt").to(model.device)
  #不要な `token_type_ids` を削除
  if "token_type_ids" in inputs:
    del inputs["token_type_ids"]
  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]
  print(prediction)
  ```
  
## **GOOGLE　COLABORATORYでのelyza_100_tvでの推論方法**
以下のノートを参照してください
- [Model_Inference_Template_unsloth_20241127.ipynb](./Model_Inference_Template_unsloth_20241127.ipynb)

# Uploaded  model

- **Developed by:** takeofuture
- **License:** apache-2.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.
[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)