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

Adds a jupyter notebook illustrating simple use cases #68

Merged
merged 6 commits into from
Jun 6, 2019

Conversation

bhavanajain
Copy link

@bhavanajain bhavanajain commented Jun 5, 2019

Motivation and Context

The habitat-sim-demo.ipynb notebook illustrates how to specify the simulator and agent configuration, 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

To illustrate the semantic annotations and masks, we need Matterport3D scenes. So this notebook can only be tested if the given Matterport3D scene is present in the data directory. I have made changes to the setup.cfg and added arguments to test notebooks. You can use pytest --ignore notebooks/habitat-sim-demo.ipynb to skip the notebook test.

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Jun 5, 2019
@bhavanajain bhavanajain closed this Jun 5, 2019
@bhavanajain bhavanajain reopened this Jun 5, 2019
@mathfac
Copy link
Contributor

mathfac commented Jun 6, 2019

Maybe attaching print screen of the notebook will be useful for understanding. Thank you!

@erikwijmans
Copy link
Contributor

erikwijmans commented Jun 6, 2019

Copy link
Contributor

@mathfac mathfac left a comment

Choose a reason for hiding this comment

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

Looks great, let's merge it.

@mathfac mathfac merged commit 60a531c into master Jun 6, 2019
@erikwijmans erikwijmans deleted the example_notebook branch June 6, 2019 02:19
eundersander pushed a commit to eundersander/habitat-sim that referenced this pull request Aug 6, 2020
Clean old sensors absolute coordinates when agent's state change.
Ram81 pushed a commit to Ram81/habitat-web-sim that referenced this pull request Dec 10, 2020
…ch#68)

* Adds an ipython notebook illustrating simple use cases

* Display fewer frames

* Add notebooks test to setup.cfg

* circleci ignore notebooks
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