From 9abb0eb122fe9c7c08ed21323bd4cf1c8484464c Mon Sep 17 00:00:00 2001 From: YufengGao Date: Mon, 20 Jan 2025 12:00:20 -0500 Subject: [PATCH 1/2] fix docs atari example by import ale_py --- docs/guide/examples.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/guide/examples.rst b/docs/guide/examples.rst index 608eadcba..9693d7e1f 100644 --- a/docs/guide/examples.rst +++ b/docs/guide/examples.rst @@ -375,7 +375,8 @@ and multiprocessing for you. To install the Atari environments, run the command from stable_baselines3.common.env_util import make_atari_env from stable_baselines3.common.vec_env import VecFrameStack from stable_baselines3 import A2C - + import ale_py + # There already exists an environment generator # that will make and wrap atari environments correctly. # Here we are also multi-worker training (n_envs=4 => 4 environments) From 866b9dd7bdcd3089612caf9e0495e5cf7a35f0ce Mon Sep 17 00:00:00 2001 From: Antonin Raffin Date: Tue, 21 Jan 2025 10:39:09 +0100 Subject: [PATCH 2/2] Update changelog --- docs/guide/examples.rst | 3 ++- docs/misc/changelog.rst | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/guide/examples.rst b/docs/guide/examples.rst index 9693d7e1f..b60ff69e1 100644 --- a/docs/guide/examples.rst +++ b/docs/guide/examples.rst @@ -375,8 +375,9 @@ and multiprocessing for you. To install the Atari environments, run the command from stable_baselines3.common.env_util import make_atari_env from stable_baselines3.common.vec_env import VecFrameStack from stable_baselines3 import A2C + import ale_py - + # There already exists an environment generator # that will make and wrap atari environments correctly. # Here we are also multi-worker training (n_envs=4 => 4 environments) diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst index bfab950ea..04cc296d3 100644 --- a/docs/misc/changelog.rst +++ b/docs/misc/changelog.rst @@ -41,6 +41,7 @@ Documentation: - Added link to policies for ``policy_kwargs`` parameter (@kplers) - Add FootstepNet Envs to the project page (@cgaspard3333) - Added FRASA to the project page (@MarcDcls) +- Fixed atari example (@chrisgao99) Release 2.4.1 (2024-12-20) -------------------------- @@ -1749,4 +1750,4 @@ And all the contributors: @DavyMorgan @luizapozzobon @Bonifatius94 @theSquaredError @harveybellini @DavyMorgan @FieteO @jonasreiher @npit @WeberSamuel @troiganto @lutogniew @lbergmann1 @lukashass @BertrandDecoster @pseudo-rnd-thoughts @stefanbschneider @kyle-he @PatrickHelm @corentinlger @marekm4 @stagoverflow @rushitnshah @markscsmith @NickLucche @cschindlbeck @peteole @jak3122 @will-maclean -@brn-dev @jmacglashan @kplers @MarcDcls +@brn-dev @jmacglashan @kplers @MarcDcls @chrisgao99