torchrl 0.11.0__cp314-cp314t-macosx_11_0_arm64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (395) hide show
  1. benchmarks/benchmark_batched_envs.py +104 -0
  2. benchmarks/conftest.py +91 -0
  3. benchmarks/ecosystem/gym_env_throughput.py +321 -0
  4. benchmarks/ecosystem/vmas_rllib_vs_torchrl_sampling_performance.py +231 -0
  5. benchmarks/requirements.txt +7 -0
  6. benchmarks/storage/benchmark_sample_latency_over_rpc.py +193 -0
  7. benchmarks/test_collectors_benchmark.py +240 -0
  8. benchmarks/test_compressed_storage_benchmark.py +145 -0
  9. benchmarks/test_envs_benchmark.py +133 -0
  10. benchmarks/test_llm.py +101 -0
  11. benchmarks/test_non_tensor_env_benchmark.py +70 -0
  12. benchmarks/test_objectives_benchmarks.py +1199 -0
  13. benchmarks/test_replaybuffer_benchmark.py +254 -0
  14. sota-check/README.md +35 -0
  15. sota-implementations/README.md +142 -0
  16. sota-implementations/a2c/README.md +39 -0
  17. sota-implementations/a2c/a2c_atari.py +291 -0
  18. sota-implementations/a2c/a2c_mujoco.py +273 -0
  19. sota-implementations/a2c/utils_atari.py +240 -0
  20. sota-implementations/a2c/utils_mujoco.py +160 -0
  21. sota-implementations/bandits/README.md +7 -0
  22. sota-implementations/bandits/dqn.py +126 -0
  23. sota-implementations/cql/cql_offline.py +198 -0
  24. sota-implementations/cql/cql_online.py +249 -0
  25. sota-implementations/cql/discrete_cql_offline.py +180 -0
  26. sota-implementations/cql/discrete_cql_online.py +227 -0
  27. sota-implementations/cql/utils.py +471 -0
  28. sota-implementations/crossq/crossq.py +271 -0
  29. sota-implementations/crossq/utils.py +320 -0
  30. sota-implementations/ddpg/ddpg.py +231 -0
  31. sota-implementations/ddpg/utils.py +325 -0
  32. sota-implementations/decision_transformer/dt.py +163 -0
  33. sota-implementations/decision_transformer/lamb.py +167 -0
  34. sota-implementations/decision_transformer/online_dt.py +178 -0
  35. sota-implementations/decision_transformer/utils.py +562 -0
  36. sota-implementations/discrete_sac/discrete_sac.py +243 -0
  37. sota-implementations/discrete_sac/utils.py +324 -0
  38. sota-implementations/dqn/README.md +30 -0
  39. sota-implementations/dqn/dqn_atari.py +272 -0
  40. sota-implementations/dqn/dqn_cartpole.py +236 -0
  41. sota-implementations/dqn/utils_atari.py +132 -0
  42. sota-implementations/dqn/utils_cartpole.py +90 -0
  43. sota-implementations/dreamer/README.md +129 -0
  44. sota-implementations/dreamer/dreamer.py +586 -0
  45. sota-implementations/dreamer/dreamer_utils.py +1107 -0
  46. sota-implementations/expert-iteration/README.md +352 -0
  47. sota-implementations/expert-iteration/ei_utils.py +770 -0
  48. sota-implementations/expert-iteration/expert-iteration-async.py +512 -0
  49. sota-implementations/expert-iteration/expert-iteration-sync.py +508 -0
  50. sota-implementations/expert-iteration/requirements_gsm8k.txt +13 -0
  51. sota-implementations/expert-iteration/requirements_ifeval.txt +16 -0
  52. sota-implementations/gail/gail.py +327 -0
  53. sota-implementations/gail/gail_utils.py +68 -0
  54. sota-implementations/gail/ppo_utils.py +157 -0
  55. sota-implementations/grpo/README.md +273 -0
  56. sota-implementations/grpo/grpo-async.py +437 -0
  57. sota-implementations/grpo/grpo-sync.py +435 -0
  58. sota-implementations/grpo/grpo_utils.py +843 -0
  59. sota-implementations/grpo/requirements_gsm8k.txt +11 -0
  60. sota-implementations/grpo/requirements_ifeval.txt +16 -0
  61. sota-implementations/impala/README.md +33 -0
  62. sota-implementations/impala/impala_multi_node_ray.py +292 -0
  63. sota-implementations/impala/impala_multi_node_submitit.py +284 -0
  64. sota-implementations/impala/impala_single_node.py +261 -0
  65. sota-implementations/impala/utils.py +184 -0
  66. sota-implementations/iql/discrete_iql.py +230 -0
  67. sota-implementations/iql/iql_offline.py +164 -0
  68. sota-implementations/iql/iql_online.py +225 -0
  69. sota-implementations/iql/utils.py +437 -0
  70. sota-implementations/multiagent/README.md +74 -0
  71. sota-implementations/multiagent/iql.py +237 -0
  72. sota-implementations/multiagent/maddpg_iddpg.py +266 -0
  73. sota-implementations/multiagent/mappo_ippo.py +267 -0
  74. sota-implementations/multiagent/qmix_vdn.py +271 -0
  75. sota-implementations/multiagent/sac.py +337 -0
  76. sota-implementations/multiagent/utils/__init__.py +4 -0
  77. sota-implementations/multiagent/utils/logging.py +151 -0
  78. sota-implementations/multiagent/utils/utils.py +43 -0
  79. sota-implementations/ppo/README.md +29 -0
  80. sota-implementations/ppo/ppo_atari.py +305 -0
  81. sota-implementations/ppo/ppo_mujoco.py +293 -0
  82. sota-implementations/ppo/utils_atari.py +238 -0
  83. sota-implementations/ppo/utils_mujoco.py +152 -0
  84. sota-implementations/ppo_trainer/train.py +21 -0
  85. sota-implementations/redq/README.md +7 -0
  86. sota-implementations/redq/redq.py +199 -0
  87. sota-implementations/redq/utils.py +1060 -0
  88. sota-implementations/sac/sac-async.py +266 -0
  89. sota-implementations/sac/sac.py +239 -0
  90. sota-implementations/sac/utils.py +381 -0
  91. sota-implementations/sac_trainer/train.py +16 -0
  92. sota-implementations/td3/td3.py +254 -0
  93. sota-implementations/td3/utils.py +319 -0
  94. sota-implementations/td3_bc/td3_bc.py +177 -0
  95. sota-implementations/td3_bc/utils.py +251 -0
  96. torchrl/.dylibs/libc++.1.0.dylib +0 -0
  97. torchrl/__init__.py +144 -0
  98. torchrl/_extension.py +74 -0
  99. torchrl/_torchrl.cpython-314t-darwin.so +0 -0
  100. torchrl/_utils.py +1431 -0
  101. torchrl/collectors/__init__.py +48 -0
  102. torchrl/collectors/_base.py +1058 -0
  103. torchrl/collectors/_constants.py +88 -0
  104. torchrl/collectors/_multi_async.py +324 -0
  105. torchrl/collectors/_multi_base.py +1805 -0
  106. torchrl/collectors/_multi_sync.py +464 -0
  107. torchrl/collectors/_runner.py +581 -0
  108. torchrl/collectors/_single.py +2009 -0
  109. torchrl/collectors/_single_async.py +259 -0
  110. torchrl/collectors/collectors.py +62 -0
  111. torchrl/collectors/distributed/__init__.py +32 -0
  112. torchrl/collectors/distributed/default_configs.py +133 -0
  113. torchrl/collectors/distributed/generic.py +1306 -0
  114. torchrl/collectors/distributed/ray.py +1092 -0
  115. torchrl/collectors/distributed/rpc.py +1006 -0
  116. torchrl/collectors/distributed/sync.py +731 -0
  117. torchrl/collectors/distributed/utils.py +160 -0
  118. torchrl/collectors/llm/__init__.py +10 -0
  119. torchrl/collectors/llm/base.py +494 -0
  120. torchrl/collectors/llm/ray_collector.py +275 -0
  121. torchrl/collectors/llm/utils.py +36 -0
  122. torchrl/collectors/llm/weight_update/__init__.py +10 -0
  123. torchrl/collectors/llm/weight_update/vllm.py +348 -0
  124. torchrl/collectors/llm/weight_update/vllm_v2.py +311 -0
  125. torchrl/collectors/utils.py +433 -0
  126. torchrl/collectors/weight_update.py +591 -0
  127. torchrl/csrc/numpy_utils.h +38 -0
  128. torchrl/csrc/pybind.cpp +27 -0
  129. torchrl/csrc/segment_tree.h +458 -0
  130. torchrl/csrc/torch_utils.h +34 -0
  131. torchrl/csrc/utils.cpp +48 -0
  132. torchrl/csrc/utils.h +31 -0
  133. torchrl/data/__init__.py +187 -0
  134. torchrl/data/datasets/__init__.py +58 -0
  135. torchrl/data/datasets/atari_dqn.py +878 -0
  136. torchrl/data/datasets/common.py +281 -0
  137. torchrl/data/datasets/d4rl.py +489 -0
  138. torchrl/data/datasets/d4rl_infos.py +187 -0
  139. torchrl/data/datasets/gen_dgrl.py +375 -0
  140. torchrl/data/datasets/minari_data.py +643 -0
  141. torchrl/data/datasets/openml.py +177 -0
  142. torchrl/data/datasets/openx.py +798 -0
  143. torchrl/data/datasets/roboset.py +363 -0
  144. torchrl/data/datasets/utils.py +11 -0
  145. torchrl/data/datasets/vd4rl.py +432 -0
  146. torchrl/data/llm/__init__.py +34 -0
  147. torchrl/data/llm/dataset.py +491 -0
  148. torchrl/data/llm/history.py +1378 -0
  149. torchrl/data/llm/prompt.py +198 -0
  150. torchrl/data/llm/reward.py +225 -0
  151. torchrl/data/llm/topk.py +186 -0
  152. torchrl/data/llm/utils.py +543 -0
  153. torchrl/data/map/__init__.py +21 -0
  154. torchrl/data/map/hash.py +185 -0
  155. torchrl/data/map/query.py +204 -0
  156. torchrl/data/map/tdstorage.py +363 -0
  157. torchrl/data/map/tree.py +1434 -0
  158. torchrl/data/map/utils.py +103 -0
  159. torchrl/data/postprocs/__init__.py +8 -0
  160. torchrl/data/postprocs/postprocs.py +391 -0
  161. torchrl/data/replay_buffers/__init__.py +99 -0
  162. torchrl/data/replay_buffers/checkpointers.py +622 -0
  163. torchrl/data/replay_buffers/ray_buffer.py +292 -0
  164. torchrl/data/replay_buffers/replay_buffers.py +2376 -0
  165. torchrl/data/replay_buffers/samplers.py +2578 -0
  166. torchrl/data/replay_buffers/scheduler.py +265 -0
  167. torchrl/data/replay_buffers/storages.py +2412 -0
  168. torchrl/data/replay_buffers/utils.py +1042 -0
  169. torchrl/data/replay_buffers/writers.py +781 -0
  170. torchrl/data/tensor_specs.py +7101 -0
  171. torchrl/data/utils.py +334 -0
  172. torchrl/envs/__init__.py +265 -0
  173. torchrl/envs/async_envs.py +1105 -0
  174. torchrl/envs/batched_envs.py +3093 -0
  175. torchrl/envs/common.py +4241 -0
  176. torchrl/envs/custom/__init__.py +11 -0
  177. torchrl/envs/custom/chess.py +617 -0
  178. torchrl/envs/custom/llm.py +214 -0
  179. torchrl/envs/custom/pendulum.py +401 -0
  180. torchrl/envs/custom/san_moves.txt +29274 -0
  181. torchrl/envs/custom/tictactoeenv.py +288 -0
  182. torchrl/envs/env_creator.py +263 -0
  183. torchrl/envs/gym_like.py +752 -0
  184. torchrl/envs/libs/__init__.py +68 -0
  185. torchrl/envs/libs/_gym_utils.py +326 -0
  186. torchrl/envs/libs/brax.py +846 -0
  187. torchrl/envs/libs/dm_control.py +544 -0
  188. torchrl/envs/libs/envpool.py +447 -0
  189. torchrl/envs/libs/gym.py +2239 -0
  190. torchrl/envs/libs/habitat.py +138 -0
  191. torchrl/envs/libs/isaac_lab.py +87 -0
  192. torchrl/envs/libs/isaacgym.py +203 -0
  193. torchrl/envs/libs/jax_utils.py +166 -0
  194. torchrl/envs/libs/jumanji.py +963 -0
  195. torchrl/envs/libs/meltingpot.py +599 -0
  196. torchrl/envs/libs/openml.py +153 -0
  197. torchrl/envs/libs/openspiel.py +652 -0
  198. torchrl/envs/libs/pettingzoo.py +1042 -0
  199. torchrl/envs/libs/procgen.py +351 -0
  200. torchrl/envs/libs/robohive.py +429 -0
  201. torchrl/envs/libs/smacv2.py +645 -0
  202. torchrl/envs/libs/unity_mlagents.py +891 -0
  203. torchrl/envs/libs/utils.py +147 -0
  204. torchrl/envs/libs/vmas.py +813 -0
  205. torchrl/envs/llm/__init__.py +63 -0
  206. torchrl/envs/llm/chat.py +730 -0
  207. torchrl/envs/llm/datasets/README.md +4 -0
  208. torchrl/envs/llm/datasets/__init__.py +17 -0
  209. torchrl/envs/llm/datasets/gsm8k.py +353 -0
  210. torchrl/envs/llm/datasets/ifeval.py +274 -0
  211. torchrl/envs/llm/envs.py +789 -0
  212. torchrl/envs/llm/libs/README.md +3 -0
  213. torchrl/envs/llm/libs/__init__.py +8 -0
  214. torchrl/envs/llm/libs/mlgym.py +869 -0
  215. torchrl/envs/llm/reward/__init__.py +10 -0
  216. torchrl/envs/llm/reward/gsm8k.py +324 -0
  217. torchrl/envs/llm/reward/ifeval/README.md +13 -0
  218. torchrl/envs/llm/reward/ifeval/__init__.py +10 -0
  219. torchrl/envs/llm/reward/ifeval/_instructions.py +1667 -0
  220. torchrl/envs/llm/reward/ifeval/_instructions_main.py +131 -0
  221. torchrl/envs/llm/reward/ifeval/_instructions_registry.py +100 -0
  222. torchrl/envs/llm/reward/ifeval/_instructions_util.py +1677 -0
  223. torchrl/envs/llm/reward/ifeval/_scorer.py +454 -0
  224. torchrl/envs/llm/transforms/__init__.py +55 -0
  225. torchrl/envs/llm/transforms/browser.py +292 -0
  226. torchrl/envs/llm/transforms/dataloading.py +859 -0
  227. torchrl/envs/llm/transforms/format.py +73 -0
  228. torchrl/envs/llm/transforms/kl.py +1544 -0
  229. torchrl/envs/llm/transforms/policy_version.py +189 -0
  230. torchrl/envs/llm/transforms/reason.py +323 -0
  231. torchrl/envs/llm/transforms/tokenizer.py +321 -0
  232. torchrl/envs/llm/transforms/tools.py +1955 -0
  233. torchrl/envs/model_based/__init__.py +9 -0
  234. torchrl/envs/model_based/common.py +180 -0
  235. torchrl/envs/model_based/dreamer.py +112 -0
  236. torchrl/envs/transforms/__init__.py +147 -0
  237. torchrl/envs/transforms/functional.py +48 -0
  238. torchrl/envs/transforms/gym_transforms.py +203 -0
  239. torchrl/envs/transforms/module.py +341 -0
  240. torchrl/envs/transforms/r3m.py +372 -0
  241. torchrl/envs/transforms/ray_service.py +663 -0
  242. torchrl/envs/transforms/rb_transforms.py +214 -0
  243. torchrl/envs/transforms/transforms.py +11835 -0
  244. torchrl/envs/transforms/utils.py +94 -0
  245. torchrl/envs/transforms/vc1.py +307 -0
  246. torchrl/envs/transforms/vecnorm.py +845 -0
  247. torchrl/envs/transforms/vip.py +407 -0
  248. torchrl/envs/utils.py +1718 -0
  249. torchrl/envs/vec_envs.py +11 -0
  250. torchrl/modules/__init__.py +206 -0
  251. torchrl/modules/distributions/__init__.py +73 -0
  252. torchrl/modules/distributions/continuous.py +830 -0
  253. torchrl/modules/distributions/discrete.py +908 -0
  254. torchrl/modules/distributions/truncated_normal.py +187 -0
  255. torchrl/modules/distributions/utils.py +233 -0
  256. torchrl/modules/llm/__init__.py +62 -0
  257. torchrl/modules/llm/backends/__init__.py +65 -0
  258. torchrl/modules/llm/backends/vllm/__init__.py +94 -0
  259. torchrl/modules/llm/backends/vllm/_models.py +46 -0
  260. torchrl/modules/llm/backends/vllm/base.py +72 -0
  261. torchrl/modules/llm/backends/vllm/vllm_async.py +2075 -0
  262. torchrl/modules/llm/backends/vllm/vllm_plugin.py +22 -0
  263. torchrl/modules/llm/backends/vllm/vllm_sync.py +446 -0
  264. torchrl/modules/llm/backends/vllm/vllm_utils.py +129 -0
  265. torchrl/modules/llm/policies/__init__.py +28 -0
  266. torchrl/modules/llm/policies/common.py +1809 -0
  267. torchrl/modules/llm/policies/transformers_wrapper.py +2756 -0
  268. torchrl/modules/llm/policies/vllm_wrapper.py +2241 -0
  269. torchrl/modules/llm/utils.py +23 -0
  270. torchrl/modules/mcts/__init__.py +21 -0
  271. torchrl/modules/mcts/scores.py +579 -0
  272. torchrl/modules/models/__init__.py +86 -0
  273. torchrl/modules/models/batchrenorm.py +119 -0
  274. torchrl/modules/models/decision_transformer.py +179 -0
  275. torchrl/modules/models/exploration.py +731 -0
  276. torchrl/modules/models/llm.py +156 -0
  277. torchrl/modules/models/model_based.py +596 -0
  278. torchrl/modules/models/models.py +1712 -0
  279. torchrl/modules/models/multiagent.py +1067 -0
  280. torchrl/modules/models/recipes/impala.py +185 -0
  281. torchrl/modules/models/utils.py +162 -0
  282. torchrl/modules/planners/__init__.py +10 -0
  283. torchrl/modules/planners/cem.py +228 -0
  284. torchrl/modules/planners/common.py +73 -0
  285. torchrl/modules/planners/mppi.py +265 -0
  286. torchrl/modules/tensordict_module/__init__.py +89 -0
  287. torchrl/modules/tensordict_module/actors.py +2457 -0
  288. torchrl/modules/tensordict_module/common.py +529 -0
  289. torchrl/modules/tensordict_module/exploration.py +814 -0
  290. torchrl/modules/tensordict_module/probabilistic.py +321 -0
  291. torchrl/modules/tensordict_module/rnn.py +1639 -0
  292. torchrl/modules/tensordict_module/sequence.py +132 -0
  293. torchrl/modules/tensordict_module/world_models.py +34 -0
  294. torchrl/modules/utils/__init__.py +38 -0
  295. torchrl/modules/utils/mappings.py +9 -0
  296. torchrl/modules/utils/utils.py +89 -0
  297. torchrl/objectives/__init__.py +78 -0
  298. torchrl/objectives/a2c.py +659 -0
  299. torchrl/objectives/common.py +753 -0
  300. torchrl/objectives/cql.py +1346 -0
  301. torchrl/objectives/crossq.py +710 -0
  302. torchrl/objectives/ddpg.py +453 -0
  303. torchrl/objectives/decision_transformer.py +371 -0
  304. torchrl/objectives/deprecated.py +516 -0
  305. torchrl/objectives/dqn.py +683 -0
  306. torchrl/objectives/dreamer.py +488 -0
  307. torchrl/objectives/functional.py +48 -0
  308. torchrl/objectives/gail.py +258 -0
  309. torchrl/objectives/iql.py +996 -0
  310. torchrl/objectives/llm/__init__.py +30 -0
  311. torchrl/objectives/llm/grpo.py +846 -0
  312. torchrl/objectives/llm/sft.py +482 -0
  313. torchrl/objectives/multiagent/__init__.py +8 -0
  314. torchrl/objectives/multiagent/qmixer.py +396 -0
  315. torchrl/objectives/ppo.py +1669 -0
  316. torchrl/objectives/redq.py +683 -0
  317. torchrl/objectives/reinforce.py +530 -0
  318. torchrl/objectives/sac.py +1580 -0
  319. torchrl/objectives/td3.py +570 -0
  320. torchrl/objectives/td3_bc.py +625 -0
  321. torchrl/objectives/utils.py +782 -0
  322. torchrl/objectives/value/__init__.py +28 -0
  323. torchrl/objectives/value/advantages.py +1956 -0
  324. torchrl/objectives/value/functional.py +1459 -0
  325. torchrl/objectives/value/utils.py +360 -0
  326. torchrl/record/__init__.py +17 -0
  327. torchrl/record/loggers/__init__.py +23 -0
  328. torchrl/record/loggers/common.py +48 -0
  329. torchrl/record/loggers/csv.py +226 -0
  330. torchrl/record/loggers/mlflow.py +142 -0
  331. torchrl/record/loggers/tensorboard.py +139 -0
  332. torchrl/record/loggers/trackio.py +163 -0
  333. torchrl/record/loggers/utils.py +78 -0
  334. torchrl/record/loggers/wandb.py +214 -0
  335. torchrl/record/recorder.py +554 -0
  336. torchrl/services/__init__.py +79 -0
  337. torchrl/services/base.py +109 -0
  338. torchrl/services/ray_service.py +453 -0
  339. torchrl/testing/__init__.py +107 -0
  340. torchrl/testing/assertions.py +179 -0
  341. torchrl/testing/dist_utils.py +122 -0
  342. torchrl/testing/env_creators.py +227 -0
  343. torchrl/testing/env_helper.py +35 -0
  344. torchrl/testing/gym_helpers.py +156 -0
  345. torchrl/testing/llm_mocks.py +119 -0
  346. torchrl/testing/mocking_classes.py +2720 -0
  347. torchrl/testing/modules.py +295 -0
  348. torchrl/testing/mp_helpers.py +15 -0
  349. torchrl/testing/ray_helpers.py +293 -0
  350. torchrl/testing/utils.py +190 -0
  351. torchrl/trainers/__init__.py +42 -0
  352. torchrl/trainers/algorithms/__init__.py +11 -0
  353. torchrl/trainers/algorithms/configs/__init__.py +705 -0
  354. torchrl/trainers/algorithms/configs/collectors.py +216 -0
  355. torchrl/trainers/algorithms/configs/common.py +41 -0
  356. torchrl/trainers/algorithms/configs/data.py +308 -0
  357. torchrl/trainers/algorithms/configs/envs.py +104 -0
  358. torchrl/trainers/algorithms/configs/envs_libs.py +361 -0
  359. torchrl/trainers/algorithms/configs/logging.py +80 -0
  360. torchrl/trainers/algorithms/configs/modules.py +570 -0
  361. torchrl/trainers/algorithms/configs/objectives.py +177 -0
  362. torchrl/trainers/algorithms/configs/trainers.py +340 -0
  363. torchrl/trainers/algorithms/configs/transforms.py +955 -0
  364. torchrl/trainers/algorithms/configs/utils.py +252 -0
  365. torchrl/trainers/algorithms/configs/weight_sync_schemes.py +191 -0
  366. torchrl/trainers/algorithms/configs/weight_update.py +159 -0
  367. torchrl/trainers/algorithms/ppo.py +373 -0
  368. torchrl/trainers/algorithms/sac.py +308 -0
  369. torchrl/trainers/helpers/__init__.py +40 -0
  370. torchrl/trainers/helpers/collectors.py +416 -0
  371. torchrl/trainers/helpers/envs.py +573 -0
  372. torchrl/trainers/helpers/logger.py +33 -0
  373. torchrl/trainers/helpers/losses.py +132 -0
  374. torchrl/trainers/helpers/models.py +658 -0
  375. torchrl/trainers/helpers/replay_buffer.py +59 -0
  376. torchrl/trainers/helpers/trainers.py +301 -0
  377. torchrl/trainers/trainers.py +2052 -0
  378. torchrl/weight_update/__init__.py +33 -0
  379. torchrl/weight_update/_distributed.py +749 -0
  380. torchrl/weight_update/_mp.py +624 -0
  381. torchrl/weight_update/_noupdate.py +102 -0
  382. torchrl/weight_update/_ray.py +1032 -0
  383. torchrl/weight_update/_rpc.py +284 -0
  384. torchrl/weight_update/_shared.py +891 -0
  385. torchrl/weight_update/llm/__init__.py +32 -0
  386. torchrl/weight_update/llm/vllm_double_buffer.py +370 -0
  387. torchrl/weight_update/llm/vllm_nccl.py +710 -0
  388. torchrl/weight_update/utils.py +73 -0
  389. torchrl/weight_update/weight_sync_schemes.py +1244 -0
  390. torchrl-0.11.0.dist-info/METADATA +1308 -0
  391. torchrl-0.11.0.dist-info/RECORD +395 -0
  392. torchrl-0.11.0.dist-info/WHEEL +5 -0
  393. torchrl-0.11.0.dist-info/entry_points.txt +2 -0
  394. torchrl-0.11.0.dist-info/licenses/LICENSE +21 -0
  395. torchrl-0.11.0.dist-info/top_level.txt +7 -0
