hongshaorou/Tianshou
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Tianshou/docs/api/tianshou.data.rst

118 lines
1.8 KiB
ReStructuredText
Raw Normal View History

test api doc
2020-04-02 09:07:04 +08:00
tianshou.data
=============
Step collector implementation (#280) This is the third PR of 6 commits mentioned in #274, which features refactor of Collector to fix #245. You can check #274 for more detail. Things changed in this PR: 1. refactor collector to be more cleaner, split AsyncCollector to support asyncvenv; 2. change buffer.add api to add(batch, bffer_ids); add several types of buffer (VectorReplayBuffer, PrioritizedVectorReplayBuffer, etc.) 3. add policy.exploration_noise(act, batch) -> act 4. small change in BasePolicy.compute_*_returns 5. move reward_metric from collector to trainer 6. fix np.asanyarray issue (different version's numpy will result in different output) 7. flake8 maxlength=88 8. polish docs and fix test Co-authored-by: n+e <trinkle23897@gmail.com>
2021-02-19 10:33:49 +08:00
Batch
-----
fix venv seed, add TOC in docs, and split buffer.py into several files (#303) Things changed in this PR: - various docs update, add TOC - split buffer into several files - fix venv action_space randomness
2021-03-02 12:28:28 +08:00
.. autoclass:: tianshou.data.Batch
Step collector implementation (#280) This is the third PR of 6 commits mentioned in #274, which features refactor of Collector to fix #245. You can check #274 for more detail. Things changed in this PR: 1. refactor collector to be more cleaner, split AsyncCollector to support asyncvenv; 2. change buffer.add api to add(batch, bffer_ids); add several types of buffer (VectorReplayBuffer, PrioritizedVectorReplayBuffer, etc.) 3. add policy.exploration_noise(act, batch) -> act 4. small change in BasePolicy.compute_*_returns 5. move reward_metric from collector to trainer 6. fix np.asanyarray issue (different version's numpy will result in different output) 7. flake8 maxlength=88 8. polish docs and fix test Co-authored-by: n+e <trinkle23897@gmail.com>
2021-02-19 10:33:49 +08:00
:members:
:undoc-members:
:show-inheritance:
Buffer
------
fix venv seed, add TOC in docs, and split buffer.py into several files (#303) Things changed in this PR: - various docs update, add TOC - split buffer into several files - fix venv action_space randomness
2021-03-02 12:28:28 +08:00
ReplayBuffer
~~~~~~~~~~~~
.. autoclass:: tianshou.data.ReplayBuffer
:members:
:undoc-members:
:show-inheritance:
PrioritizedReplayBuffer
~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: tianshou.data.PrioritizedReplayBuffer
Step collector implementation (#280) This is the third PR of 6 commits mentioned in #274, which features refactor of Collector to fix #245. You can check #274 for more detail. Things changed in this PR: 1. refactor collector to be more cleaner, split AsyncCollector to support asyncvenv; 2. change buffer.add api to add(batch, bffer_ids); add several types of buffer (VectorReplayBuffer, PrioritizedVectorReplayBuffer, etc.) 3. add policy.exploration_noise(act, batch) -> act 4. small change in BasePolicy.compute_*_returns 5. move reward_metric from collector to trainer 6. fix np.asanyarray issue (different version's numpy will result in different output) 7. flake8 maxlength=88 8. polish docs and fix test Co-authored-by: n+e <trinkle23897@gmail.com>
2021-02-19 10:33:49 +08:00
:members:
:undoc-members:
:show-inheritance:
fix venv seed, add TOC in docs, and split buffer.py into several files (#303) Things changed in this PR: - various docs update, add TOC - split buffer into several files - fix venv action_space randomness
2021-03-02 12:28:28 +08:00
ReplayBufferManager
~~~~~~~~~~~~~~~~~~~
.. autoclass:: tianshou.data.ReplayBufferManager
:members:
:undoc-members:
:show-inheritance:
PrioritizedReplayBufferManager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: tianshou.data.PrioritizedReplayBufferManager
:members:
:undoc-members:
:show-inheritance:
VectorReplayBuffer
~~~~~~~~~~~~~~~~~~
.. autoclass:: tianshou.data.VectorReplayBuffer
:members:
:undoc-members:
:show-inheritance:
PrioritizedVectorReplayBuffer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: tianshou.data.PrioritizedVectorReplayBuffer
:members:
:undoc-members:
:show-inheritance:
CachedReplayBuffer
~~~~~~~~~~~~~~~~~~
.. autoclass:: tianshou.data.CachedReplayBuffer
:members:
:undoc-members:
:show-inheritance:
Step collector implementation (#280) This is the third PR of 6 commits mentioned in #274, which features refactor of Collector to fix #245. You can check #274 for more detail. Things changed in this PR: 1. refactor collector to be more cleaner, split AsyncCollector to support asyncvenv; 2. change buffer.add api to add(batch, bffer_ids); add several types of buffer (VectorReplayBuffer, PrioritizedVectorReplayBuffer, etc.) 3. add policy.exploration_noise(act, batch) -> act 4. small change in BasePolicy.compute_*_returns 5. move reward_metric from collector to trainer 6. fix np.asanyarray issue (different version's numpy will result in different output) 7. flake8 maxlength=88 8. polish docs and fix test Co-authored-by: n+e <trinkle23897@gmail.com>
2021-02-19 10:33:49 +08:00
Collector
---------
fix venv seed, add TOC in docs, and split buffer.py into several files (#303) Things changed in this PR: - various docs update, add TOC - split buffer into several files - fix venv action_space randomness
2021-03-02 12:28:28 +08:00
Collector
~~~~~~~~~
.. autoclass:: tianshou.data.Collector
:members:
:undoc-members:
:show-inheritance:
AsyncCollector
~~~~~~~~~~~~~~
.. autoclass:: tianshou.data.AsyncCollector
test api doc
2020-04-02 09:07:04 +08:00
:members:
:undoc-members:
:show-inheritance:
use envpool in vizdoom example, update doc (#634)
2022-05-08 12:42:16 -04:00
Utils
-----
to_numpy
~~~~~~~~
.. autofunction:: tianshou.data.to_numpy
to_torch
~~~~~~~~
.. autofunction:: tianshou.data.to_torch
to_torch_as
~~~~~~~~~~~
.. autofunction:: tianshou.data.to_torch_as
SegmentTree
~~~~~~~~~~~
.. autoclass:: tianshou.data.SegmentTree
:members:
:undoc-members:
:show-inheritance:
Reference in New Issue Copy Permalink