gfm-rag

(β˜… 289)

[NeurIPS'25, ICLR'26] Graph Foundation Model for Retrieval Augmented Generation

  • .env.example
  • .gitignore
  • .pre-commit-config.yaml
  • LICENSE
  • mkdocs.yml
  • mypy.ini
  • poetry.lock
  • pyproject.toml
  • pytest.ini
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/RManLuo/gfm-rag

Downloads the entire project code from GitHub to your computer.

cd gfm-rag

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install gfmrag

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install gfmrag

Installs the package published on PyPI directly β€” no need to clone the source.

python -m gfmrag.workflow.sft_training --config-path config/gfm_reasoner

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation