b-nerf-from-scratch / README.md
cy0307's picture
Upload from Ropedia Academy
3cf3755 verified
|
Raw
History Blame Contribute Delete
4.28 kB
---
license: mit
tags:
- ropedia-academy
- advanced
- gpu
- todo
- embodied-ai
- track-d
---
# NeRF from scratch (tiny_nerf) 🚧 not trained yet
> Train a NeRF from scratch β€” runs on the GPU in minutes (too slow to CPU-train here).
**Status β€” documented recipe (placeholder).** A production-grade pipeline from **[Ropedia Academy](https://chaoyue0307.github.io/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](https://huggingface.co/spaces/cy0307/ropedia-demos)**.
## At a glance
| | |
|---|---|
| **Base model** | From scratch |
| **Task** | neural radiance field |
| **Training objective** | Volume-rendering photometric loss through a positional-encoded MLP. |
| **Track** | B Β· 3D & rendering |
| **Built on** | [self-contained PyTorch (bmild tiny_nerf data)](https://github.com/bmild/nerf) |
| **Notebook** | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ChaoYue0307/ropedia-academy/blob/main/notebooks/training/B_nerf_from_scratch.ipynb) |
| **Compute / storage / time** | GPU required β€” see the *Compute Β· storage Β· time* table in the notebook |
## Dataset
- **Source:** tiny_nerf (bmild) β€” a single Lego scene (106 views).
## 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 **PSNR (held-out views)** 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: **From scratch**.
## How to fill this repo
1. Open the [notebook in Colab](https://colab.research.google.com/github/ChaoYue0307/ropedia-academy/blob/main/notebooks/training/B_nerf_from_scratch.ipynb) β†’ **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** ([self-contained PyTorch (bmild tiny_nerf data)](https://github.com/bmild/nerf)) and **dataset** are each under their own licenses β€” check the upstream source before redistribution.
## Citation
```bibtex
@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:** Mildenhall et al., *NeRF*, ECCV 2020.
## Related assets
- πŸš€ **Live demos:** [https://huggingface.co/spaces/cy0307/ropedia-demos](https://huggingface.co/spaces/cy0307/ropedia-demos)
- πŸ€— **All models + collection:** [https://huggingface.co/cy0307](https://huggingface.co/cy0307)
- πŸ“š **Course & all labs:** [https://chaoyue0307.github.io/ropedia-academy/](https://chaoyue0307.github.io/ropedia-academy/) Β· [Labs tab](https://chaoyue0307.github.io/ropedia-academy/labs)
- πŸ’» **Source / notebooks:** [github.com/ChaoYue0307/ropedia-academy](https://github.com/ChaoYue0307/ropedia-academy)
- πŸ”— **Relates to tracks:** D
---
*Documented placeholder in the [Ropedia Academy](https://chaoyue0307.github.io/ropedia-academy/) collection β€” train it on a GPU to publish the real model. Contributions welcome on [GitHub](https://github.com/ChaoYue0307/ropedia-academy).*