Adds an ipython notebook illustrating simple use cases #106
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
The
habitat-api-demo.ipynb
notebook illustrates how to specify config parameters, print semantic annotations of a scene. It also visualises the RGB, semantic and depth observations obtained by executing a random sequence of actions.TODO: Add a code block to walk along a shortest path and visualise observations along the way.
It's a beginner's tutorial :)
How Has This Been Tested
This has been tested using the
nbval
plugin in pytest with the --nbval-lax option. Details are intest/test_demo_notebook.py
. There is a conditional skip in case dataset or scenes are not present.Types of changes
Checklist