From ec2d54f627233e8c87b91c6eb762a026e7426146 Mon Sep 17 00:00:00 2001
From: "yohann.cabon" <yohann.cabon@naverlabs.com>
Date: Thu, 20 Aug 2020 14:41:15 +0200
Subject: [PATCH] updated readme

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index dbe009d..b3d0920 100644
--- a/README.md
+++ b/README.md
@@ -160,6 +160,34 @@ Each row of the text file should contain a single path to a given image:
 
 Alternatively, you can also use relative paths, and use `IMAGES_ROOT` to specify the root folder.
 
+## Feature extraction with kapture datasets
+
+Kapture is a pivot file format, based on text and binary files, used to describe SFM (Structure From Motion) and more generally sensor-acquired data.
+
+It is available at https://github.com/naver/kapture.
+It contains conversion tools for popular formats and several popular datasets are directly available in kapture.
+
+It can be installed with:
+```bash
+pip install kapture
+```
+
+Datasets can be downloaded with:
+```bash
+kapture_download_dataset.py update
+kapture_download_dataset.py list
+# e.g.: install mapping and query of Extended-CMU-Seasons_slice22
+kapture_download_dataset.py install "Extended-CMU-Seasons_slice22_*"
+```
+If you want to convert your own dataset into kapture, please find some examples [here](https://github.com/naver/kapture/blob/master/doc/datasets.adoc).
+
+Once installed, you can extract global features for your kapture dataset with:
+```bash
+cd $DIR_ROOT
+python dirtorch/extract_kapture.py --kapture-root pathto/yourkapturedataset --checkpoint dirtorch/data/Resnet101-AP-GeM-LM18.pt --gpu 0
+```
+
+Run `python dirtorch/extract_kapture.py --help` for more information on the extraction parameters. 
 
 ## Citations
 
-- 
GitLab