Update README.md

README.md

@@ -1,3 +1,58 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-4.0
+---
+
+# FAINT
+
+Fast, Appearance-Invariant Navigation Transformer (FAINT) is a learned policy for vision-based topological navigation.
+
+Please see the [Project Page](https://lasuomela.github.io/faint/) for more information.
+
+## Model Details
+
+The `FAINT-Real` model uses [`Theia-Tiny-CDDSV`](https://theia.theaiinstitute.com/) as backbone, and was trained for 30 epochs with the ~1.2M samples of the datasets used in the GNM/ViNT papers.
+
+This repo contains two versions of the trained model weights.
+- `model_pytorch.pt`: Weights-only state dict of the Pytorch model.
+- `model_torchscript.pt`: A 'standalone' Torchscript model for deployment.
+
+## Usage
+
+See the main Github [repo](https://github.com/lasuomela/FAINT) for details, input preprocessing etc.
+
+### Torchscript
+
+Only dependency is Pytorch.
+
+```bash
+import torch
+ckpt_path = 'FAINT-Real/model_torchscript.pt'
+model = torch.jit.load(ckpt_path)
+```
+
+### Pytorch
+
+Need to have the Faint library installed.
+
+```bash
+import torch
+from faint.common.models.faint import FAINT
+
+ckpt_path = 'FAINT-Real/model_pytorch.pt'
+state_dict = torch.load(ckpt_path)
+
+model = FAINT() # The weights in this repo correspond to FAINT initialized with the default arguments
+model.load_state_dict(state_dict)
+```
+
+## Citation
+
+If you use FAINT in your research, please use the following BibTeX entry:
+```bibtex
+@article{Suomela_2025_Outperforming,
+  title={Outperforming Real-World Data for Training Vision-Based Navigation Policies},
+  author={Suomela, Lauri and Kuruppu Arachchige, Sasanka and Torres, German F. and Edelman, Harry and Kämäräinen, Joni-Kristian}
+  journal={arXiv:},
+  year={2025}
+}
+```