Commit 799e0f98 authored by Mayank Mittal's avatar Mayank Mittal Committed by Mayank Mittal

Fixes location of images for task workflows (#1349)

This MR fixes the regression in #1337. The images were located in the
wrong directory. Please be careful.

P.S.: The images are very low in resolution, and they don't support the
dark theme. It would be great to include this as part of this MR to
avoid this issue.

- Bug fix (non-breaking change which fixes an issue)

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
parent f7350c72
...@@ -6,7 +6,7 @@ To see the full list of contributors, please check the revision history in the s ...@@ -6,7 +6,7 @@ To see the full list of contributors, please check the revision history in the s
Guidelines for modifications: Guidelines for modifications:
* Please keep the lists sorted alphabetically. * Please keep the **lists sorted alphabetically**.
* Names should be added to this file as: *individual names* or *organizations*. * Names should be added to this file as: *individual names* or *organizations*.
* E-mail addresses are tracked elsewhere to avoid spam. * E-mail addresses are tracked elsewhere to avoid spam.
...@@ -19,6 +19,7 @@ Guidelines for modifications: ...@@ -19,6 +19,7 @@ Guidelines for modifications:
--- ---
* Antonio Serrano-Muñoz
* David Hoeller * David Hoeller
* Farbod Farshidian * Farbod Farshidian
* Hunter Hansen * Hunter Hansen
...@@ -36,7 +37,6 @@ Guidelines for modifications: ...@@ -36,7 +37,6 @@ Guidelines for modifications:
* Amr Mousa * Amr Mousa
* Andrej Orsula * Andrej Orsula
* Anton Bjørndahl Mortensen * Anton Bjørndahl Mortensen
* Antonio Serrano-Muñoz
* Arjun Bhardwaj * Arjun Bhardwaj
* Brayden Zhang * Brayden Zhang
* Calvin Yu * Calvin Yu
...@@ -62,6 +62,7 @@ Guidelines for modifications: ...@@ -62,6 +62,7 @@ Guidelines for modifications:
* Michael Gussert * Michael Gussert
* Muhong Guo * Muhong Guo
* Nuralem Abizov * Nuralem Abizov
* Oyindamola Omotuyi
* Özhan Özen * Özhan Özen
* Qian Wan * Qian Wan
* Qinxi Yu * Qinxi Yu
......
This source diff could not be displayed because it is too large. You can view the blob instead.
This source diff could not be displayed because it is too large. You can view the blob instead.
This source diff could not be displayed because it is too large. You can view the blob instead.
This source diff could not be displayed because it is too large. You can view the blob instead.
...@@ -36,10 +36,6 @@ or when implementing complex logic that is difficult to decompose into separate ...@@ -36,10 +36,6 @@ or when implementing complex logic that is difficult to decompose into separate
Manager-Based Environments Manager-Based Environments
-------------------------- --------------------------
.. image:: ./Manager-basedTaskWorkflow.jpg
:width: 100%
:alt: Manager-based Task Workflow
A majority of environment implementations follow a similar structure. The environment processes the input actions, A majority of environment implementations follow a similar structure. The environment processes the input actions,
steps through the simulation, computes observations and reward signals, applies randomization, and resets the terminated steps through the simulation, computes observations and reward signals, applies randomization, and resets the terminated
environments. Motivated by this, the environment can be decomposed into individual components that handle each of these tasks. environments. Motivated by this, the environment can be decomposed into individual components that handle each of these tasks.
...@@ -47,6 +43,16 @@ For example, the observation manager is responsible for computing the observatio ...@@ -47,6 +43,16 @@ For example, the observation manager is responsible for computing the observatio
computing the rewards, and the termination manager is responsible for computing the termination signal. This approach computing the rewards, and the termination manager is responsible for computing the termination signal. This approach
is known as the manager-based environment design in the framework. is known as the manager-based environment design in the framework.
.. image:: ../../_static/task-workflows/manager-based-light.svg
:class: only-light
:align: center
:alt: Manager-based Task Workflow
.. image:: ../../_static/task-workflows/manager-based-dark.svg
:class: only-dark
:align: center
:alt: Manager-based Task Workflow
Manager-based environments promote modular implementations of tasks by decomposing the task into individual Manager-based environments promote modular implementations of tasks by decomposing the task into individual
components that are managed by separate classes. Each component of the task, such as rewards, observations, components that are managed by separate classes. Each component of the task, such as rewards, observations,
termination can all be specified as individual configuration classes that are then passed to the corresponding termination can all be specified as individual configuration classes that are then passed to the corresponding
...@@ -92,16 +98,22 @@ specifications. ...@@ -92,16 +98,22 @@ specifications.
Direct Environments Direct Environments
------------------- -------------------
.. image:: ./Direct-basedTaskWorkflow.jpg
:width: 100%
:alt: Direct-based Task Workflow
The direct-style environment aligns more closely with traditional implementations of environments, The direct-style environment aligns more closely with traditional implementations of environments,
where a single script directly implements the reward function, observation function, resets, and all the other components where a single script directly implements the reward function, observation function, resets, and all the other components
of the environment. This approach does not require the manager classes. Instead, users are provided the complete freedom of the environment. This approach does not require the manager classes. Instead, users are provided the complete freedom
to implement their task through the APIs from the base classes :class:`envs.DirectRLEnv` or :class:`envs.DirectMARLEnv`. to implement their task through the APIs from the base classes :class:`envs.DirectRLEnv` or :class:`envs.DirectMARLEnv`.
For users migrating from the `IsaacGymEnvs`_ and `OmniIsaacGymEnvs`_ framework, this workflow may be more familiar. For users migrating from the `IsaacGymEnvs`_ and `OmniIsaacGymEnvs`_ framework, this workflow may be more familiar.
.. image:: ../../_static/task-workflows/direct-based-light.svg
:class: only-light
:align: center
:alt: Direct-based Task Workflow
.. image:: ../../_static/task-workflows/direct-based-dark.svg
:class: only-dark
:align: center
:alt: Direct-based Task Workflow
When defining an environment with the direct-style implementation, we expect the user define a single class that When defining an environment with the direct-style implementation, we expect the user define a single class that
implements the entire environment. The task class should inherit from the base classes :class:`envs.DirectRLEnv` or implements the entire environment. The task class should inherit from the base classes :class:`envs.DirectRLEnv` or
:class:`envs.DirectMARLEnv` and should have its corresponding configuration class that inherits from :class:`envs.DirectMARLEnv` and should have its corresponding configuration class that inherits from
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment