Update documentation to include example visualization

sisl · Nov 12, 2023 · 4f56505 · 4f56505
1 parent a5ef039
commit 4f56505
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/docs/docs/imgs/example_visualization.mp4 b/docs/docs/imgs/example_visualization.mp4
diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md
@@ -55,9 +55,20 @@ for _ in range(10):
     # Render environment and print reward
     env.render()
     print("Reward: " + str(reward))
+
+# Generate the gif
+env.generate_gif()
 ```
 
-An example of the visualization rendered can be found in the `imgs` folder.
+Finally, we can see that the function `generate_gif` allows us to collate all of the visualizations generated by the `render` function and stitch them together into a GIF:
+
+<div style="text-align:center;">
+    <video width="75%" autoplay loop muted playsinline>
+        <source src="../imgs/example_visualization.mp4" type="video/mp4">
+        Your browser does not support the video tag.
+    </video>
+</div>
+<br />
 
 ## Use with Stable Baselines 3