search

aidudezzz / deepbots

A wrapper framework for Reinforcement Learning in the Webots robot simulator using Python 3.
https://deepbots.readthedocs.io/
GNU General Public License v3.0
230 stars 49 forks source link

RobotSupervisor docstring contains dated and misleading information #45

Closed tsampazk closed 3 years ago

tsampazk commented 3 years ago

https://github.com/aidudezzz/deepbots/blob/e99d210b66e830eafda43bda35ebe9f99a760970/deepbots/supervisor/controllers/robot_supervisor.py#L13-L19 Here the docstring states that the default implemented reset method is included in RobotSupervisor class. This information is dated and no longer valid, default reset implementation now resides in SupervisorEnv.

https://github.com/aidudezzz/deepbots/blob/e99d210b66e830eafda43bda35ebe9f99a760970/deepbots/supervisor/controllers/robot_supervisor.py#L25-L26

Moreover, here the docstring explains get_default_observation method which is no longer included in RobotSupervisor but now is in SupervisorEnv.

Edit: It would also be nice to note in the docstring that RobotSupervisor controllers should run on a Robot node with Supervisor privileges.