Update HITL readmes. (facebookresearch#2139)

Author: 0mdc

examples/hitl/basic_viewer/README.md

@@ -7,13 +7,10 @@ Inspect Habitat environments, episodes, and agent policy evaluation in real time
 ## Installing and using HITL apps
 See [habitat-hitl/README.md](../../../habitat-hitl/README.md)
 
-## To run
-cd path/to/habitat-lab # Or wherever data/ is symlinked
-
 ## Example launch command
+Run the following command from the root `habitat-lab` directory:
 
 ```bash
-HABITAT_SIM_LOG=warning MAGNUM_LOG=warning \
 python examples/hitl/basic_viewer/basic_viewer.py habitat_hitl.episodes_filter='0 2 4 10:15 1000:4000:500'
 ```
 

examples/hitl/minimal/README.md

@@ -1,7 +1,11 @@
 # Minimal HITL application
 
-A minimal HITL app that loads and steps a Habitat environment, with a fixed overhead camera. See [`habitat_hitl/README.md`](../../../habitat-hitl/README.md#minimal-hitl-application)
+A minimal application that loads and steps a Habitat environment, with a fixed overhead camera. See [`habitat_hitl/README.md`](../../../habitat-hitl/README.md#minimal-hitl-application)
 
-# To run
+# Example launch command
 
-cd path/to/habitat-lab # Or wherever data/ is symlinked
+Run the following command from the root `habitat-lab` directory:
+
+```bash
+python examples/hitl/minimal/minimal.py'
+```

examples/hitl/pick_throw_vr/README.md

@@ -38,7 +38,6 @@ See [habitat-hitl/README.md](../../../habitat-hitl/README.md).
 ## Example launch command (mouse/keyboard)
 
 ```bash
-HABITAT_SIM_LOG=warning MAGNUM_LOG=warning \
 python examples/hitl/pick_throw_vr/pick_throw_vr.py
 ```
 
@@ -80,9 +79,7 @@ The standard keyboard-mouse launch command-line arguments can be used with those
 * The `habitat_hitl.networking.enable=True` config override launches the Pick_throw_vr app as a server, allowing a remote client (e.g. VR headset) to connect and control the human avatar.
 
 ```bash
-HABITAT_SIM_LOG=warning MAGNUM_LOG=warning \
-python examples/hitl/pick_throw_vr/pick_throw_vr.py \
-habitat_hitl.networking.enable=True
+python examples/hitl/pick_throw_vr/pick_throw_vr.py habitat_hitl.networking.enable=True
 ```
 
 We also have an experimental headless server:

examples/hitl/rearrange/README.md

@@ -12,7 +12,6 @@ See [habitat-hitl/README.md](../../../habitat-hitl/README.md).
 ## Example launch command
 
 ```bash
-HABITAT_SIM_LOG=warning MAGNUM_LOG=warning \
 python examples/hitl/rearrange/rearrange.py
 ```
 

examples/hitl/rearrange_v2/README.md

@@ -1,64 +1,6 @@
 # Rearrange_v2 HITL application
 
-SIRo's 2024H1 data-collection app. Work in progress.
+Experimental application for evaluating rearrangement experiments using [partnr-planner](https://github.com/facebookresearch/partnr-planner).
+Supports single-user, multi-user and user-agent settings.
 
-## Installation
-See [habitat-hitl/README.md](../../../habitat-hitl/README.md).
-
-In addition to the core HITL data above, you need the private [fphab](https://huggingface.co/datasets/fpss/fphab) repo. Reach out to the SIRo team for access.
-```
-cd path/to/habitat-lab/data
-git clone --branch articulated-scenes --single-branch --depth 1 https://huggingface.co/datasets/fpss/fphab
-mv fphab fpss
-```
-
-To test the Habitat-LLM episodes in `rearrange_v2` you'll need to download and unzip the following [episode dataset](https://drive.google.com/file/d/1zFCBiWE_XFY0Ry9CZOV_NF_rfxBw1y-F/view?usp=sharing) in Habitat-Lab root directory. In addition, you'll need YCB, GSO, AI2THOR, and ABO object assets. To download these assets use the following commands:
-
-```
-cd data
-git clone https://huggingface.co/datasets/ai-habitat/OVMM_objects objects --recursive
-cd objects
-git checkout 3893a735352b92d46505f35d759553f5fc82a39b
-```
-
-## Data directory
-
-Run `rearrange_v2` from the Habitat-lab root directory. It will expect `data/` for Habitat-lab data, and it will also look for `examples/hitl/rearrange_v2/app_data/demo.json.gz` (included alongside source files in our git repo).
-
-## Example launch commands
-
-Local testing (local display and keyboard control):
-```bash
-python examples/hitl/rearrange_v2/rearrange_v2.py
-```
-
-Headed server (includes local display and keyboard control):
-```bash
-python examples/hitl/rearrange_v2/rearrange_v2.py habitat_hitl.networking.enable=True
-```
-
-Headless server:
-```bash
-python examples/hitl/rearrange_v2/rearrange_v2.py +experiment=headless_server
-```
-
-To test Habitat-LLM episodes using a user-controlled humanoid use:
-```bash
-python examples/hitl/rearrange_v2/rearrange_v2.py --config-name lang_rearrange_humanoid_only
-```
-
-## Controls
-See on-screen help text. In addition, press `1` or `2` to select an episode.
-
-## Configuration
-See `config/rearrange_v2.yaml` and `config/experiment/headless_server.yaml`.
-
-## Browser client
-
-`rearrange_v2` has additional requirements for the [Unity VR client](../pick_throw_vr/README.md#vr).
-* Beware these instructions are a work in progress!
-* It is designed for use with a desktop browser-based (not VR) version of the Unity client.
-* Use the [`webgl-demo`](https://github.com/eundersander/siro_hitl_unity_client/tree/webgl-demo) branch.
-* Download Unity data folder (`data.zip`) from: https://drive.google.com/drive/folders/12VLJGf5_ntr5nztZn1KjzyzBG_UKDPme
-* Extract `data.zip` to Unity client's `Assets/Resources/data`.
-* Open and run the `PlayerMouseKeyboard` scene.
+Work-in-progress. Please check back later for updates.