facebookresearch / habitat-sim

A flexible, high-performance 3D simulator for Embodied AI research.
https://aihabitat.org/
MIT License
2.45k stars 404 forks source link

--Add Configuration State Flags - Part 2 (Hidden file path fields) #2398

Closed jturner65 closed 1 month ago

jturner65 commented 1 month ago

Motivation and Context

This PR is the 2nd of 2 PRs started with this PR that add state-based support to ConfigValues. This PR is primarily concerned with implementing hidden/internal configuration fields intended to be used for data that is only locally relevant, such as fully-qualified file paths.

We do not want file names saved to json that embed absolute path data, so we need to keep a version of the path data that remains relative to the location of the JSON config file while we also want to have an easily consumed absolute path to the assets in question. Using the hidden field feature, paths can be saved in the configs as they are loaded, or otherwise relative to the dataset config directory, while they can be accessed internally fully qualified.

How Has This Been Tested

Local c++ and python tests pass

Types of changes

Checklist