Merge pull request #21 from Sunwood-ai-labs/update-readme-12026815920

README.md

@@ -44,7 +44,7 @@ license: mit
 
 ## 🚀 プロジェクト概要
 
-**Llama-finetune-sandbox**は、Llamaモデルのファインチューニングを実験的に学習・検証できる環境です。様々なファインチューニング手法を試し、モデルのカスタマイズや性能評価を行うことができます。初学者から研究者まで、幅広いユーザーのニーズに対応します。バージョン0.5.0では、ドキュメントの更新とコンテキストアウェアリフレクティブQA生成システムの追加を行いました。このシステムは、Wikipediaデータから高品質なQ&Aデータセットを生成し、LLMを活用して質問と回答の品質を段階的に向上させることで、より精度の高いデータセットを作成することを可能にします。
+**Llama-finetune-sandbox**は、Llamaモデルのファインチューニングを実験的に学習・検証できる環境です。様々なファインチューニング手法を試し、モデルのカスタマイズや性能評価を行うことができます。初学者から研究者まで、幅広いユーザーのニーズに対応します。バージョン0.6.0では、ドキュメントの更新とLLM評価システムの実装を行いました。このシステムは、LLMの回答品質を自動的に評価し、詳細な評価レポートを生成する機能を提供します。
 
 
 ## ✨ 主な機能
@@ -70,6 +70,21 @@ license: mit
     - `litellm`, `wikipedia`, `transformers`などのライブラリを使用しています。
     - 出力されたQ&AペアはJSON形式で保存され、Hugging Face Hubへのアップロードも容易に行えます。
 
+5. **LLM評価システム**:
+    - LLMの回答品質を自動的に評価するシステムです。
+    - 質問、模範解答、LLMの回答を4段階で評価し、詳細な評価レポートを生成します。
+    - エラーハンドリング、リトライ機能、ログ機能、カスタマイズ可能な評価基準、CSVとHTML形式でのレポート生成機能を備えています。
+    - HuggingFace Hubへのアップロード機能も備えています。
+
+
+## 🔧 使用方法
+
+本リポジトリ内のノートブックを参照してください。
+
+## 📦 インストール手順
+
+`requirements.txt`を参照し、必要なパッケージをインストールしてください。
+
 
 ## 📚 実装例
 
@@ -109,20 +124,12 @@ license: mit
   - → 詳細は [`LLMs_as_a_Judge_TOHO_V2.md`](sandbox/LLMs_as_a_Judge_TOHO_V2.md) をご参照ください。
 - [📒ノートブックはこちら](https://colab.research.google.com/drive/1Zjw3sOMa2v5RFD8dFfxMZ4NDGFoQOL7s?usp=sharing)
 
-## 🛠️ 環境構築
 
-1. リポジトリのクローン:
-```bash
-git clone https://github.com/Sunwood-ai-labs/Llama-finetune-sandbox.git
-cd Llama-finetune-sandbox
-```
+## 🆕 最新情報 (v0.6.0)
 
-## 📝 実験例の追加方法
+- **LLM評価システムの実装**: LLMの回答品質を自動的に評価するシステムを追加しました。質問、模範解答、LLMの回答を比較し、4段階のスケールで評価します。エラーハンドリング、リトライ機能、ログ機能、カスタマイズ可能な評価基準、CSVとHTML形式でのレポート生成機能を備えています。
+- README.mdへのLLM評価システムに関する情報の追加
 
-1. `sandbox/`ディレクトリに新しい実装を追加
-2. 必要な設定やユーティリティを`utils/`に追加 (存在しないため記述を削除)
-3. ドキュメントとテストを更新 (存在しないため記述を削除)
-4. プルリクエストを作成
 
 ## 🤝 コントリビューション
 
@@ -131,22 +138,6 @@ cd Llama-finetune-sandbox
 - ドキュメントの改善
 - 使用例の追加
 
-## 📚 参考資料
-
-- [HuggingFace PEFT ドキュメント](https://huggingface.co/docs/peft)
-- [Llama モデルについて](https://github.com/facebookresearch/llama)
-- [ファインチューニングのベストプラクティス](https://github.com/Sunwood-ai-labs/Llama-finetune-sandbox/wiki) (存在しないため記述を削除)
-
 ## 📄 ライセンス
 
-このプロジェクトはMITライセンスの下で公開されています。
-
-```
-```
-
-## v0.5.0 での更新
-
-**🆕 最新情報:**
-
-- コンテキストアウェアリフレクティブQA生成システムの実装
-- README.mdへの関連情報の追加
+このプロジェクトはMITライセンスの下で公開されています。