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

[BE] - remove Observation returns from simulator.py step and reset #2499

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

Conversation

aclegg3
Copy link
Contributor

@aclegg3 aclegg3 commented Nov 13, 2024

Motivation and Context

Refactors the simulator.py API to:

  • remove Observation return from step and reset. These are "environemt" API decisions. In general, stepping and resetting the world would not trigger any sensor collection or return.
  • removes the automated and forced disabling of rendering/textures when Sensors are not pre-declared. Configuration should not be assuming what the user wants and forcing itself. Provides freedom to declare sensors after initialization.
  • removes some deprecated and unused functions
  • adds some additional docstrings to clarify the initialization, resetting, and wrapping done in python over the binding API

How Has This Been Tested

CI should pass for sim.
Will fail for habitat-lab until refactored in-line with new reset and step API expectations.

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 Nov 13, 2024
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.

2 participants