Update README.md
Browse files
README.md
CHANGED
@@ -6,3 +6,23 @@ license: odbl
|
|
6 |
|
7 |
This dataset is a modified version of the NCLT Dataset, which is licensed under the Open Database License (ODbL) v1.0.
|
8 |
As required by the license, this modified version is also released under the ODbL v1.0. You must attribute the original source and share any further modifications under the same license.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
6 |
|
7 |
This dataset is a modified version of the NCLT Dataset, which is licensed under the Open Database License (ODbL) v1.0.
|
8 |
As required by the license, this modified version is also released under the ODbL v1.0. You must attribute the original source and share any further modifications under the same license.
|
9 |
+
|
10 |
+
---
|
11 |
+
|
12 |
+
# ❗ Please note
|
13 |
+
|
14 |
+
**This dataset is currently not compatible with the `datasets` library.**
|
15 |
+
The recommended way to download the data is by using the `huggingface_hub` library.
|
16 |
+
Example code snippet:
|
17 |
+
|
18 |
+
```python
|
19 |
+
from pathlib import Path
|
20 |
+
from huggingface_hub import snapshot_download
|
21 |
+
|
22 |
+
out_dir = Path("/dir/to/save/data")
|
23 |
+
out_dir.mkdir(parents=True, exist_ok=True)
|
24 |
+
|
25 |
+
snapshot_download(repo_id="OPR-Project/OxfordRobotCar_OpenPlaceRecognition", repo_type="dataset", local_dir=out_dir)
|
26 |
+
```
|
27 |
+
|
28 |
+
For reading and working with the data, we recommend using the OpenPlaceRecognition library: https://github.com/OPR-Project/OpenPlaceRecognition
|