Update README.md

README.md

@@ -1,3 +1,73 @@
----
-license: mit
----
+---
+license: mit
+language:
+- ja
+base_model:
+- sbintuitions/sarashina2.2-3b-instruct-v0.1
+---
+# DataPilot/sarashina2.2-3Bx8-moe
+
+**DataPilot/sarashina2.2-3Bx8-moe** は、[sbintuitions/sarashina2.2-3b-instruct-v0.1](https://huggingface.co/sbintuitions/sarashina2.2-3b-instruct-v0.1)をベースに、mergekit-moeを用いて8つの専門モデルを統合したMixture of Experts（MoE）型の言語モデルです。各専門モデルが持つ強みを活用し、シングルモデルを超えた多彩で柔軟な応答生成が可能です。
+
+## 特徴
+
+- **Mixture of Experts (MoE)**: 8つのモデルを統合し、各領域に特化した知識と能力を発揮。
+- **高品質な日本語応答生成**: インストラクション形式のプロンプトに適した優れた対話生成性能。
+- **簡単な導入と利用**: Hugging Face Transformersに対応した簡単な使用方法。
+
+## モデル構成
+
+- **ベースモデル**: [sbintuitions/sarashina2.2-3b-instruct-v0.1](https://huggingface.co/sbintuitions/sarashina2.2-3b-instruct-v0.1)
+- **構築方法**: [mergekit-moe](https://github.com/arcee-ai/mergekit/blob/main/docs/moe.md) を使用
+- **データ型**: bfloat16（効率と精度のバランスに優れる）
+
+## 使用例
+
+以下は本モデルを利用したテキスト生成の簡単な例です。
+
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline, set_seed
+
+# モデルのロード
+model_name = "DataPilot/sarashina2.2-3Bx8-moe"
+model = AutoModelForCausalLM.from_pretrained(model_name, torch_dtype=torch.bfloat16, device_map="auto")
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+chat_pipeline = pipeline("text-generation", model=model, tokenizer=tokenizer)
+set_seed(123)
+
+# ユーザー入力
+user_input = [{"role": "user", "content": "こんにちは。あなたの名前を教えて"}]
+
+# モデルからの応答生成
+responses = chat_pipeline(
+    user_input,
+    max_length=50,
+    do_sample=True,
+    num_return_sequences=3,
+)
+
+# 応答を表示
+for i, response in enumerate(responses, 1):
+    print(f"Response {i}: {response['generated_text']}")
+
+# 出力例:
+# Response 1: [{'role': 'user', 'content': 'こんにちは。あなたの名前を教えて'}, {'role': 'assistant', 'content': 'Sarashina2と言います。本日のご要件を教えて下さい。'}]
+# Response 2: [{'role': 'user', 'content': 'こんにちは。あなたの名前を教えて'}, {'role': 'assistant', 'content': 'こんにちは！私の名前はSarashina2です。今日はどうしましたか？'}]
+# Response 3: [{'role': 'user', 'content': 'こんにちは。あなたの名前を教えて'}, {'role': 'assistant', 'content': 'Sarashina2と言います。本日のご要件を教えて下さい。'}]
+```
+
+## 推奨環境と注意点
+
+- MoE構造のため、通常のモデルよりも多くのGPUメモリが必要です。
+- 推論にはbfloat16対応のハードウェアを推奨します。
+- ファインチューニングを行う場合は専門領域ごとのバランス調整に注意してください。
+
+## ライセンスとクレジット
+
+本モデルは[sbintuitions/sarashina2.2-3b-instruct-v0.1](https://huggingface.co/sbintuitions/sarashina2.2-3b-instruct-v0.1)を元に構築されています。元モデルのライセンス条件をご確認の上ご利用ください。また、モデル構築には [mergekit-moe](https://github.com/arcee-ai/mergekit/blob/main/docs/moe.md) を使用しています。
+
+## 参考リンク
+
+- [sbintuitions/sarashina2.2-3b-instruct-v0.1 (Hugging Face)](https://huggingface.co/sbintuitions/sarashina2.2-3b-instruct-v0.1)
+- [mergekit-moeドキュメント (GitHub)](https://github.com/arcee-ai/mergekit/blob/main/docs/moe.md)