ray.rllib.env.multi_agent_episode.MultiAgentEpisode.is_done#
- property MultiAgentEpisode.is_done#
Whether the episode is actually done (terminated or truncated).
A done episode cannot be continued via
self.add_env_step()
or being concatenated on its right-side with another episode chunk or being succeeded viaself.cut()
.Note that in a multi-agent environment this does not necessarily correspond to single agents having terminated or being truncated.
self.is_terminated
should beTrue
, if all agents are terminated andself.is_truncated
should beTrue
, if all agents are truncated. If only one or more (but not all!) agents areterminated/truncated the `MultiAgentEpisode.is_terminated/is_truncated
should beFalse
. This information about single agent’s terminated/truncated states can always be retrieved from theSingleAgentEpisode`s inside the 'MultiAgentEpisode
one.If all agents are either terminated or truncated, but in a mixed fashion, i.e. some are terminated and others are truncated: This is currently undefined and could potentially be a problem (if a user really implemented such a multi-agent env that behaves this way).
- Returns:
Boolean defining if an episode has either terminated or truncated.