Files
riemann-flow-gnn/README.md

47 lines
1.5 KiB
Markdown

# riemann-flow-gnn
Riemannian Flow matching with GNN implementation in rust/burn
## Toy prototype skeleton (API-first)
이 저장소는 `R^3 x SO(3) x T^m` one-sample overfitting 실험을 위한 **API 계약 중심 스켈레톤**을 포함합니다.
내부 수학/시뮬레이션 로직은 의도적으로 최소화되어 있으며, TODO 지점부터 실험 코드를 채우는 구조입니다.
### 실행
```bash
cargo run --example toy_pipeline
```
### NVIDIA GPU 환경 점검
```bash
bash scripts/gpu_env_check.sh
```
점검 항목:
- `nvidia-smi` 드라이버/디바이스 인식
- `nvcc --version` CUDA toolkit 인식
- `scripts/gpu_smoke_test.py` CUDA matmul 런타임 실행
- `cargo check --example toy_pipeline` Burn 빌드 스모크 테스트
예제 학습 스켈레톤은 **기본으로 Burn CUDA JIT 백엔드(GPU)** 를 사용합니다. NVIDIA 드라이버와 CUDA 개발 환경(`nvcc` 등)이 필요합니다.
예제는 파이프라인 계약 확인용으로 동작합니다.
### 현재 포함 범위
- graph/domain struct (`Atom`, `Bond`, `TorsionEdge`, `LigandGraph`)
- one-sample entry API (`api::OneSampleToyPipeline`)
- graph/pose/simulator 최소 계약
- Burn tensor shape 중심 adapter skeleton (기본 활성)
- TODO 기반 구현 포인트 주석
### 이후 단계 권장
1. random init sampling 테스트
2. translation/rotation/torsion 단위 테스트 확장
3. GNN 모델 정의 및 입력 feature 고정
4. geodesic path/velocity supervision 연결
5. 학습 루프/실행 스크립트 추가
6. epoch별 trajectory 저장 자동화