Update README.md

README.md

@@ -2,75 +2,81 @@
 base_model: HuggingFaceTB/SmolLM2-360M-Instruct
 library_name: peft
 ---
-# SOAR Model Pipeline と 推論コード
+# SOAR Model with PEFT (Parameter-Efficient Fine-Tuning)
 
 ## 📌 概要
-このリポジトリには、SOAR（A Cognitive Architecture for General Intelligence）モデルを基にしたLoRA（Low-Rank Adaptation）微調整済みの言語モデルが含まれています。  
-このモデルは高校生による個人研究の一環として開発されており、十分な検証や最適化が行われている保証はありません。実験的なプロジェクトであるため、実用性や精度については慎重に評価してください。
+このドキュメントでは、SOARモデルにPEFT（パラメータ効率的ファインチューニング）を適用した実装方法を紹介します。PEFTは大規模な言語モデルを効率よく微調整するための手法で、SOARモデルにこの技術を適用することにより、少ないパラメータで効果的に適応させることができます。
+
+## 🚀 必要なライブラリ
+
+- **transformers**: Hugging Face Transformersライブラリ
+- **peft**: PEFT用のライブラリ
+
+以下のコマンドでライブラリをインストールします。
+
+```bash
+pip install transformers peft
+```
 
 ---
 
-## 🚀 パイプラインのセットアップ
+## 🔧 モデルの準備
 
-SOAR LoRAモデルを使うためのパイプラインを以下のコードでセットアップします。
+以下のコードを使用して、SOARモデルをPEFTを使ってロードします。
 
 ```python
 from peft import PeftModel
 from transformers import AutoModelForCausalLM
 
+# ベースモデルのロード
 base_model = AutoModelForCausalLM.from_pretrained("HuggingFaceTB/SmolLM2-360M-Instruct")
+
+# SOAR用のアダプターを適用
 model = PeftModel.from_pretrained(base_model, "summerstars/Soar_adapter")
 ```
 
+このコードは、Hugging Faceから事前訓練済みの`SmolLM2-360M-Instruct`をベースにし、`summerstars/Soar_adapter`というPEFTアダプターを適用するものです。
+
 ---
 
 ## 💬 推論の実行
 
-モデルにプロンプトを入力して、推論を行う方法は以下の通りです。
+モデルをロードした後、推論を実行するコードは以下の通りです。
 
 ```python
-def generate_text(pipeline, role, topic, max_length=200, temperature=0.7, top_p=0.95, top_k=50):
-    prompt = f"{role}: {topic}"
-    response = pipeline(prompt, max_length=max_length, temperature=temperature, top_p=top_p, top_k=top_k, do_sample=True)
+from transformers import pipeline
+
+# パイプラインの設定
+soar_pipeline = pipeline(
+    "text-generation",
+    model=model,
+    tokenizer=base_model.tokenizer  # ベースモデルのトークナイザーを使用
+)
+
+# 推論関数の定義
+def generate_soar_text(prompt, max_length=200, temperature=0.7, top_p=0.95, top_k=50):
+    response = soar_pipeline(prompt, max_length=max_length, temperature=temperature, top_p=top_p, top_k=top_k, do_sample=True)
     return response[0]["generated_text"]
 
-# 例: AIと人間の認知に関する分析
-soar_prompt = "Discuss the impact of AI on human cognition."
-
+# 例: 推論の実行
+soar_prompt = "What is the future of AI?"
 print("【SOAR Model Output】")
-print(generate_text(soar_pipeline, "SOAR Agent", soar_prompt))
-```
-
-### 推論例
-#### 入力:
-`Discuss the impact of AI on human cognition.`
-
-#### 出力（例）:
-```
-The future of artificial intelligence (AI) in the context of human cognition is a fascinating and complex subject. AI systems are increasingly capable of performing tasks that were once thought to be exclusively within the realm of human intelligence. In particular, AI has demonstrated remarkable progress in areas such as natural language processing (NLP), machine learning, and problem-solving.
-
-As AI continues to evolve, its potential to augment human cognitive capabilities will expand. By working alongside humans, AI can enhance our ability to process and analyze vast amounts of information, allowing us to make better decisions and solve complex problems more efficiently.
-
-AI also has the potential to change the way we understand and interpret human cognition itself. By studying how AI systems solve problems, we may gain insights into the workings of the human brain and the underlying mechanisms of intelligence.
+print(generate_soar_text(soar_prompt))
 ```
 
 ---
 
 ## ⚠ 免責事項
-このモデルは**高校生による個人研究**として開発されており、  
-専門的な研究機関による厳密な検証やチューニングが行われているわけではありません。  
-
-- **精度や汎用性に課題がある可能性があります。**
-- **科学的な正確性を保証するものではありません。**
-- **実際の応用に使用する場合は、十分に検証を行ってください。**
+- **このコードは研究目的で作成されたものであり、商用利用を意図し��いません。**
+- **PEFTを適用したモデルの最適化にはさらに調整が必要な場合があります。**
 
 ---
 
 ## 🧠 参考文献
-- Newell, A., & Simon, H. A. (1976). *Computer science as empirical inquiry: Symbols and search*. Communications of the ACM.
-- LoRA (Low-Rank Adaptation) 論文: Hu et al. (2021)
+- Laird, J. E. (2012). *The SOAR Cognitive Architecture*. MIT Press.
+- PEFT論文: *Parameter-Efficient Fine-Tuning* by Houlsby et al. (2019)
 
 ---
 
 ## 📜 ライセンス
-このモデルは `Apache 2.0` ライセンスのもとで公開されています。
+このプロジェクトは `Apache 2.0` ライセンスのもとで公開されています。