Fix gif example in the doc (#624)

* changed the img[0] to img. In this example, images are a list of image rendered in the environment, and here we should use img instead of img[0] which is 3 (rgb channels). Using img[0] will make a wrong GIF file. * Update changelog.rst Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
Stable-Baselines-Team · Feb 1, 2020 · 34d2bee · 34d2bee
1 parent 76e7cc0
commit 34d2bee
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/guide/examples.rst b/docs/guide/examples.rst
@@ -632,4 +632,4 @@ Bonus: Make a GIF of a Trained Agent
       obs, _, _ ,_ = model.env.step(action)
       img = model.env.render(mode='rgb_array')
 
-  imageio.mimsave('lander_a2c.gif', [np.array(img[0]) for i, img in enumerate(images) if i%2 == 0], fps=29)
+  imageio.mimsave('lander_a2c.gif', [np.array(img) for i, img in enumerate(images) if i%2 == 0], fps=29)
diff --git a/docs/misc/changelog.rst b/docs/misc/changelog.rst
@@ -44,6 +44,7 @@ Others:
 
 Documentation:
 ^^^^^^^^^^^^^^
+- Fixed example for creating a GIF (@KuKuXia)
 
 
 Release 2.9.0 (2019-12-20)
@@ -610,4 +611,4 @@ Thanks to @bjmuld @iambenzo @iandanforth @r7vme @brendenpetersen @huvar @abhiskk
 @XMaster96 @kantneel @Pastafarianist @GerardMaggiolino @PatrickWalter214 @yutingsz @sc420 @Aaahh @billtubbs
 @Miffyli @dwiel @miguelrass @qxcv @jaberkow @eavelardev @ruifeng96150 @pedrohbtp @srivatsankrishnan @evilsocket
 @MarvineGothic @jdossgollin @SyllogismRXS @rusu24edward @jbulow @Antymon @seheevic @justinkterry @edbeeching
-@flodorner
+@flodorner @KuKuXia