RAG — retrieval-augmented generation 🚧 not trained yet

Embed a corpus, retrieve with FAISS, and ground an LLM's answer in it.

Status — documented recipe (placeholder). A production-grade pipeline from Ropedia Academy for an advanced, GPU-heavy task. Everything below — base model, objective, dataset, config, the exact evaluation — is specified; the weights / metrics / figures land here automatically when you run the notebook on a GPU (one click below). Try the trained models live in the Ropedia demos Space.

At a glance

Dataset

• Source: Your document corpus (demo: 6 docs).

Training config

GPU-scale — the notebook ships a demo profile (free Colab T4) and a full profile, with an exact Compute · storage · time table. Hyperparameters (optimizer, steps, batch, LoRA rank, …) are in the training cell.

Evaluation results

⏳ Pending — run the notebook on a GPU to fill this in. This lab reports retrieval recall@k on a held-out split (see its Evaluate cell).

Inference example

No weights are published yet. After a GPU run, load the checkpoint/adapter the notebook saves (it also has a ready inference cell). Base model: BAAI/bge-small-en-v1.5 (embed) + Qwen2.5-0.5B-Instruct (gen).

How to fill this repo

1. Open the notebook in Colab → Runtime → GPU → Run all (runs the real pipeline).
2. Run its Publish to the Hugging Face Hub step (or HfApi().upload_folder(...)) — the checkpoint + metrics.json + figures replace this placeholder.

• Train / run on a GPU · [ ] upload weights · [ ] add metrics.json · [ ] add figures · [ ] swap in the real results card

Limitations

Not yet trained — no numbers to report. The pipeline is GPU-heavy (see the compute table); on free Colab use the demo-scale settings. This is an educational, reproducible recipe, not a tuned production release.

License

Code: MIT (this repository). The base model (sentence-transformers + FAISS) and dataset are each under their own licenses — check the upstream source before redistribution.

Citation

@misc{ropedia_academy,
  title  = {Ropedia Academy: an interactive course on embodied & spatial AI},
  author = {Ropedia Academy},
  year   = {2026},
  howpublished = {\url{https://chaoyue0307.github.io/ropedia-academy/}}
}

Method / original work: Lewis et al., RAG, NeurIPS 2020.

Related assets

• 🚀 Live demos: https://huggingface.co/spaces/cy0307/ropedia-demos
• 🤗 All models + collection: https://huggingface.co/cy0307
• 📚 Course & all labs: https://chaoyue0307.github.io/ropedia-academy/ · Labs tab
• 💻 Source / notebooks: github.com/ChaoYue0307/ropedia-academy
• 🔗 Relates to tracks: C · D

---

Documented placeholder in the Ropedia Academy collection — train it on a GPU to publish the real model. Contributions welcome on GitHub.