Create README.md

README.md

@@ -1,3 +1,47 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+language:
+- ja
+tags:
+- rag
+- gnn
+---
+# GNN-RAG モデルデータリポジトリ
+
+このリポジトリは、論文「GNN-RAG: Graph Neural Retrieval for Large Language Model Reasoning」のトレーニング済みモデルデータを提供します。
+
+## モデルについて
+
+GNN-RAGは、Large Language Models (LLMs) の言語理解能力とGraph Neural Networks (GNNs) の推論能力を組み合わせた、Retrieval-Augmented Generation (RAG) スタイルの新しい手法です。このモデルは、Knowledge Graph (KG) 上の質問応答 (KGQA) タスクにおいて、最先端の性能を達成しています。
+
+## リポジトリ構成
+
+このリポジトリには、以下のモデルデータが含まれています。
+
+- WebQSP用のGNNモデル
+- CWQ用のGNNモデル
+
+## 使用方法
+
+1. このリポジトリをクローンまたはダウンロードしてください。
+2. 必要なモデルデータを`GNN-RAG/llm/results/gnn/`の対応するフォルダに移動し、`test.info`という名前に変更してください。
+3. 論文の元のリポジトリにある評価用のスクリプトを使用して、モデルを評価することができます。
+
+例えば、WebQSPの評価を行うには、以下のコマンドを実行します。
+
+```
+python main.py ReaRev --entity_dim 50 --num_epoch 200 --batch_size 8 --eval_every 2 --data_folder data/webqsp/ --lm sbert --num_iter 3 --num_ins 2 --num_gnn 3 --relation_word_emb True --load_experiment ReaRev_webqsp.ckpt --is_eval --name webqsp
+```
+
+## 注意事項
+
+- このリポジトリは、トレーニング済みのモデルデータのみを提供しています。完全なコードや追加のデータセットについては、元の論文のリポジトリを参照してください。
+- モデルの使用にあたっては、元の論文を引用し、適切なクレジットを付与してください。
+
+## 引用
+
+GNN-RAGモデルの詳細については、以下の論文を参照してください。
+
+```
+Costas Mavromatis, George Karypis. "GNN-RAG: Graph Neural Retrieval for Large Language Model Reasoning" 2023.
+```