Skip to content

Commit

Permalink
add comments to AlfEnvironment.render
Browse files Browse the repository at this point in the history
  • Loading branch information
Haichao-Zhang committed Feb 19, 2025
1 parent 8af18e4 commit 053873c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion alf/environments/alf_environment.py
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,10 @@ def render(self, mode='rgb_array'):
"""Renders the environment.
Args:
mode: One of ['rgb_array', 'human']. Renders to an numpy array, or brings
mode: One of ['rgb_array', 'human', 'online']. Renders to an numpy array, or brings
up a window where the environment can be visualized.
The ``online`` mode can be used to collect and return a list of frames
(e.g., generated by ``render(self, mode='rgb_array')``) of a running environment.
Returns:
An ndarray of shape ``[width, height, 3]`` denoting an RGB image if mode is
Expand Down

0 comments on commit 053873c

Please sign in to comment.