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 support for ISystemReset in test fixture #2647

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

Conversation

arjo129
Copy link
Contributor

@arjo129 arjo129 commented Oct 11, 2024

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

🎉 New feature

Closes #

Summary

This PR adds support for the Reset API to the test fixture. As TestFixture is one of the main ways one can get access to the ECM in python when trying to write some scripts for Deep Reinforcement Learning I realized that without Reset supported in the TestFixture API, end users would have a very hard time using our python APIs (which are actually quite nice). For reference I'm hacking a demo template here (its still barebones):

https://github.com/arjo129/gz_deep_rl_experiments/tree/ionic

Test it

I've added a test in #2648, but that includes some additional APIs to improve usability.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

This PR adds support for the Reset API to the test fixture. As `TestFixture`
is one of the main ways one can get access to the ECM in python
when trying to write some scripts for Deep Reinforcement Learning I
realized that without `Reset` supported in the `TestFixture` API, end
users would have a very hard time using our python APIs (which are
actually quite nice). For reference I'm hacking a demo template here:

https://github.com/arjo129/gz_deep_rl_experiments/tree/ionic

Signed-off-by: Arjo Chakravarty <[email protected]>
@github-actions github-actions bot added the 🏛️ ionic Gazebo Ionic label Oct 11, 2024
arjo129 added a commit that referenced this pull request Oct 11, 2024
This allows us to reset simulations without having to call into
gz-transport making the code more readable from an external API.
Depends on #2647

Signed-off-by: Arjo Chakravarty <[email protected]>
@arjo129 arjo129 changed the title Adds support for Reset in test fixture Adds support for ISystemReset in test fixture Oct 11, 2024
return *this;
}


Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change

Signed-off-by: Arjo Chakravarty <[email protected]>
@arjo129
Copy link
Contributor Author

arjo129 commented Oct 11, 2024

Upon further examination I think this may break ABI cause we are adding a base class. I probably should port this to Gazebo J.

}
),
pybind11::return_value_policy::reference,
"Wrapper around a system's post-update callback"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"Wrapper around a system's post-update callback"
"Wrapper around a system's reset callback"

@@ -96,6 +96,12 @@ class GZ_SIM_VISIBLE TestFixture
public: TestFixture &OnPostUpdate(std::function<void(
const UpdateInfo &, const EntityComponentManager &)> _cb);

/// \brief Wrapper around a system's update callback
/// \param[in] _cb Function to be called every update
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// \param[in] _cb Function to be called every update
/// \param[in] _cb Function to be called every reset

@arjo129 arjo129 changed the base branch from gz-sim9 to main November 1, 2024 03:56
@arjo129 arjo129 added 🪵 jetty Gazebo Jetty and removed 🏛️ ionic Gazebo Ionic labels Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🪵 jetty Gazebo Jetty
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

3 participants