Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated DATASETS.md (semantic annotations in habitat-lab) #1984

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

rpartsey
Copy link
Collaborator

Motivation and Context

I'm not sure if loading semantic annotations in habitat-lab should be part of habitat-sim README.md, but if so, then it has to be updated to Hydra style.

Types of changes

  • [x ] Docs change / refactoring / dependency upgrade

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Jan 14, 2023
@rpartsey rpartsey changed the title Updated semantic annotations in habitat-lab Updated DATASETS.md (semantic annotations in habitat-lab) Jan 14, 2023
DATASETS.md Outdated
habitat:
simulator:
agents:
<agent_name>:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: it's not quite clear that this is an variable when listed as key like this. Is there a sensible defualt we can provide them. Or at least add comments to those things which need to be changed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Skylion007!
How about now?

@aclegg3
Copy link
Contributor

aclegg3 commented Jan 26, 2023

@rpartsey

not sure if loading semantic annotations in habitat-lab should be part of habitat-sim README.md

I agree we should think about how much cross-talk we have b/t lab and sim documentation. If users need to be told how to use datasets in Habitat-lab, maybe it makes more sense to have another DATASETS.md on that side instead of trying to cram it in here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants