Skip to content

Commit

Permalink
[BugFix] Fix documentation of threads for batched envs. (#1776)
Browse files Browse the repository at this point in the history
  • Loading branch information
skandermoalla authored Jan 8, 2024
1 parent 1874e9a commit 55faae1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions torchrl/envs/batched_envs.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,11 @@ class _BatchedEnv(EnvBase):
device for the nested environments, one can keep the overhead to a
minimum.
num_threads (int, optional): number of threads for this process.
Defaults to the number of workers.
This parameter has no effect for the :class:`~SerialEnv` class.
num_sub_threads (int, optional): number of threads of the subprocesses.
Should be equal to one plus the number of processes launched within
each subprocess (or one if a single process is launched).
Defaults to the number of workers + 1.
This parameter has no effect for the :class:`~SerialEnv` class.
num_sub_threads (int, optional): number of threads of the subprocesses.
Defaults to 1 for safety: if none is indicated, launching multiple
workers may charge the cpu load too much and harm performance.
This parameter has no effect for the :class:`~SerialEnv` class.
Expand Down

0 comments on commit 55faae1

Please sign in to comment.