README.md

---
license: apache-2.0
language:
- ja
tags:
- rag
- gnn
---

<p align="center">
<img src="https://huggingface.co/datasets/MakiAi/IconAssets/resolve/main/gnnrag2.jpeg" width="100%">
<br>
<h1 align="center">GNN-RAG</h1>
<h2 align="center">
  ～ Graph Neural Retrieval for Large Language Modeling Reasoning ～
<br>

<a href="https://github.com/Sunwood-ai-labs/GNN-RAG" title="Go to GitHub repo"><img src="https://img.shields.io/static/v1?label=GNN-RAG&message=Sunwood-ai-labs&color=blue&logo=github"></a>
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/Sunwood-ai-labs/GNN-RAG"><a href="https://github.com/Sunwood-ai-labs/GNN-RAG"><img alt="forks - Sunwood-ai-labs" src="https://img.shields.io/github/forks/GNN-RAG/Sunwood-ai-labs?style=social"></a>
<a href="https://github.com/Sunwood-ai-labs/GNN-RAG"><img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/Sunwood-ai-labs/GNN-RAG"></a><a href="https://github.com/Sunwood-ai-labs/GNN-RAG"><img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/Sunwood-ai-labs/GNN-RAG"></a>
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/Sunwood-ai-labs/GNN-RAG?color=red"><img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/Sunwood-ai-labs/GNN-RAG?sort=semver&color=orange">
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Sunwood-ai-labs/GNN-RAG/publish-to-pypi.yml"><br>

<a href="README.md"><img src="https://img.shields.io/badge/english-document-white.svg" alt="EN doc"></a><a href="README_JA.md"><img src="https://img.shields.io/badge/ドキュメント-日本語-white.svg" alt="JA doc"></a>

</h2>

</p>

# 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.
```