Update README.md

README.md

@@ -1,3 +1,127 @@
----
-license: gemma
----
+---
+license: gemma
+---
+# DataPilot/ArrowMint-Gemma3-4B-ChocoMint-instruct-v0.1
+
+## Overview
+
+このモデルは、Googleの `google/gemma-3-4b-it` をベースモデルとしてファインチューニングされた日本語大規模言語モデルです。
+[Unsloth](https://github.com/unslothai/unsloth) を使用して効率的にトレーニングを行い、特別に作成された合成データセットを用いることで、特にユーザーの指示やプロンプトに対する追従能力の向上を目指しました。
+
+*   **ベースモデル:** google/gemma-3-4b-it
+*   **トレーニングフレームワーク:** Unsloth
+*   **データセット:** 合成データセット（プロンプト追従能力向上目的）
+*   **主な改善点:** プロンプトへの忠実性、指示実行能力
+
+## How to use
+
+このモデルは、以下の方法で使用できます。
+
+### 1. vLLMによる推論
+
+[vLLM](https://github.com/vllm-project/vllm) を使用すると、高速な推論が可能です。
+
+```python
+from vllm import LLM, SamplingParams
+
+# モデル名を指定 
+model_name = "DataPilot/ArrowMint-Gemma3-4B-ChocoMint-instruct-v0.1"
+# もしくはローカルパスを指定
+# model_name = "/path/to/your/local/model"
+
+llm = LLM(model=model_name, trust_remote_code=True) # Gemma-3では trust_remote_code=True が必要になる場合があります
+
+# プロンプトの準備 (Gemma-3のチャットテンプレート形式を推奨)
+# 例: <start_of_turn>user\n日本の首都はどこですか？<end_of_turn>\n<start_of_turn>model\n
+prompt = "<start_of_turn>user\nあなたの得意なことは何ですか？<end_of_turn>\n<start_of_turn>model\n"
+
+# サンプリングパラメータの設定
+sampling_params = SamplingParams(
+    temperature=0.1,
+    top_p=0.9,
+    max_tokens=100,
+    stop=["<end_of_turn>"] # 必要に応じて停止トークンを設定
+)
+
+# 推論の実行
+outputs = llm.generate(prompt, sampling_params)
+
+# 結果の表示
+for output in outputs:
+    prompt = output.prompt
+    generated_text = output.outputs[0].text
+    print(f"Prompt: {prompt!r}, Generated text: {generated_text!r}")
+
+```
+
+### 2. Transformersによる推論 (テキストのみ)
+
+Hugging Faceの `transformers` ライブラリを使用して推論を行う基本的なコードです。System Promptを設定することも可能です。
+
+```python
+import torch
+from transformers import AutoTokenizer, AutoModelForCausalLM, TextStreamer
+
+# モデル名を指定 
+model_name = "DataPilot/ArrowMint-Gemma3-4B-ChocoMint-instruct-v0.1"
+
+model = AutoModelForCausalLM.from_pretrained(
+    model_name,
+    torch_dtype=torch.bfloat16, # または torch.float16
+    device_map="auto",
+    trust_remote_code=True # Gemma-3モデルによっては必要
+)
+tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
+
+# プロンプトの準備 (System PromptとUser Prompt)
+system_prompt = "あなたは親切で正直なアシスタントです。"
+user_prompt = "自己紹介をしてください。"
+
+# Gemma-3のチャットテンプレートを適用
+messages = [
+    {"role": "system", "content": system_prompt},
+    {"role": "user", "content": user_prompt},
+]
+
+# apply_chat_template を使用 (推奨)
+input_text = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+
+input_ids = tokenizer(input_text, return_tensors="pt").to(model.device)
+
+# ストリーミング出力用の設定
+streamer = TextStreamer(tokenizer, skip_prompt=True, skip_special_tokens=True)
+
+# 推論の実行
+output_ids = model.generate(
+    **input_ids,
+    max_new_tokens=256,
+    temperature=0.7,
+    top_p=0.9,
+    do_sample=True,
+    streamer=streamer,
+    pad_token_id=tokenizer.eos_token_id, # pad_token_idを設定
+    eos_token_id=tokenizer.eos_token_id # eos_token_idを明示的に設定
+)
+
+# ストリーミングしない場合
+# output_ids = model.generate(
+#     **input_ids,
+#     max_new_tokens=256,
+#     temperature=0.7,
+#     top_p=0.9,
+#     do_sample=True,
+#     pad_token_id=tokenizer.eos_token_id,
+#     eos_token_id=tokenizer.eos_token_id
+# )
+# generated_text = tokenizer.decode(output_ids[0][input_ids["input_ids"].shape[1]:], skip_special_tokens=True)
+# print(generated_text)
+
+```
+
+
+## License
+
+このモデルは、ベースモデルである `google/gemma-3-4b-it` のライセンス条件に基づいて提供されます。
+`google/gemma-3-4b-it` のライセンスは [Gemma Terms of Use](https://ai.google.dev/gemma/terms) に従います。
+
+このモデルの使用にあたっては、ベースモデルのライセンスおよび利用規約を遵守してください。