Issue #216: Add envpool to openrl #278

kingjuno · 2023-12-07T08:59:38Z

Description

This PR adds envpool to openrl (#216).

Warning: I havent done make format (will do it later) because I am not sure about why the test fails.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Checklist

I have ensured make test pass (required).
I have checked the code using make format (required).

kingjuno · 2023-12-07T10:16:27Z

Strange! I can see all tests are passing in my local.

kingjuno · 2023-12-07T10:55:58Z

@huangshiyu13 I guess the test will pass now without any problem.

codecov · 2023-12-07T13:21:33Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9a05e6f) 69.22% compared to head (693d2e1) 73.37%.
Report is 20 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #278      +/-   ##
==========================================
+ Coverage   69.22%   73.37%   +4.15%     
==========================================
  Files         252      254       +2     
  Lines       13160    13256      +96     
==========================================
+ Hits         9110     9727     +617     
+ Misses       4050     3529     -521

Flag	Coverage Δ
unittests	`73.37% <100.00%> (+4.15%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

huangshiyu13 · 2023-12-08T12:04:44Z

openrl/envs/common/build_envs.py

@@ -36,13 +36,22 @@ def _make_env() -> Env:
                new_kwargs["env_num"] = env_num
            if id.startswith("ALE/") or id in gym.envs.registry.keys():
                new_kwargs.pop("cfg", None)


Envpool can not be installed on many platforms (such as Windows), so you should use the envpool as an external env which is out of OpenRL. Moreover, with the envpool as an external env, you don't need to write test code for codecov, because we only track the code in the openrl folder.

Examples:

https://openrl-docs.readthedocs.io/en/latest/custom_env/index.html#moreexamples1

https://github.com/OpenRL-Lab/openrl/tree/main/examples/isaac

https://github.com/OpenRL-Lab/openrl/tree/main/examples/smac

huangshiyu13 · 2023-12-08T12:04:58Z

openrl/envs/common/build_envs.py

-            )
+            if "envpool" in new_kwargs:
+                # for now envpool doesnt support any render mode
+                # envpool also doesnt stores the id anywhere


Envpool can not be installed on many platforms (such as Windows), so you should use the envpool as an external env which is out of OpenRL. Moreover, with the envpool as an external env, you don't need to write test code for codecov, because we only track the code in the openrl folder.

Examples:

https://openrl-docs.readthedocs.io/en/latest/custom_env/index.html#moreexamples1

https://github.com/OpenRL-Lab/openrl/tree/main/examples/isaac

https://github.com/OpenRL-Lab/openrl/tree/main/examples/smac

huangshiyu13 · 2023-12-08T12:05:16Z

openrl/envs/common/registration.py

@@ -17,6 +17,7 @@
 """"""
 from typing import Callable, Optional

+import envpool


Envpool can not be installed on many platforms (such as Windows), so you should use the envpool as an external env which is out of OpenRL. Moreover, with the envpool as an external env, you don't need to write test code for codecov, because we only track the code in the openrl folder.

Examples:

https://openrl-docs.readthedocs.io/en/latest/custom_env/index.html#moreexamples1

https://github.com/OpenRL-Lab/openrl/tree/main/examples/isaac

https://github.com/OpenRL-Lab/openrl/tree/main/examples/smac

huangshiyu13 · 2023-12-08T12:06:17Z

openrl/envs/common/registration.py

@@ -155,6 +155,18 @@ def make(
            env_fns = make_PettingZoo_envs(
                id=id, env_num=env_num, render_mode=convert_render_mode, **kwargs
            )
+        elif (
+            "envpool:" in id


Envpool can not be installed on many platforms (such as Windows), so you should use the envpool as an external env which is out of OpenRL. Moreover, with the envpool as an external env, you don't need to write test code for codecov, because we only track the code in the openrl folder.

Examples:

https://openrl-docs.readthedocs.io/en/latest/custom_env/index.html#moreexamples1

https://github.com/OpenRL-Lab/openrl/tree/main/examples/isaac

https://github.com/OpenRL-Lab/openrl/tree/main/examples/smac

huangshiyu13 · 2023-12-08T12:06:21Z

openrl/envs/common/registration.py

+        ):
+            from openrl.envs.envpool import make_envpool_envs
+
+            env_fns = make_envpool_envs(


Envpool can not be installed on many platforms (such as Windows), so you should use the envpool as an external env which is out of OpenRL. Moreover, with the envpool as an external env, you don't need to write test code for codecov, because we only track the code in the openrl folder.

Examples:

https://openrl-docs.readthedocs.io/en/latest/custom_env/index.html#moreexamples1

https://github.com/OpenRL-Lab/openrl/tree/main/examples/isaac

https://github.com/OpenRL-Lab/openrl/tree/main/examples/smac

huangshiyu13 · 2023-12-08T12:06:51Z

openrl/envs/envpool/__init__.py

should move to examples/envpool

huangshiyu13 · 2023-12-08T12:06:59Z

openrl/envs/wrappers/envpool_wrappers.py

should move to examples/envpool

huangshiyu13 · 2023-12-08T12:08:00Z

setup.py

@@ -84,6 +85,7 @@ def get_extra_requires() -> dict:
            "fastapi",
            "pettingzoo[mpe]",
            "pettingzoo[butterfly]",
+            "envpool",


delete this. Add a README.md in examples/envpool. And show how to install dependencies in the markdown.

huangshiyu13 · 2023-12-08T12:08:10Z

setup.py

@@ -76,6 +76,7 @@ def get_extra_requires() -> dict:
            "async_timeout",
            "pettingzoo[classic]",
            "trueskill",
+            "envpool",


delete this. Add a README.md in examples/envpool. And show how to install dependencies in the markdown.

Add envpool to openrl

dac2804

Remove unwanted test for envpool

3c31b5a

kingjuno force-pushed the Issue-#216 branch from d6d48af to 3c31b5a Compare December 7, 2023 10:19

kingjuno added 2 commits December 7, 2023 15:52

Fix a typo: envpool/train-ppo

990f8c5

Fix dependency error: stablebaseline3

448cc6f

huangshiyu13 reviewed Dec 8, 2023

View reviewed changes

openrl/envs/envpool/__init__.py Outdated

Copy link

Member

huangshiyu13 Dec 8, 2023

Choose a reason for hiding this comment

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

should move to examples/envpool

huangshiyu13 requested changes Dec 8, 2023

View reviewed changes

kingjuno added 2 commits December 20, 2023 11:48

Move envpool to examples

753fba7

Revert files in openrl folder

693d2e1

kingjuno requested a review from huangshiyu13 December 20, 2023 06:23

huangshiyu13 approved these changes Dec 20, 2023

View reviewed changes

huangshiyu13 merged commit e864a08 into OpenRL-Lab:main Dec 20, 2023
5 checks passed

This was referenced Dec 20, 2023

Roadmap for OpenRL #2

Open

[Feature Request] add Envpool environment #216

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue #216: Add envpool to openrl #278

Issue #216: Add envpool to openrl #278

kingjuno commented Dec 7, 2023 •

edited

Loading

kingjuno commented Dec 7, 2023

kingjuno commented Dec 7, 2023

codecov bot commented Dec 7, 2023 •

edited

Loading

huangshiyu13 Dec 8, 2023

huangshiyu13 Dec 8, 2023

huangshiyu13 Dec 8, 2023

huangshiyu13 Dec 8, 2023

huangshiyu13 Dec 8, 2023

huangshiyu13 Dec 8, 2023

huangshiyu13 Dec 8, 2023

huangshiyu13 Dec 8, 2023

huangshiyu13 Dec 8, 2023

Issue #216: Add envpool to openrl #278

Issue #216: Add envpool to openrl #278

Conversation

kingjuno commented Dec 7, 2023 • edited Loading

Description

Types of changes

Checklist

kingjuno commented Dec 7, 2023

kingjuno commented Dec 7, 2023

codecov bot commented Dec 7, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kingjuno commented Dec 7, 2023 •

edited

Loading

codecov bot commented Dec 7, 2023 •

edited

Loading