WAboutme commited on
Commit
b41dcce
Β·
verified Β·
1 Parent(s): f24845b

πŸ“š Document the processed training assets

Browse files

Add the canonical 50-scene layout, download command, reset-sampling semantics, and current asset availability to the dataset card.

Files changed (1) hide show
  1. README.md +52 -5
README.md CHANGED
@@ -11,9 +11,9 @@ tags:
11
 
12
  # 🧭 NavOL artifacts
13
 
14
- This dataset repository contains the checkpoints and benchmark data used by
15
- NavOL. Source code and executable data tools are maintained at
16
- <https://github.com/WAboutMe/NavOL>.
17
 
18
  ## 🧠 Checkpoints
19
 
@@ -27,6 +27,32 @@ NavOL. Source code and executable data tools are maintained at
27
  The filenames retain their training mode and iteration and should not be
28
  treated as interchangeable copies of one generic checkpoint.
29
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
  ## πŸ—ΊοΈ Benchmark data
31
 
32
  | Split | Processed archive | Raw archive |
@@ -54,6 +80,15 @@ hf download WAboutme/NavOL \
54
  --local-dir assets
55
  ```
56
 
 
 
 
 
 
 
 
 
 
57
  Download the benchmark archives:
58
 
59
  ```bash
@@ -70,10 +105,22 @@ NavOL resolves the default checkpoint at:
70
  assets/models/checkpoints/navol-mpc-iter1000.pt
71
  ```
72
 
 
 
 
 
 
 
 
 
 
 
 
73
  ## πŸ“„ License
74
 
75
  NavOL-authored source and configuration files use the BSD 3-Clause License.
76
- Checkpoints, benchmark scenes, textures, and other third-party-derived
77
- artifacts retain the terms of their respective upstream sources. The dataset
 
78
  repository therefore uses `license: other`. See [LICENSE.md](LICENSE.md) and
79
  [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
 
11
 
12
  # 🧭 NavOL artifacts
13
 
14
+ This dataset repository contains the checkpoints, processed 50-scene training
15
+ asset, and benchmark data used by NavOL. Source code and executable data tools
16
+ are maintained at <https://github.com/WAboutMe/NavOL>.
17
 
18
  ## 🧠 Checkpoints
19
 
 
27
  The filenames retain their training mode and iteration and should not be
28
  treated as interchangeable copies of one generic checkpoint.
29
 
30
+ ## πŸ‹οΈ Processed training data
31
+
32
+ The canonical processed training asset is stored at:
33
+
34
+ ```text
35
+ datasets/train/3d_front_scene_50/
36
+ β”œβ”€β”€ index.json
37
+ β”œβ”€β”€ selected.json
38
+ β”œβ”€β”€ scene.glb
39
+ β”œβ”€β”€ usd/
40
+ β”‚ β”œβ”€β”€ config.yaml
41
+ β”‚ β”œβ”€β”€ scene.usd
42
+ β”‚ └── textures/
43
+ └── navmesh_scenes/scene_*.glb
44
+ ```
45
+
46
+ `selected.json` records the 50-scene selection. The merged `scene.usd` and its
47
+ textures are loaded by Isaac Sim, while the 50 per-scene GLBs under
48
+ `navmesh_scenes/` are used by Habitat-Sim planning. `scene.glb` is retained as
49
+ a portable reconstruction source, and `usd/config.yaml` is an informational,
50
+ path-sanitized conversion record rather than a training input.
51
+
52
+ The training asset intentionally does not include `sample_100.npy`. Canonical
53
+ random training uses `sample_from_npy=False`; a fixed reset array is needed
54
+ only when that option is explicitly enabled.
55
+
56
  ## πŸ—ΊοΈ Benchmark data
57
 
58
  | Split | Processed archive | Raw archive |
 
80
  --local-dir assets
81
  ```
82
 
83
+ Download the processed training asset into a NavOL asset root:
84
+
85
+ ```bash
86
+ hf download WAboutme/NavOL \
87
+ --repo-type dataset \
88
+ --include "datasets/train/3d_front_scene_50/**" \
89
+ --local-dir assets
90
+ ```
91
+
92
  Download the benchmark archives:
93
 
94
  ```bash
 
105
  assets/models/checkpoints/navol-mpc-iter1000.pt
106
  ```
107
 
108
+ The training download resolves to:
109
+
110
+ ```text
111
+ assets/datasets/train/3d_front_scene_50/
112
+ ```
113
+
114
+ This repository does **not** currently distribute the NavDP initialization
115
+ checkpoint `models/navdp-cross-modal.ckpt` or the robot asset
116
+ `robots/dingo.usd`. Obtain both under their respective upstream terms and
117
+ place them in the documented asset layout before training.
118
+
119
  ## πŸ“„ License
120
 
121
  NavOL-authored source and configuration files use the BSD 3-Clause License.
122
+ Checkpoints, training and benchmark scenes, textures, and other
123
+ third-party-derived artifacts retain the terms of their respective upstream
124
+ sources. The dataset
125
  repository therefore uses `license: other`. See [LICENSE.md](LICENSE.md) and
126
  [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).