LEANN

(★ 12,821)

[MLsys2026]: LEANN을 활용한 RAG on Everything. 개인 기기에서 빠르고 정확하며 100% 프라이버시가 보장되는 RAG 애플리케이션을 실행하는 동시에 97%의 스토리지 절감 효과를 누리세요.

  • .gitignore
  • .gitmodules
  • .pre-commit-config.yaml
  • .python-version
  • CLAUDE.md
  • demo.ipynb
  • LICENSE
  • llms.txt
  • pyproject.toml
  • README.md
  • uv.lock

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/StarTrail-org/LEANN

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd LEANN

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천
사전 준비물
  • Homebrew macOS/Linux용 패키지 매니저입니다.
  • Chocolatey Windows용 패키지 매니저입니다.
curl -LsSf https://astral.sh/uv/install.sh | sh

공식 설치 스크립트를 다운로드해서 바로 실행합니다. 이 한 줄로 필요한 게 자동으로 설치됩니다.

brew install libomp boost protobuf zeromq pkgconf

Homebrew로 이미 빌드된 패키지를 바로 설치합니다. 소스 빌드가 필요 없습니다.

choco install cmake swig pkgconfiglite nuget.commandline -y

Chocolatey로 바로 설치합니다 (Windows).

curl -fsSL https://ollama.ai/install.sh | sh

공식 설치 스크립트를 다운로드해서 바로 실행합니다. 이 한 줄로 필요한 게 자동으로 설치됩니다.

설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Docker

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker build -f docker/Dockerfile -t leann .

Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.

docker run -p 8080:80 leann

빌드된 이미지를 실제 컨테이너로 실행합니다.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

4. CMake

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • CMake 빌드 설정을 생성하는 도구입니다.
  • C/C++ 컴파일러 Windows는 Visual Studio(Community 무료), macOS는 Xcode Command Line Tools, Linux는 gcc/g++ 패키지가 필요합니다.
sudo pacman -Syu && sudo pacman -S --needed base-devel cmake pkgconf git gcc \

이 명령어를 터미널에 그대로 입력해 실행하세요.

choco install cmake swig pkgconfiglite nuget.commandline -y

Chocolatey로 바로 설치합니다 (Windows).

build 폴더 안에 실행 파일이 생성됐는지 확인하고, 직접 실행해보세요 (예: ./build/앱이름).

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

5. Python

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).
uv pip install leann

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

python -m apps.document_rag --query "What are the main techniques LEANN explores?"

파이썬 스크립트(또는 모듈)를 실행합니다.

python -m apps.document_rag --data-dir "~/Documents/Papers" --chunk-size 1024

파이썬 스크립트(또는 모듈)를 실행합니다.

python -m apps.document_rag --data-dir "./docs" --chunk-size 256 --file-types .md .py

파이썬 스크립트(또는 모듈)를 실행합니다.

python -m apps.document_rag --enable-code-chunking --data-dir "./my_project"

파이썬 스크립트(또는 모듈)를 실행합니다.

에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation