Add task_categories, code link, and sample usage

#2
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +20 -6
README.md CHANGED
@@ -1,11 +1,13 @@
1
  ---
2
  license: mit
3
  pretty_name: Neverwhere
 
 
4
  tags:
5
- - robotics
6
- - legged-locomotion
7
- - gaussian-splatting
8
- - benchmark
9
  ---
10
 
11
  # The Neverwhere Visual Parkour Benchmark Suite
@@ -14,7 +16,7 @@ tags:
14
 
15
  Scenes for the [Neverwhere](https://github.com/ziyc/neverwhere) simulator: real-world hurdles, gaps, ramps and
16
  stairs reconstructed as 3D Gaussian Splats with aligned collision meshes for MuJoCo.
17
- Paper: https://arxiv.org/abs/2609.16443 · Project page: https://ziyc.github.io/neverwhere-bench/
18
 
19
  ## Layout
20
 
@@ -49,6 +51,18 @@ python download.py --checkpoints
49
 
50
  or `hf_hub_download("ziyc/neverwhere", "scenes/hurdle_stata_v1.zip", repo_type="dataset")`.
51
 
 
 
 
 
 
 
 
 
 
 
 
 
52
  ## Citation
53
 
54
  ```bibtex
@@ -60,4 +74,4 @@ or `hf_hub_download("ziyc/neverwhere", "scenes/hurdle_stata_v1.zip", repo_type="
60
  booktitle = {IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
61
  year = {2026},
62
  }
63
- ```
 
1
  ---
2
  license: mit
3
  pretty_name: Neverwhere
4
+ task_categories:
5
+ - robotics
6
  tags:
7
+ - robotics
8
+ - legged-locomotion
9
+ - gaussian-splatting
10
+ - benchmark
11
  ---
12
 
13
  # The Neverwhere Visual Parkour Benchmark Suite
 
16
 
17
  Scenes for the [Neverwhere](https://github.com/ziyc/neverwhere) simulator: real-world hurdles, gaps, ramps and
18
  stairs reconstructed as 3D Gaussian Splats with aligned collision meshes for MuJoCo.
19
+ Paper: https://arxiv.org/abs/2609.16443 · Project page: https://ziyc.github.io/neverwhere-bench/ · Code: https://github.com/ziyc/neverwhere
20
 
21
  ## Layout
22
 
 
51
 
52
  or `hf_hub_download("ziyc/neverwhere", "scenes/hurdle_stata_v1.zip", repo_type="dataset")`.
53
 
54
+ ## Sample usage
55
+
56
+ ```python
57
+ import neverwhere
58
+
59
+ env = neverwhere.make("Neverwhere-go1-transformer_vision_splat-hurdle_stata_v1-cones", device="cuda", random=0)
60
+ obs = env.reset()
61
+ obs, reward, done, info = env.step(env.action_space.sample())
62
+ info["splat_rgb"] # 3DGS ego render, uint8 HxWx3
63
+ env.unwrapped.env.task.get_metrics() # frac_goals_reached, x_displacement
64
+ ```
65
+
66
  ## Citation
67
 
68
  ```bibtex
 
74
  booktitle = {IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS)},
75
  year = {2026},
76
  }
77
+ ```