View source on GitHub |
Observer for writing episodes to Reverb.
tf_agents.replay_buffers.ReverbAddEpisodeObserver(
py_client: tf_agents.typing.types.ReverbClient
,
table_name: Union[Text, Sequence[Text]],
max_sequence_length: int,
priority: Union[float, int] = 1,
bypass_partial_episodes: bool = False
)
Used in the notebooks
Used in the tutorials |
---|
This observer should be called at every step. It does not support batched trajectories. The steps are cached and written at the end of the episode.
At the end of each episode, an item is written to Reverb. Each item is the
trajectory containing an episode, including a boundary step in the end.
Therefore, the sequence lengths of the items may vary. If you want a fixed
sequence length, use ReverbAddTrajectoryObserver
instead.
Unfinished episodes remain in the cache and do not get written until
reset(write_cached_steps=True)
is called.
consumer, if your episodes have variable lengths.
Raises | |
---|---|
ValueError
|
If priority is not numeric.
|
ValueError
|
If max_sequence_length is not positive. |
Attributes | |
---|---|
py_client
|
Methods
close
close() -> None
Closes the writer of the observer.
flush
flush()
Ensures that items are pushed to the service.
get_table_signature
get_table_signature()
open
open() -> None
Open the writer of the observer. This is a no-op if it's already open.
reset
reset(
write_cached_steps: bool = True
) -> None
Resets the state of the observer.
Args | |
---|---|
write_cached_steps
|
By default, if there is remaining data in the cache,
write them to Reverb before clearing the cache. If write_cached_steps
is False , throw away the cached data instead.
|
update_priority
update_priority(
priority: Union[float, int]
) -> None
Update the table priority.
Args | |
---|---|
priority
|
Updates the priority of the observer. |
ValueError: If priority is not numeric.
__call__
__call__(
trajectory: tf_agents.trajectories.Trajectory
) -> None
Cache the single step trajectory to be written into Reverb.
Allows trajectory to be a flattened trajectory. No batch dimension allowed.
Args | |
---|---|
trajectory
|
The trajectory to be written which could be (possibly nested) trajectory object or a flattened version of a trajectory. It assumes there is no batch dimension. |
Raises | |
---|---|
ValueError
|
If bypass_partial_episodes == False and episode length
is > max_sequence_length .
|