@@ -0,0 +1,645 @@
1
+ # Copyright (c) Meta Platforms, Inc. and affiliates.
2
+ #
3
+ # This source code is licensed under the MIT license found in the
4
+ # LICENSE file in the root directory of this source tree.
5
+ from __future__ import annotations
6
+
7
+ import importlib
8
+ import re
9
+
10
+ import torch
11
+ from tensordict import TensorDict, TensorDictBase
12
+
13
+ from torchrl.data.tensor_specs import Bounded, Categorical, Composite, OneHot, Unbounded
14
+ from torchrl.envs.common import _EnvWrapper
15
+
16
+ from torchrl.envs.utils import _classproperty, ACTION_MASK_ERROR
17
+
18
+ _has_smacv2 = importlib.util.find_spec("smacv2") is not None
19
+
20
+
21
+ def _get_envs():
22
+ if not _has_smacv2:
23
+ raise ImportError("SMAC-v2 is not installed in your virtual environment.")
24
+ from smacv2.env.starcraft2.maps import smac_maps
25
+
26
+ return list(smac_maps.get_smac_map_registry().keys())
27
+
28
+
29
+ class SMACv2Wrapper(_EnvWrapper):
30
+ """SMACv2 (StarCraft Multi-Agent Challenge v2) environment wrapper.
31
+
32
+ To install the environment follow the following `guide <https://github.com/oxwhirl/smacv2#getting-started>`__.
33
+
34
+ Examples:
35
+ >>> from torchrl.envs.libs.smacv2 import SMACv2Wrapper
36
+ >>> import smacv2
37
+ >>> print(SMACv2Wrapper.available_envs)
38
+ ['10gen_terran', '10gen_zerg', '10gen_protoss', '3m', '8m', '25m', '5m_vs_6m', '8m_vs_9m', '10m_vs_11m',
39
+ '27m_vs_30m', 'MMM', 'MMM2', '2s3z', '3s5z', '3s5z_vs_3s6z', '3s_vs_3z', '3s_vs_4z', '3s_vs_5z', '1c3s5z',
40
+ '2m_vs_1z', 'corridor', '6h_vs_8z', '2s_vs_1sc', 'so_many_baneling', 'bane_vs_bane', '2c_vs_64zg']
41
+ >>> # You can use old SMAC maps
42
+ >>> env = SMACv2Wrapper(smacv2.env.StarCraft2Env(map_name="MMM2"), categorical_actions=False)
43
+ >>> print(env.rollout(5))
44
+ TensorDict(
45
+ fields={
46
+ agents: TensorDict(
47
+ fields={
48
+ action: Tensor(shape=torch.Size([5, 10, 18]), device=cpu, dtype=torch.int64, is_shared=False),
49
+ action_mask: Tensor(shape=torch.Size([5, 10, 18]), device=cpu, dtype=torch.bool, is_shared=False),
50
+ observation: Tensor(shape=torch.Size([5, 10, 176]), device=cpu, dtype=torch.float32, is_shared=False)},
51
+ batch_size=torch.Size([5, 10]),
52
+ device=cpu,
53
+ is_shared=False),
54
+ done: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.bool, is_shared=False),
55
+ info: TensorDict(
56
+ fields={
57
+ battle_won: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.bool, is_shared=False),
58
+ dead_allies: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int64, is_shared=False),
59
+ dead_enemies: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int64, is_shared=False),
60
+ episode_limit: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.bool, is_shared=False)},
61
+ batch_size=torch.Size([5]),
62
+ device=cpu,
63
+ is_shared=False),
64
+ next: TensorDict(
65
+ fields={
66
+ agents: TensorDict(
67
+ fields={
68
+ action_mask: Tensor(shape=torch.Size([5, 10, 18]), device=cpu, dtype=torch.bool, is_shared=False),
69
+ observation: Tensor(shape=torch.Size([5, 10, 176]), device=cpu, dtype=torch.float32, is_shared=False)},
70
+ batch_size=torch.Size([5, 10]),
71
+ device=cpu,
72
+ is_shared=False),
73
+ done: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.bool, is_shared=False),
74
+ info: TensorDict(
75
+ fields={
76
+ battle_won: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.bool, is_shared=False),
77
+ dead_allies: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int64, is_shared=False),
78
+ dead_enemies: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int64, is_shared=False),
79
+ episode_limit: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.bool, is_shared=False)},
80
+ batch_size=torch.Size([5]),
81
+ device=cpu,
82
+ is_shared=False),
83
+ reward: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.float32, is_shared=False),
84
+ state: Tensor(shape=torch.Size([5, 322]), device=cpu, dtype=torch.float32, is_shared=False),
85
+ terminated: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
86
+ batch_size=torch.Size([5]),
87
+ device=cpu,
88
+ is_shared=False),
89
+ state: Tensor(shape=torch.Size([5, 322]), device=cpu, dtype=torch.float32, is_shared=False),
90
+ terminated: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
91
+ batch_size=torch.Size([5]),
92
+ device=cpu,
93
+ is_shared=False)
94
+ >>> # Or the new features for procedural generation
95
+ >>> distribution_config = {
96
+ ... "n_units": 5,
97
+ ... "n_enemies": 6,
98
+ ... "team_gen": {
99
+ ... "dist_type": "weighted_teams",
100
+ ... "unit_types": ["marine", "marauder", "medivac"],
101
+ ... "exception_unit_types": ["medivac"],
102
+ ... "weights": [0.5, 0.2, 0.3],
103
+ ... "observe": True,
104
+ ... },
105
+ ... "start_positions": {
106
+ ... "dist_type": "surrounded_and_reflect",
107
+ ... "p": 0.5,
108
+ ... "n_enemies": 5,
109
+ ... "map_x": 32,
110
+ ... "map_y": 32,
111
+ ... },
112
+ ... }
113
+ >>> env = SMACv2Wrapper(
114
+ ... smacv2.env.StarCraft2Env(
115
+ ... map_name="10gen_terran",
116
+ ... capability_config=distribution_config,
117
+ ... )
118
+ ... )
119
+ >>> print(env.rollout(4))
120
+ TensorDict(
121
+ fields={
122
+ agents: TensorDict(
123
+ fields={
124
+ action: Tensor(shape=torch.Size([4, 5, 12]), device=cpu, dtype=torch.int64, is_shared=False),
125
+ action_mask: Tensor(shape=torch.Size([4, 5, 12]), device=cpu, dtype=torch.bool, is_shared=False),
126
+ observation: Tensor(shape=torch.Size([4, 5, 88]), device=cpu, dtype=torch.float32, is_shared=False)},
127
+ batch_size=torch.Size([4, 5]),
128
+ device=cpu,
129
+ is_shared=False),
130
+ done: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.bool, is_shared=False),
131
+ info: TensorDict(
132
+ fields={
133
+ battle_won: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.bool, is_shared=False),
134
+ dead_allies: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.int64, is_shared=False),
135
+ dead_enemies: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.int64, is_shared=False),
136
+ episode_limit: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.bool, is_shared=False)},
137
+ batch_size=torch.Size([4]),
138
+ device=cpu,
139
+ is_shared=False),
140
+ next: TensorDict(
141
+ fields={
142
+ agents: TensorDict(
143
+ fields={
144
+ action_mask: Tensor(shape=torch.Size([4, 5, 12]), device=cpu, dtype=torch.bool, is_shared=False),
145
+ observation: Tensor(shape=torch.Size([4, 5, 88]), device=cpu, dtype=torch.float32, is_shared=False)},
146
+ batch_size=torch.Size([4, 5]),
147
+ device=cpu,
148
+ is_shared=False),
149
+ done: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.bool, is_shared=False),
150
+ info: TensorDict(
151
+ fields={
152
+ battle_won: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.bool, is_shared=False),
153
+ dead_allies: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.int64, is_shared=False),
154
+ dead_enemies: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.int64, is_shared=False),
155
+ episode_limit: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.bool, is_shared=False)},
156
+ batch_size=torch.Size([4]),
157
+ device=cpu,
158
+ is_shared=False),
159
+ reward: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.float32, is_shared=False),
160
+ state: Tensor(shape=torch.Size([4, 131]), device=cpu, dtype=torch.float32, is_shared=False),
161
+ terminated: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
162
+ batch_size=torch.Size([4]),
163
+ device=cpu,
164
+ is_shared=False),
165
+ state: Tensor(shape=torch.Size([4, 131]), device=cpu, dtype=torch.float32, is_shared=False),
166
+ terminated: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
167
+ batch_size=torch.Size([4]),
168
+ device=cpu,
169
+ is_shared=False)
170
+ """
171
+
172
+ git_url = "https://github.com/oxwhirl/smacv2"
173
+ libname = "smacv2"
174
+
175
+ @_classproperty
176
+ def available_envs(cls):
177
+ if not _has_smacv2:
178
+ return []
179
+ return list(_get_envs())
180
+
181
+ def __init__(
182
+ self,
183
+ env: smacv2.env.StarCraft2Env = None, # noqa: F821
184
+ categorical_actions: bool = True,
185
+ **kwargs,
186
+ ):
187
+ if env is not None:
188
+ kwargs["env"] = env
189
+ self.categorical_actions = categorical_actions
190
+
191
+ super().__init__(**kwargs)
192
+
193
+ @property
194
+ def lib(self):
195
+ import smacv2
196
+
197
+ return smacv2
198
+
199
+ def _check_kwargs(self, kwargs: dict):
200
+ import smacv2
201
+
202
+ if "env" not in kwargs:
203
+ raise TypeError("Could not find environment key 'env' in kwargs.")
204
+ env = kwargs["env"]
205
+ if not isinstance(env, smacv2.env.StarCraft2Env):
206
+ raise TypeError("env is not of type 'smacv2.env.StarCraft2Env'.")
207
+
208
+ def _build_env(
209
+ self,
210
+ env: smacv2.env.StarCraft2Env, # noqa: F821
211
+ ):
212
+ if len(self.batch_size):
213
+ raise RuntimeError(
214
+ f"SMACv2 does not support custom batch_size {self.batch_size}."
215
+ )
216
+
217
+ return env
218
+
219
+ def _make_specs(self, env: smacv2.env.StarCraft2Env) -> None: # noqa: F821
220
+ self.group_map = {"agents": [str(i) for i in range(self.n_agents)]}
221
+ self.reward_spec = Unbounded(
222
+ shape=torch.Size((1,)),
223
+ device=self.device,
224
+ )
225
+ self.done_spec = Categorical(
226
+ n=2,
227
+ shape=torch.Size((1,)),
228
+ dtype=torch.bool,
229
+ device=self.device,
230
+ )
231
+ self.full_action_spec = self._make_action_spec()
232
+ self.observation_spec = self._make_observation_spec()
233
+
234
+ def _init_env(self) -> None:
235
+ self._env.reset()
236
+ self._update_action_mask()
237
+
238
+ def _make_action_spec(self) -> Composite:
239
+ if self.categorical_actions:
240
+ action_spec = Categorical(
241
+ self.n_actions,
242
+ shape=torch.Size((self.n_agents,)),
243
+ device=self.device,
244
+ dtype=torch.long,
245
+ )
246
+ else:
247
+ action_spec = OneHot(
248
+ self.n_actions,
249
+ shape=torch.Size((self.n_agents, self.n_actions)),
250
+ device=self.device,
251
+ dtype=torch.long,
252
+ )
253
+ spec = Composite(
254
+ {
255
+ "agents": Composite(
256
+ {"action": action_spec}, shape=torch.Size((self.n_agents,))
257
+ )
258
+ }
259
+ )
260
+ return spec
261
+
262
+ def _make_observation_spec(self) -> Composite:
263
+ obs_spec = Bounded(
264
+ low=-1.0,
265
+ high=1.0,
266
+ shape=torch.Size([self.n_agents, self.get_obs_size()]),
267
+ device=self.device,
268
+ dtype=torch.float32,
269
+ )
270
+ info_spec = Composite(
271
+ {
272
+ "battle_won": Categorical(2, dtype=torch.bool, device=self.device),
273
+ "episode_limit": Categorical(2, dtype=torch.bool, device=self.device),
274
+ "dead_allies": Bounded(
275
+ low=0,
276
+ high=self.n_agents,
277
+ dtype=torch.long,
278
+ device=self.device,
279
+ shape=(),
280
+ ),
281
+ "dead_enemies": Bounded(
282
+ low=0,
283
+ high=self.n_enemies,
284
+ dtype=torch.long,
285
+ device=self.device,
286
+ shape=(),
287
+ ),
288
+ }
289
+ )
290
+ mask_spec = Categorical(
291
+ 2,
292
+ torch.Size([self.n_agents, self.n_actions]),
293
+ device=self.device,
294
+ dtype=torch.bool,
295
+ )
296
+ spec = Composite(
297
+ {
298
+ "agents": Composite(
299
+ {"observation": obs_spec, "action_mask": mask_spec},
300
+ shape=torch.Size((self.n_agents,)),
301
+ ),
302
+ "state": Bounded(
303
+ low=-1.0,
304
+ high=1.0,
305
+ shape=torch.Size((self.get_state_size(),)),
306
+ device=self.device,
307
+ dtype=torch.float32,
308
+ ),
309
+ "info": info_spec,
310
+ }
311
+ )
312
+ return spec
313
+
314
+ def _set_seed(self, seed: int | None) -> None:
315
+ if seed is not None:
316
+ raise NotImplementedError(
317
+ "Seed cannot be changed once environment was created."
318
+ )
319
+
320
+ def get_obs(self):
321
+ obs = self._env.get_obs()
322
+ return self._to_tensor(obs)
323
+
324
+ def get_state(self):
325
+ state = self._env.get_state()
326
+ return self._to_tensor(state)
327
+
328
+ def _to_tensor(self, value):
329
+ return torch.tensor(value, device=self.device, dtype=torch.float32)
330
+
331
+ def _reset(
332
+ self, tensordict: TensorDictBase | None = None, **kwargs
333
+ ) -> TensorDictBase:
334
+
335
+ obs, state = self._env.reset()
336
+
337
+ # collect outputs
338
+ obs = self._to_tensor(obs)
339
+ state = self._to_tensor(state)
340
+ info = self.observation_spec["info"].zero()
341
+
342
+ mask = self._update_action_mask()
343
+
344
+ # build results
345
+ agents_td = TensorDict(
346
+ {"observation": obs, "action_mask": mask}, batch_size=(self.n_agents,)
347
+ )
348
+ tensordict_out = TensorDict(
349
+ source={"agents": agents_td, "state": state, "info": info},
350
+ batch_size=(),
351
+ device=self.device,
352
+ )
353
+
354
+ return tensordict_out
355
+
356
+ def _step(self, tensordict: TensorDictBase) -> TensorDictBase:
357
+ # perform actions
358
+ action = tensordict.get(("agents", "action"))
359
+ action_np = self.full_action_spec[self.action_key].to_numpy(action)
360
+
361
+ # Actions are validated by the environment.
362
+ try:
363
+ reward, done, info = self._env.step(action_np)
364
+ except AssertionError as err:
365
+ if re.match(r"Agent . cannot perform action .", str(err)):
366
+ raise ACTION_MASK_ERROR
367
+ else:
368
+ raise err
369
+
370
+ # collect outputs
371
+ obs = self.get_obs()
372
+ state = self.get_state()
373
+ info = self.observation_spec["info"].encode(info)
374
+ actual_keys = info.keys()
375
+ for expected_key, spec in self.observation_spec["info"].items():
376
+ if expected_key not in actual_keys:
377
+ info[expected_key] = spec.zero()
378
+
379
+ reward = torch.tensor(
380
+ reward, device=self.device, dtype=torch.float32
381
+ ).unsqueeze(-1)
382
+ done = torch.tensor(done, device=self.device, dtype=torch.bool).unsqueeze(-1)
383
+
384
+ mask = self._update_action_mask()
385
+
386
+ # build results
387
+ agents_td = TensorDict(
388
+ {"observation": obs, "action_mask": mask}, batch_size=(self.n_agents,)
389
+ )
390
+
391
+ tensordict_out = TensorDict(
392
+ source={
393
+ "agents": agents_td,
394
+ "state": state,
395
+ "info": info,
396
+ "reward": reward,
397
+ "done": done,
398
+ "terminated": done.clone(),
399
+ },
400
+ batch_size=(),
401
+ device=self.device,
402
+ )
403
+
404
+ return tensordict_out
405
+
406
+ def _update_action_mask(self):
407
+ mask = torch.tensor(
408
+ self.get_avail_actions(), dtype=torch.bool, device=self.device
409
+ )
410
+ self.full_action_spec[self.action_key].update_mask(mask)
411
+ return mask
412
+
413
+ def close(self, *, raise_if_closed: bool = True):
414
+ # Closes StarCraft II
415
+ self._env.close()
416
+
417
+ def get_agent_type(self, agent_index: int) -> str:
418
+ """Get the agent type string.
419
+
420
+ Given the agent index, get its unit type name.
421
+
422
+ Args:
423
+ agent_index (int): the index of the agent to get the type of
424
+
425
+ """
426
+ if agent_index < 0 or agent_index >= self.n_agents:
427
+ raise ValueError(f"Agent index out of range, {self.n_agents} available")
428
+
429
+ agent_info = self.agents[agent_index]
430
+ if agent_info.unit_type == self.marine_id:
431
+ return "marine"
432
+ elif agent_info.unit_type == self.marauder_id:
433
+ return "marauder"
434
+ elif agent_info.unit_type == self.medivac_id:
435
+ return "medivac"
436
+ elif agent_info.unit_type == self.hydralisk_id:
437
+ return "hydralisk"
438
+ elif agent_info.unit_type == self.zergling_id:
439
+ return "zergling"
440
+ elif agent_info.unit_type == self.baneling_id:
441
+ return "baneling"
442
+ elif agent_info.unit_type == self.stalker_id:
443
+ return "stalker"
444
+ elif agent_info.unit_type == self.colossus_id:
445
+ return "colossus"
446
+ elif agent_info.unit_type == self.zealot_id:
447
+ return "zealot"
448
+ else:
449
+ raise AssertionError(f"Agent type {agent_info.unit_type} unidentified")
450
+
451
+ # This patches the bug in https://github.com/oxwhirl/smacv2/issues/33
452
+ def render(self, mode: str = "human"):
453
+ import smacv2
454
+
455
+ if isinstance(self._env, smacv2.env.StarCraftCapabilityEnvWrapper):
456
+ return self._env.env.render(mode=mode)
457
+ else:
458
+ return self._env.render(mode=mode)
459
+
460
+
461
+ class SMACv2Env(SMACv2Wrapper):
462
+ """SMACv2 (StarCraft Multi-Agent Challenge v2) environment wrapper.
463
+
464
+ To install the environment follow the following `guide <https://github.com/oxwhirl/smacv2#getting-started>`__.
465
+
466
+ Examples:
467
+ >>> from torchrl.envs.libs.smacv2 import SMACv2Env
468
+ >>> print(SMACv2Env.available_envs)
469
+ ['10gen_terran', '10gen_zerg', '10gen_protoss', '3m', '8m', '25m', '5m_vs_6m', '8m_vs_9m', '10m_vs_11m',
470
+ '27m_vs_30m', 'MMM', 'MMM2', '2s3z', '3s5z', '3s5z_vs_3s6z', '3s_vs_3z', '3s_vs_4z', '3s_vs_5z', '1c3s5z',
471
+ '2m_vs_1z', 'corridor', '6h_vs_8z', '2s_vs_1sc', 'so_many_baneling', 'bane_vs_bane', '2c_vs_64zg']
472
+ >>> # You can use old SMAC maps
473
+ >>> env = SMACv2Env(map_name="MMM2")
474
+ >>> print(env.rollout(5)
475
+ TensorDict(
476
+ fields={
477
+ agents: TensorDict(
478
+ fields={
479
+ action: Tensor(shape=torch.Size([5, 10, 18]), device=cpu, dtype=torch.int64, is_shared=False),
480
+ action_mask: Tensor(shape=torch.Size([5, 10, 18]), device=cpu, dtype=torch.bool, is_shared=False),
481
+ observation: Tensor(shape=torch.Size([5, 10, 176]), device=cpu, dtype=torch.float32, is_shared=False)},
482
+ batch_size=torch.Size([5, 10]),
483
+ device=cpu,
484
+ is_shared=False),
485
+ done: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.bool, is_shared=False),
486
+ info: TensorDict(
487
+ fields={
488
+ battle_won: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.bool, is_shared=False),
489
+ dead_allies: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int64, is_shared=False),
490
+ dead_enemies: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int64, is_shared=False),
491
+ episode_limit: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.bool, is_shared=False)},
492
+ batch_size=torch.Size([5]),
493
+ device=cpu,
494
+ is_shared=False),
495
+ next: TensorDict(
496
+ fields={
497
+ agents: TensorDict(
498
+ fields={
499
+ action_mask: Tensor(shape=torch.Size([5, 10, 18]), device=cpu, dtype=torch.bool, is_shared=False),
500
+ observation: Tensor(shape=torch.Size([5, 10, 176]), device=cpu, dtype=torch.float32, is_shared=False)},
501
+ batch_size=torch.Size([5, 10]),
502
+ device=cpu,
503
+ is_shared=False),
504
+ done: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.bool, is_shared=False),
505
+ info: TensorDict(
506
+ fields={
507
+ battle_won: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.bool, is_shared=False),
508
+ dead_allies: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int64, is_shared=False),
509
+ dead_enemies: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.int64, is_shared=False),
510
+ episode_limit: Tensor(shape=torch.Size([5]), device=cpu, dtype=torch.bool, is_shared=False)},
511
+ batch_size=torch.Size([5]),
512
+ device=cpu,
513
+ is_shared=False),
514
+ reward: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.float32, is_shared=False),
515
+ state: Tensor(shape=torch.Size([5, 322]), device=cpu, dtype=torch.float32, is_shared=False),
516
+ terminated: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
517
+ batch_size=torch.Size([5]),
518
+ device=cpu,
519
+ is_shared=False),
520
+ state: Tensor(shape=torch.Size([5, 322]), device=cpu, dtype=torch.float32, is_shared=False),
521
+ terminated: Tensor(shape=torch.Size([5, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
522
+ batch_size=torch.Size([5]),
523
+ device=cpu,
524
+ is_shared=False)
525
+ >>> # Or the new features for procedural generation
526
+ >>> distribution_config = {
527
+ ... "n_units": 5,
528
+ ... "n_enemies": 6,
529
+ ... "team_gen": {
530
+ ... "dist_type": "weighted_teams",
531
+ ... "unit_types": ["marine", "marauder", "medivac"],
532
+ ... "exception_unit_types": ["medivac"],
533
+ ... "weights": [0.5, 0.2, 0.3],
534
+ ... "observe": True,
535
+ ... },
536
+ ... "start_positions": {
537
+ ... "dist_type": "surrounded_and_reflect",
538
+ ... "p": 0.5,
539
+ ... "n_enemies": 5,
540
+ ... "map_x": 32,
541
+ ... "map_y": 32,
542
+ ... },
543
+ ... }
544
+ >>> env = SMACv2Env(
545
+ ... map_name="10gen_terran",
546
+ ... capability_config=distribution_config,
547
+ ... categorical_actions=False,
548
+ ... )
549
+ >>> print(env.rollout(4))
550
+ TensorDict(
551
+ fields={
552
+ agents: TensorDict(
553
+ fields={
554
+ action: Tensor(shape=torch.Size([4, 5, 12]), device=cpu, dtype=torch.int64, is_shared=False),
555
+ action_mask: Tensor(shape=torch.Size([4, 5, 12]), device=cpu, dtype=torch.bool, is_shared=False),
556
+ observation: Tensor(shape=torch.Size([4, 5, 88]), device=cpu, dtype=torch.float32, is_shared=False)},
557
+ batch_size=torch.Size([4, 5]),
558
+ device=cpu,
559
+ is_shared=False),
560
+ done: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.bool, is_shared=False),
561
+ info: TensorDict(
562
+ fields={
563
+ battle_won: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.bool, is_shared=False),
564
+ dead_allies: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.int64, is_shared=False),
565
+ dead_enemies: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.int64, is_shared=False),
566
+ episode_limit: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.bool, is_shared=False)},
567
+ batch_size=torch.Size([4]),
568
+ device=cpu,
569
+ is_shared=False),
570
+ next: TensorDict(
571
+ fields={
572
+ agents: TensorDict(
573
+ fields={
574
+ action_mask: Tensor(shape=torch.Size([4, 5, 12]), device=cpu, dtype=torch.bool, is_shared=False),
575
+ observation: Tensor(shape=torch.Size([4, 5, 88]), device=cpu, dtype=torch.float32, is_shared=False)},
576
+ batch_size=torch.Size([4, 5]),
577
+ device=cpu,
578
+ is_shared=False),
579
+ done: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.bool, is_shared=False),
580
+ info: TensorDict(
581
+ fields={
582
+ battle_won: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.bool, is_shared=False),
583
+ dead_allies: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.int64, is_shared=False),
584
+ dead_enemies: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.int64, is_shared=False),
585
+ episode_limit: Tensor(shape=torch.Size([4]), device=cpu, dtype=torch.bool, is_shared=False)},
586
+ batch_size=torch.Size([4]),
587
+ device=cpu,
588
+ is_shared=False),
589
+ reward: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.float32, is_shared=False),
590
+ state: Tensor(shape=torch.Size([4, 131]), device=cpu, dtype=torch.float32, is_shared=False),
591
+ terminated: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
592
+ batch_size=torch.Size([4]),
593
+ device=cpu,
594
+ is_shared=False),
595
+ state: Tensor(shape=torch.Size([4, 131]), device=cpu, dtype=torch.float32, is_shared=False),
596
+ terminated: Tensor(shape=torch.Size([4, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
597
+ batch_size=torch.Size([4]),
598
+ device=cpu,
599
+ is_shared=False)
600
+ """
601
+
602
+ def __init__(
603
+ self,
604
+ map_name: str,
605
+ capability_config: dict | None = None,
606
+ seed: int | None = None,
607
+ categorical_actions: bool = True,
608
+ **kwargs,
609
+ ):
610
+ if not _has_smacv2:
611
+ raise ImportError(
612
+ f"smacv2 python package was not found. Please install this dependency. "
613
+ f"More info: {self.git_url}."
614
+ )
615
+ kwargs["map_name"] = map_name
616
+ kwargs["capability_config"] = capability_config
617
+ kwargs["seed"] = seed
618
+ kwargs["categorical_actions"] = categorical_actions
619
+
620
+ super().__init__(**kwargs)
621
+
622
+ def _check_kwargs(self, kwargs: dict):
623
+ if "map_name" not in kwargs:
624
+ raise TypeError("Expected 'map_name' to be part of kwargs")
625
+
626
+ def _build_env(
627
+ self,
628
+ map_name: str,
629
+ capability_config: dict | None = None,
630
+ seed: int | None = None,
631
+ **kwargs,
632
+ ) -> smacv2.env.StarCraft2Env: # noqa: F821
633
+ import smacv2.env
634
+
635
+ if capability_config is not None:
636
+ env = smacv2.env.StarCraftCapabilityEnvWrapper(
637
+ capability_config=capability_config,
638
+ map_name=map_name,
639
+ seed=seed,
640
+ **kwargs,
641
+ )
642
+ else:
643
+ env = smacv2.env.StarCraft2Env(map_name=map_name, seed=seed, **kwargs)
644
+
645
+ return super()._build_env(env)