PyPI release

yannbouteiller · Mar 28, 2021 · 657b2b9 · 657b2b9
1 parent df4a3e0
commit 657b2b9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/rtgym/envs/real_time_env.py b/rtgym/envs/real_time_env.py
@@ -526,6 +526,8 @@ def wait(self):
     def benchmarks(self):
         """Gets environment benchmarks.
 
+        Caution: not compatible with render(join_thread=True)
+
         Returns:
             A dictionary containing the running averages and average deviations of important durations
         """
@@ -535,11 +537,11 @@ def benchmarks(self):
     def render(self, mode='human', join_thread=False):
         """Visually renders the current state of the environment.
 
-        Caution: when join_thread is True, render() is not compatible with benchmarks().
-
         Args:
             mode: not used
-            join_thread: set this to True if your render method performs thread-unsafe operations
+            join_thread: set this to True if your render method performs unsafe operations.
+                The render method of your interface is called outside of the Real-Time Gym thread.
+                Caution: when join_thread is True, render() is not compatible with benchmarks().
         """
         if join_thread:
             self._join_thread()

diff --git a/setup.py b/setup.py
@@ -7,14 +7,14 @@
 
 setup(name='rtgym',
       packages=[package for package in find_packages()],
-      version='0.3',
+      version='0.4',
       license='MIT',
       description='Easily implement custom OpenAI Gym environments for real-time applications',
       long_description=long_description,
       long_description_content_type="text/markdown",
       author='Yann Bouteiller',
       url='https://github.com/yannbouteiller/rtgym',
-      download_url='https://github.com/yannbouteiller/rtgym/archive/v0.3.tar.gz',
+      download_url='https://github.com/yannbouteiller/rtgym/archive/v0.4.tar.gz',
       keywords=['gym', 'real', 'time', 'custom', 'environment', 'reinforcement', 'learning', 'random', 'delays'],
       install_requires=['gym', 'numpy'],
       classifiers=[