h0HSrSSKJr SSKrSSKrSSKrSSKJr SSKJ r J r SSK J r J r SSKJrJr SSKrSSKJr SS KJr SSKrSS KJrJrJr SS KJr SS KJrJ r J!r! \"\RF5\"S5:a\"S5eSS/r$\r%\r&SSjr'SSjr(\RRSSSjj5r*\*RW\RX5SSSjj5r-\*RW\R5SS Sjj5r.\*RW\R5SS!Sjj5r/SS"Sjjr0\*RW\ 5SS#Sjj5r1"SS\Rd\RfRh5r5g!\"a \"S 5ef=f)$z{Helper functions and wrapper class for converting between arbitrary Array API compatible frameworks and a target framework.) annotationsN)abc)IterableMapping) ModuleTypeNoneType)Any SupportsFloat)is_numpy_namespace)Version) RenderFrameWrapperActTypeWrapperObsType)DependencyNotInstalled)array_namespaceis_array_api_obj to_devicezwArray API packages are not installed therefore cannot call `array_conversion`, run `pip install "gymnasium[array-api]"`z2.1.0z/Array API functionality requires numpy >= 2.1.0ArrayConversionarray_conversionc|[URS55$![an[SUS35UeSnAff=f)adDetermine the Array API compatible namespace of the given module. This function is closely linked to the `array_api_compat.array_namespace` function. It returns the compatible namespace for a module directly instead of from an array object of that module. See https://data-apis.org/array-api-compat/helper-functions.html#array_api_compat.array_namespace rzModule z' is not an Array API compatible module.N)remptyAttributeError ValueError)xpes ]/home/james-whalen/.local/lib/python3.13/site-packages/gymnasium/wrappers/array_conversion.pymodule_namespacer7sEWrxx{++ W72$&MNOUVVWs ;6;c@[[R"U55$N)r importlib import_module)names rmodule_name_to_namespacer#Es I33D9 ::c8[S[U5SUS35e)z8Convert a value into the specified xp module array type.zNo known conversion for (z) to xp module (z() registered. Report as issue on github.) Exceptiontypevaluerdevices rrrIs)  #DK=0@Dlm r$c URXS9$)zNConvert a python number (int, float, complex) to an Array API framework array.r*)asarrayr(s r_number_array_conversionr.Qs ::e: ++r$c[U5"S0UR5VVs0sHup4U[XAU5_M snnD6$s snnf)zTConvert a mapping of Arrays into a Dictionary of the specified xp module array type.)r'itemsr)r)rr*kvs r_mapping_array_conversionr4Ys= ; XW!-aV<<W XXWsAc^^[U5(a [UTT5$[US5(a%[U5R UU4SjU55$[U5"UU4SjU55$)zUConvert an Iterable from Arrays to an iterable of the specified xp module array type._makec3>># UHn[UTT5v M g7frr.0r3r*rs r -_iterable_array_conversion..os P%Q!1!R!@!@%c3>># UHn[UTT5v M g7frr8r9s rr;r<psF1'2v66r=)r_array_api_array_conversionhasattrr'r6r(s ``r_iterable_array_conversionrAas^*5"f==ugE{  P% PPP ;FF FFr$c[U5(dUOSnURXS9$![a URU5nUb [X5OUs$![a? [ U5R USS9nURU5nUb [X5OUss$[a0 UR[US55nUb [X5OUss$f=f[a+ [ U5R USS9nURXS9s$f=f)zLConvert an Array API compatible array to the specified xp module array type.cpur,T)copy)r from_dlpack TypeErrorr BufferErrorrr- RuntimeErrorr(s rr?r?ss.b11VuF4~~e~33 M MNN5)E/5/A9U+u L M$E*225t2DENN5)E/5/A9U+u L MNN9UE#:;E/5/A9U+u L  M 4  &..u4.@~~e~33 4s?% D  AD ACD 4CD C4D  D cU$)zPasses through None values.r0r(s r_none_array_conversionrJs Lr$c\rSrSrSrS S SjjrSSjrSSS.SSjjrSSjrS r S r S r g)raWraps an Array API compatible environment so that it can be interacted with with another Array API framework. Popular Array API frameworks include ``numpy``, ``torch``, ``jax.numpy``, ``cupy`` etc. With this wrapper, you can convert outputs from your environment to any of these frameworks. Conversely, actions are automatically mapped back to the environment framework, if possible without moving the data or device transfers. A vector version of the wrapper exists, :class:`gymnasium.wrappers.vector.ArrayConversion`. Example: >>> import torch # doctest: +SKIP >>> import jax.numpy as jnp # doctest: +SKIP >>> import gymnasium as gym # doctest: +SKIP >>> env = gym.make("JaxEnv-vx") # doctest: +SKIP >>> env = ArrayConversion(env, env_xp=jnp, target_xp=torch) # doctest: +SKIP >>> obs, _ = env.reset(seed=123) # doctest: +SKIP >>> type(obs) # doctest: +SKIP >>> action = torch.tensor(env.action_space.sample()) # doctest: +SKIP >>> obs, reward, terminated, truncated, info = env.step(action) # doctest: +SKIP >>> type(obs) # doctest: +SKIP >>> type(reward) # doctest: +SKIP >>> type(terminated) # doctest: +SKIP >>> type(truncated) # doctest: +SKIP Change logs: * v1.2.0 - Initially added Nc[RRRU5 [RRX5 [ U5Ul[ U5UlX@lXPl g)atWrapper class to change inputs and outputs of environment to any Array API framework. Args: env: The Array API compatible environment to wrap env_xp: The Array API framework the environment is on target_xp: The Array API framework to convert to env_device: The device the environment is on target_device: The device on which Arrays should be returned N) gymutilsRecordConstructorArgs__init__Wrapperr_env_xp _target_xp _env_device_target_device)selfenvenv_xp target_xp env_device target_devices rrQArrayConversion.__init__sR" ''006 T''/ *95*4-:r$c 0[XRURS9nURR U5up#pEn[X R UR S9[U5[U5[U5[X`R UR S94$)zPerforms the given action within the environment. Args: action: The action to perform as any Array API compatible array Returns: The next observation, reward, termination, truncation, and extra info )rr*) rrSrUrXsteprTrVfloatbool)rWactionobsreward terminated truncatedinfos rr_ArrayConversion.steps}"&\\$BRBRS3788==3H0ZD S__T=P=P Q &M   O Tood>Q>Q R   r$seedoptionscU(a [X RUR5n[URR XS9UR UR 5$)a(Resets the environment returning observation and info as Array from any Array API compatible framework. Args: seed: The seed for resetting the environment options: The options for resetting the environment, these are converted to jax arrays. Returns: xp-based observations and info ri)rrSrUrXresetrTrV)rWrjrks rrmArrayConversion.resetsL &w d>N>NOG HHNNN 6 OO     r$ct[URR5URUR5$)z+Returns the rendered frames as an xp Array.)rrXrenderrTrV)rWs rrpArrayConversion.renders& 14??DDWDWXXr$cURRRSS5nURRRSS5nURnUR nUUUUUR S.$)z5Returns the object pickle state with args and kwargs.zarray_api_compat.) env_xp_nametarget_xp_namer[r\rX)rS__name__replacerTrUrVrX)rWrtrur[r\s r __getstate__ArrayConversion.__getstate__soll++334GL 1199:MrR%% ++ &,$*88   r$cUSUl[US5Ul[US5UlUSUlUSUlg)z%Sets the object pickle state using d.rXrtrur[r\N)rXr#rSrTrUrV)rWds r __setstate__ArrayConversion.__setstate__sIU8/-0@A 215E3FG\?0r$)rUrSrVrTrX)NN) rXzgym.EnvrYrrZrr[ Device | Noner\r~)rbrreturnz6tuple[WrapperObsType, SupportsFloat, bool, bool, dict])rjz int | Nonerkzdict[str, Any] | Nonerz%tuple[WrapperObsType, dict[str, Any]])rz&RenderFrame | list[RenderFrame] | None) rv __module__ __qualname____firstlineno____doc__rQr_rmrprxr|__static_attributes__r0r$rrrsJ%)'+ ; ;; ; " ; % ;2 $ ? .%)4 ! 3H . *Y  1r$)rrrr)r"strrrr)r)r rrr*r~rr )r)znumbers.Numberrrr*r~rArray)r)Mapping[str, Any]rrr*r~rr)r) Iterable[Any]rrr*r~rr)r)rrrr*r~rr)r)Nonerrr*r~rr)6r __future__r functoolsr numbers collectionsrcollections.abcrrtypesrrtypingr r numpynparray_api_compatr packaging.versionr gymnasiumrNgymnasium.corer rrgymnasium.errorrrrr ImportError __version____all__rDevicerr#singledispatchrregisterNumberr.r4rAr?rJrRrOrPrr0r$rrs1B"-&%/%FF2MM 2>>WW-- !R SS 0 1   W; 7>>*CG, ,),3@, ,+,3;;'FJY Y",Y6CYY(Y3<<(BFG G(G2?GG)G$;?4 4 4*74 4D8$9= )6 %}1ckk399#B#B}1m  B s  FF!