h &SrSSKJr SSKJrJr SSKrSSKr SSK J r J r SSK Jr S/r"SS\ R \ R"R$5rg) z\Implementation of Atari 2600 Preprocessing following the guidelines of Machado et al., 2018.) annotations)Any SupportsFloatN)WrapperActTypeWrapperObsType)BoxAtariPreprocessingc\rSrSrSrS S Sjjr\S5rS SjrSSS.SSjjr S r S r g)r aImplements the common preprocessing techniques for Atari environments (excluding frame stacking). For frame stacking use :class:`gymnasium.wrappers.FrameStackObservation`. No vector version of the wrapper exists This class follows the guidelines in Machado et al. (2018), "Revisiting the Arcade Learning Environment: Evaluation Protocols and Open Problems for General Agents". Specifically, the following preprocess stages applies to the atari environment: - Noop Reset: Obtains the initial state by taking a random number of no-ops on reset, default max 30 no-ops. - Frame skipping: The number of frames skipped between steps, 4 by default. - Max-pooling: Pools over the most recent two observations from the frame skips. - Termination signal when a life is lost: When the agent losses a life during the environment, then the environment is terminated. Turned off by default. Not recommended by Machado et al. (2018). - Resize to a square image: Resizes the atari environment original observation shape from 210x180 to 84x84 by default. - Grayscale observation: Makes the observation greyscale, enabled by default. - Grayscale new axis: Extends the last channel of the observation such that the image is 3-dimensional, not enabled by default. - Scale observation: Whether to scale the observation between [0, 1) or [0, 255), not scaled by default. Example: >>> import gymnasium as gym >>> import ale_py >>> gym.register_envs(ale_py) >>> env = gym.make("ALE/Pong-v5", frameskip=1) >>> env = AtariPreprocessing( ... env, ... noop_max=10, frame_skip=4, terminal_on_life_loss=True, ... screen_size=84, grayscale_obs=False, grayscale_newaxis=False ... ) Change logs: * Added in gym v0.12.2 (gym #1455) c L[RRRUUUUUUUUS9 [RRX5 SSKn US:de[U[5(aUS:dE[U[5(a&[U5S:Xa[SU55(d SU35eUS:a&[URS S5S:wa [!S 5eUS:deX lUS:a#URR%5SS :XdeX0l[U[5(aUOXD4UlXPlX`lXplXl[UR2[45(deU(az[6R8"UR2R:SS[6R<S 9[6R8"UR2R:SS[6R<S 9/UlOs[6R8"UR2R:[6R<S 9[6R8"UR2R:[6R<S 9/UlSUl S Ul!U(aSS[6RD4OSS[6R<4upn UR(SUR(SU(aSOS4n U(a U(dU SSn [5XXS9Ulg![ a [RRS5ef=f)agWrapper for Atari 2600 preprocessing. Args: env (Env): The environment to apply the preprocessing noop_max (int): For No-op reset, the max number no-ops actions are taken at reset, to turn off, set to 0. frame_skip (int): The number of frames between new observation the agents observations effecting the frequency at which the agent experiences the game. screen_size (int | tuple[int, int]): resize Atari frame. terminal_on_life_loss (bool): `if True`, then :meth:`step()` returns `terminated=True` whenever a life is lost. grayscale_obs (bool): if True, then gray scale observation is returned, otherwise, RGB observation is returned. grayscale_newaxis (bool): `if True and grayscale_obs=True`, then a channel axis is added to grayscale observations to make them 3-dimensional. scale_obs (bool): if True, then observation normalized in range [0,1) is returned. It also limits memory optimization benefits of FrameStack Wrapper. Raises: DependencyNotInstalled: opencv-python package not installed ValueError: Disable frame-skipping in the original env )noop_max frame_skip screen_sizeterminal_on_life_loss grayscale_obsgrayscale_newaxis scale_obsrNzgopencv-python package not installed, run `pip install "gymnasium[other]"` to get dependencies for ataric3Z# UH!n[U[5=(a US:v M# g7f)rN) isinstanceint).0sizes `/home/james-whalen/.local/lib/python3.13/site-packages/gymnasium/wrappers/atari_preprocessing.py .AtariPreprocessing.__init__..ks#O;4JtS)6dQh6;s)+z3Expect the `screen_size` to be positive, actually:  _frameskipzsDisable frame-skipping in the original env. Otherwise, more than one frame-skip will happen as through this wrapperNOOPdtypeF)lowhighshaper!)#gymutilsRecordConstructorArgs__init__Wrappercv2 ImportErrorerrorDependencyNotInstalledrrtuplelenallgetattr unwrapped ValueErrorr get_action_meaningsrrrrrrobservation_spacernpemptyr'uint8 obs_bufferlives game_overfloat32)selfenvr rrrrrrr-_low_high_dtype_shapes rr+AtariPreprocessing.__init__5s> ''00 !#"7'/ 1  T'   A~~;,,q {E * *K A%O;OOO OA N  O >gcmm\4HAMF 1}} a<==446q9VC CC$+u-- +  &;"*!2"#//5555 ..44Ra8I..44Ra8IDO ..44BHHE..44BHHEDO  4=q!RZZ0AsBHHCUV""1%t'7'7':ATUV !2CR[F!$!Vg ))22y  s K99*L#cBURRR$)z:Make ale as a class property to avoid serialization error.)rAr5ale)r@s rrHAtariPreprocessing.alesxx!!%%%cfSSS04up#pE[UR5GH|nURRU5upxp4nX(- nX0lUR (a=UR R5n U=(d XR:nX0lXlU(dU(a OX`RS- :XafUR(a*UR RURS5 MUR RURS5 GMX`RS- :XdGMUR(a+UR RURS5 GMTUR RURS5 GM UR5X#XE4$)z2Applies the preprocessing for an :meth:`env.step`.gFrrr) rangerrAstepr>rrHr=rgetScreenGrayscaler< getScreenRGB_get_obs) r@action total_reward terminated truncatedinfot_reward new_livess rrMAtariPreprocessing.steps=58r4I1 )t'A59XX]]65J 2Azd  "L'N)) HHNN, 'A9zz+A !+& YOOa''%%HH//0BCHH))$//!*<=oo))%%HH//0BCHH))$//!*<=-(.}} )IIrJNseedoptionscURRXS9up4URS:a=URRRR SURS-5OSn[ U5H^nURRS5u p6pxURU5 U(d U(dMCURRXS9up4M` URR5Ul UR(a)URRURS5 O(URRURS5 URSRS5 UR!5U4$)z+Resets the environment using preprocessing.r[rr)rAresetr r5 np_randomintegersrLrMupdaterHr=rrNr<rOfillrP) r@r\r]rW reset_infonoopsrSrT step_infos rr_AtariPreprocessing.resets, DB }}q  HH   ( ( 1 1!T]]Q5F G  uA59XX]]15E 2Aqi   i (YY $D J :  XX^^%    HH ' '(: ; HH ! !$//!"4 5 "}} **rJc0URS:a=[R"URSURSURSS9 SSKnUR URSUR URS9nUR(a'[R"U[RS9S- nO#[R"U[RS9nUR(a&UR(a[R"USS9nU$) Nrr)out) interpolationr go@r$)axis)rr9maximumr<r-resizer INTER_AREArasarrayr?r;rr expand_dims)r@r-obss rrPAtariPreprocessing._get_obss ??Q  JJtq)4??1+=4??STCU Vjj OOA    ..  >>**S 3e;C**S1C   $"8"8..2.C rJ) rr>rrr=r r<r8rrr)TFTFF)rAzgym.Envr rrrrzint | tuple[int, int]rboolrrvrrvrrv)rQrreturnz@tuple[WrapperObsType, SupportsFloat, bool, bool, dict[str, Any]])r\z int | Noner]zdict[str, Any] | Nonerwz%tuple[WrapperObsType, dict[str, Any]]) __name__ __module__ __qualname____firstlineno____doc__r+propertyrHrMr_rP__static_attributes__rJrr r s!L-/&+""'`W `W`W `W + `W $ `W`W `W`WD&&J$J IJ@%)4+!+3H+ .+6rJ)r| __future__rtypingrrnumpyr9 gymnasiumr(gymnasium.corerrgymnasium.spacesr__all__r,r)r*r rrJrrsBb"%9  Xcii&E&EXrJ