这是indexloc提供的服务，不要输入任何密码
Skip to content

docs: add warning about async simulation #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2022
Merged

docs: add warning about async simulation #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5ecfc2
docs: add warning about async simulation
cwher Jul 21, 2022
86ce32f
running in M1
Trinkle23897 Jul 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,20 @@ check-docstyle:
$(call check_install, doc8)
$(call check_install, sphinx)
$(call check_install, sphinx_rtd_theme)
$(call check_install, sphinxcontrib.bibtex, sphinxcontrib_bibtex)
pydocstyle ${PROJECT_PATH} && doc8 docs && cd docs && make html SPHINXOPTS="-W"

doc:
$(call check_install, sphinx)
$(call check_install, sphinx_rtd_theme)
$(call check_install, sphinxcontrib.bibtex, sphinxcontrib_bibtex)
cd docs && make html && cd _build/html && python3 -m http.server

spelling:
$(call check_install, sphinx)
$(call check_install, sphinx_rtd_theme)
$(call check_install_extra, sphinxcontrib.spelling, sphinxcontrib.spelling pyenchant)
$(call check_install, sphinxcontrib.bibtex, sphinxcontrib_bibtex)
cd docs && make spelling SPHINXOPTS="-W"

doc-clean:
Expand Down
3 changes: 3 additions & 0 deletions docs/spelling_wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,3 +159,6 @@ Qbert
Seaquest
subnets
subprocesses
isort
yapf
pydocstyle
11 changes: 10 additions & 1 deletion docs/tutorials/cheatsheet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,9 @@ By default, parallel environment simulation is synchronous: a step is done after

In case the time cost of environments varies a lot (e.g. 90% step cost 1s, but 10% cost 10s) where slow environments lag fast environments behind, async simulation can be used (related to `Issue 103 <https://github.com/thu-ml/tianshou/issues/103>`_). The idea is to start those finished environments without waiting for slow environments.

Asynchronous simulation is a built-in functionality of :class:`~tianshou.env.BaseVectorEnv`. Just provide ``wait_num`` or ``timeout`` (or both) and async simulation works.
Asynchronous simulation is a built-in functionality of
:class:`~tianshou.env.BaseVectorEnv`. Just provide ``wait_num`` or ``timeout``
(or both) and async simulation works.

::

Expand All @@ -121,6 +123,13 @@ You can treat the ``timeout`` parameter as a dynamic ``wait_num``. In each vecto

The figure in the right gives an intuitive comparison among synchronous/asynchronous simulation.

.. note::

The async simulation collector would cause some exceptions when used as
``test_collector`` in :doc:`/api/tianshou.trainer` (related to
`Issue 700 <https://github.com/thu-ml/tianshou/issues/700>`_). Please use
sync version for ``test_collector`` instead.

.. warning::

If you use your own environment, please make sure the ``seed`` method is set up properly, e.g.,
Expand Down
3 changes: 2 additions & 1 deletion tianshou/trainer/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import numpy as np
import tqdm

from tianshou.data import Collector, ReplayBuffer
from tianshou.data import AsyncCollector, Collector, ReplayBuffer
from tianshou.policy import BasePolicy
from tianshou.trainer.utils import gather_info, test_episode
from tianshou.utils import (
Expand Down Expand Up @@ -232,6 +232,7 @@ def reset(self) -> None:

if self.test_collector is not None:
assert self.episode_per_test is not None
assert not isinstance(self.test_collector, AsyncCollector) # Issue 700
self.test_collector.reset_stat()
test_result = test_episode(
self.policy, self.test_collector, self.test_fn, self.start_epoch,
Expand Down