Update README to v0.3.0

README.md

@@ -37,16 +37,35 @@ See [this repository](https://huggingface.co/datasets/hssd/hssd-models) for corr
 │   ├── *.scene_instance.json
 ├── scenes_uncluttered
 │   ├── *.scene_instance.json
+├── scenes_articulated
+│   ├── *.scene_instance.json
 ├── scene_filter_files
 │   ├── *.rec_filter.json
+├── metadata
+│   ├── *.csv
+│   ├── *.json
+├── semantics
+│   ├── hssd-hab_semantic_lexicon.json
+│   ├── scenes
+|      ├── *.semantic_config.json
+├── urdf
+│   ├── <model_name>
+|      ├── *.glb
+|      ├── *.urdf
+|      ├── *.ao_config.json
 └── hssd-hab.scene_dataset_config.json
 └── hssd-hab-uncluttered.scene_dataset_config.json
+└── hssd-hab-articulated.scene_dataset_config.json
 ```
 
 - `hssd-hab.scene_dataset_config.json`: This SceneDataset config file aggregates the assets and metadata necessary to fully describe the set of stages, objects, and scenes constituting the dataset.
 - `objects`: 3D models representing distinct objects that are used to compose scenes. Contains configuration files, render assets, collider assets, and Receptacle mesh assets.
 - `stages`: A stage in Habitat is the set of static mesh components which make up the backdrop of a scene (e.g. floor, walls, stairs, etc.).
 - `scenes`: A scene is a single 3D world composed of a static stage and a variable number of objects.
+- `scene_filter_files`: These .rec_filter.json files contain mappings of Receptacle instance unique_names to active or filtered sets based on their locations and accessibility within the scene. They also contain a "within_set" defining Receptacles which can only be accessed when the parent Furniture object's "default_link" is in the "open" state.
+- `metadata`: The metadata directory contains several csv and json files which provide semantic mappings for objects in the dataset as well as rational mappings from regions to the types of clutter objects typically found in them to support procedural generation.
+- `semantics`: Primarily defines instance semantics for the scenes. *.semantic_config.json files contain the region annotations for each scene.
+- `urdf`: The urdf directory contains the articulated furniture assets, each contained in its own sub-directory named after the source asset. The .urdf files define the articulation properties. Each .glb file is either a render asset or Receptacle mesh connected to a rigid link. The .ao_config.json file contains habitat-specific metadata such as markersets and Receptacle definitions.
 
 ### Rearrange-ready assets:
 Supporting Habitat 3.0 embodied rearrangement tasks with updated colliders, adjusted and de-cluttered scene contents, receptacle meshes, and receptacle filter files. See [aihabitat.org/habitat3/](aihabitat.org/habitat3/) for more details.
@@ -54,6 +73,15 @@ Supporting Habitat 3.0 embodied rearrangement tasks with updated colliders, adju
 - `scenes_uncluttered`: Contains the adjusted scene instance configuration files.
 - `scene_filter_files`: A scene filter file organizes available Receptacle instances in a scene into active and inactive groups based on simualtion heuristics and manual edits. It is consumed by the RearrangeEpisodeGenerator to construct valid RearrangeEpisodeDatasets.
 
+### Articulated scenes and assets:
+Introduced in `v0.3.0`, the `hssd-hab-articulated.scene_dataset_config.json` SceneDataset provides 202 fully articulated HSSD scenes ready for use within the AI Habitat simulation ecosystem. Note that only 161 are publicly available on this repo. The remainder and their unique assets are reserved as an internal test set.
+
+To enable more realistic indoor object manipulation, articulated 3D furniture models such as drawers, cabinets, and appliances were added to replace rigid assets. These models were converted from rigid source assets in HSSD and swapped into the scenes.
+
+Furniture is annotated with a set of Receptacles (surfaces which support small object placement such as shelves and drawers) and can be opened and closed by the agents. Receptacles are further filtered contextually in each scene to ensure that the active set is accessible to the agents.
+
+Additional annotations include point or marker sets for each furniture, region annotations, and semantic classification of objects.
+
 ## Getting Started
 
 To load HSSD scenes into the Habitat simulator, you can start by installing [habitat-sim](https://github.com/facebookresearch/habitat-sim) using instructions specified [here](https://github.com/facebookresearch/habitat-sim#installation).
@@ -71,6 +99,18 @@ Habitat-Sim is typically used with [Habitat-Lab](https://github.com/facebookrese
 To define embodied AI tasks (e.g. navigation, instruction following, question answering), train agents, and benchmark their performance using standard metrics, you can download habitat-lab using the instructions provided [here](https://github.com/facebookresearch/habitat-lab#installation).
 
 ## Changelog
+- `v0.3.0`: **Articulated Scenes and PARTNR support**
+   - This major version update adds a large set of changes to support the introduction of 202 articulated HSSD scenes and the [PARTNR benchmark](https://github.com/facebookresearch/partnr-planner).
+   - Includes improvements to stage texture/geometry and object collision shapes and receptacles.
+   - Adds:
+      -  2000+ articulated assets in the urdf/ directory representing and replacing rigid furniture objects. Annotated with Receptacles and semantics.
+      - 202 new articulated scenes with rigid objects replaced by AOs. These are uncluttered and often significantly altered from originals to accommodate the new assets.
+        - Note that test scenes and assets are removed before migration to this repo.
+      - Receptacle filter files for new scenes annotating accessible Receptacles and "within" Receptacles (those which require opening an articulated link for access).
+         - Note that only one link per AO is configured with an active Receptacle. This is based on logic in PARTNR and habitat-lab (default_link).
+      - Region volume semantic annotations to all scenes
+      - Semantic lexicon file with updated classes
+      - Metadata files mapping object semantics and common-sense object->region sets for PARTNR
  - `v0.2.5`: **Rearrange-ready HSSD**
    - Note: this is a checkpoint. Known issues exist and continued polish is ongoing.
    - Adds Receptacle meshes describing support surfaces for small objects (e.g. table or shelf surfaces).