llm-jp-3-13b-finetune_SS19

このモデルの概要

本モデルは、このファイル（README.md）と同フォルダの「suiron.py」のコードを実行することで推論が可能です（ただし、HF TOKENや、問題（入力データ）のJSON Fileを用意する必要あり）。

また、本モデルは、このファイル（README.md）と同フォルダにある「提出用lora_template_19_20241127.py」のコードをOmnicampusの演習環境で実行することで得られています。 同コードは、前半はファインチューニング用のコードですが、後半にある「回答」の部分のコードを参考にして、本モデルを用いて推論するコードを作成できます。

具体的な実行手順

次の「１前提条件」を満たし、「２　実行するコード」に沿ってコードを実行することで、Hugging Face上のモデル('SquareStar/llm-jp-3-13b-finetune_SS19)を用いて、 入力ファイル(elyza-tasks-100-TV_0.jsonl)に記載されている指示文書を入力データとして推論し、その結果を{model_name}-outputs.jsonl`という名前のファイルに出力できます。 なお、入力ファイルは、フォーマットが同じであれば、任意の内容で推論可能です。

１　前提条件

　前提条件として次を用意していください。

• Pythonが実行できる環境（例: Google Colab）
• Hugging Faceのアクセストークン (HF_TOKEN) が取得済みであること
• GPU（CUDA)が使用できること

２　実行するコード

ライブラリのインストール

　必要なライブラリのインストールを行います。 　

!pip install -U bitsandbytes
!pip install -U transformers
!pip install -U accelerate
!pip install -U datasets

Hugging Faceのトークンの設定

　Hugging Faceのトークンを取得していることを確認して、設定してください。 次のコードは、JupyterNotebook環境を使う場合です（実行環境に合わせて適宜変更してください）。

 HF_TOKEN = "PLEASE-WIRTE-YOUR-HF-TOKEN"

モデル・トークナイザの読み込み

モデルとトークナイザーを読み込みます。

import torch
from tqdm import tqdm
import json

model_name = "SquareStar/llm-jp-3-13b-finetune_SS19"

from transformers import (
    AutoModelForCausalLM,
    AutoTokenizer,
    BitsAndBytesConfig,
)

# QLoRA用の設定
bnb_config = BitsAndBytesConfig(
    load_in_4bit=True,
    bnb_4bit_quant_type="nf4",
    bnb_4bit_compute_dtype=torch.bfloat16,
    bnb_4bit_use_double_quant=False,
)

# モデル読み込み
model = AutoModelForCausalLM.from_pretrained(
    model_name,
    quantization_config=bnb_config,
    device_map="auto",
    token = HF_TOKEN
)

tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True, token = HF_TOKEN)

入力データの準備

elyza-tasks-100-tv.jsonlと同じ形式であれば、任意のファイルを入力することができます。 ここでは./elyza-tasks-100-TV_0.jsonlというファイルを入力データセットとする場合のコードを示しています。

datasets = []
with open("./elyza-tasks-100-TV_0.jsonl", "r") as f: #PLEASE WRITE YOUR JSON FILE NAME!!
    item = ""
    for line in f:
      line = line.strip()
      item += line
      if item.endswith("}"):
        datasets.append(json.loads(item))
        item = ""

推論実行

読み込んだファイルに対して、モデルを用いて推論を実行します。

results = []
for data in tqdm(datasets):

  input = data["input"]

  prompt = f"""### 指示
  {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,
          do_sample=False,
          repetition_penalty=1.2
      )[0]
  output = tokenizer.decode(outputs[tokenized_input.size(1):], skip_special_tokens=True)

  results.append({"task_id": data["task_id"], "input": input, "output": output})


  

出力の保存

最後に、model_nameをベースにしたファイル名でJSONL形式の出力ファイルに、推論の実行結果を保存します。

import re
model_name = re.sub(".*/", "", model_name)
with open(f"./{model_name}-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')

以上のコードを実行することで、{model_name}-outputs.jsonlというファイルに推論結果が書き出されます。

Model Card for Model ID

<!-- Provide a quick summary of what the model is/does. -->

Model Details

Model Description

<!-- Provide a longer summary of what this model is. -->

This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.

• Developed by: SquareStar　and LLM2024講座スタッフ
• Funded by [optional]: [More Information Needed]
• Shared by [optional]: [More Information Needed]
• Model type: [More Information Needed]
• Language(s) (NLP): Japanese
• License: [More Information Needed]
• Finetuned from model [optional]: llm-jp/llm-jp-3-13b

Model Sources [optional]

<!-- Provide the basic links for the model. -->

• Repository: [More Information Needed]
• Paper [optional]: [More Information Needed]
• Demo [optional]: [More Information Needed]

Uses

<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->

Direct Use

<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->

[More Information Needed]

Downstream Use [optional]

<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->

[More Information Needed]

Out-of-Scope Use

<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->

[More Information Needed]

Bias, Risks, and Limitations

<!-- This section is meant to convey both technical and sociotechnical limitations. -->

[More Information Needed]

Recommendations

<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->

Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.

How to Get Started with the Model

Use the code below to get started with the model.

[More Information Needed]

Training Details

Training Data

<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->

[Fine tuningに使用したデータ] https://liat-aip.sakura.ne.jp/wp/llmのための日本語インストラクションデータ作成/llmのための日本語インストラクションデータ-公開/ 関根聡, 安藤まや, 後藤美知子, 鈴木久美, 河原大輔, 井之上直也, 乾健太郎. ichikara-instruction: LLMのための日本語インストラクションデータの構築. 言語処理学会第30回年次大会(2024)

https://huggingface.co/datasets/elyza/ELYZA-tasks-100 ELYZA-tasks-100: 日本語instructionモデル評価データセット

Training Procedure

<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->

Preprocessing [optional]

[More Information Needed]

Training Hyperparameters

• Training regime: [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->

Speeds, Sizes, Times [optional]

<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->

[More Information Needed]

Evaluation

<!-- This section describes the evaluation protocols and provides the results. -->

Testing Data, Factors & Metrics

Testing Data

<!-- This should link to a Dataset Card if possible. -->

[More Information Needed]

Factors

<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->

[More Information Needed]

Metrics

<!-- These are the evaluation metrics being used, ideally with a description of why. -->

[More Information Needed]

Results

[More Information Needed]

Summary

Model Examination [optional]

<!-- Relevant interpretability work for the model goes here -->

[More Information Needed]

Environmental Impact

<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->

Carbon emissions can be estimated using the Machine Learning Impact calculator presented in Lacoste et al. (2019).

• Hardware Type: [More Information Needed]
• Hours used: [More Information Needed]
• Cloud Provider: [More Information Needed]
• Compute Region: [More Information Needed]
• Carbon Emitted: [More Information Needed]

Technical Specifications [optional]

Model Architecture and Objective

[More Information Needed]

Compute Infrastructure

[More Information Needed]

Hardware

[More Information Needed]

Software

[More Information Needed]

Citation [optional]

<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->

BibTeX:

[More Information Needed]

APA:

[More Information Needed]

Glossary [optional]

<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->

[More Information Needed]

More Information [optional]

[More Information Needed]

Model Card Authors [optional]

[More Information Needed]

Model Card Contact

[More Information Needed]