kinalmehta commited on
Commit
3d37624
1 Parent(s): 98e2860

pushing model

Browse files
.gitattributes CHANGED
@@ -32,3 +32,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
32
  *.zip filter=lfs diff=lfs merge=lfs -text
33
  *.zst filter=lfs diff=lfs merge=lfs -text
34
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
32
  *.zip filter=lfs diff=lfs merge=lfs -text
33
  *.zst filter=lfs diff=lfs merge=lfs -text
34
  *tfevents* filter=lfs diff=lfs merge=lfs -text
35
+ c51_atari_jax.cleanrl_model filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,79 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - BreakoutNoFrameskip-v4
4
+ - deep-reinforcement-learning
5
+ - reinforcement-learning
6
+ - custom-implementation
7
+ library_name: cleanrl
8
+ model-index:
9
+ - name: DQN
10
+ results:
11
+ - task:
12
+ type: reinforcement-learning
13
+ name: reinforcement-learning
14
+ dataset:
15
+ name: BreakoutNoFrameskip-v4
16
+ type: BreakoutNoFrameskip-v4
17
+ metrics:
18
+ - type: mean_reward
19
+ value: 318.10 +/- 112.21
20
+ name: mean_reward
21
+ verified: false
22
+ ---
23
+
24
+ # (CleanRL) **DQN** Agent Playing **BreakoutNoFrameskip-v4**
25
+
26
+ This is a trained model of a DQN agent playing BreakoutNoFrameskip-v4.
27
+ The model was trained by using [CleanRL](https://github.com/vwxyzjn/cleanrl) and the most up-to-date training code can be
28
+ found [here](https://github.com/vwxyzjn/cleanrl/blob/master/cleanrl/c51_atari_jax.py).
29
+
30
+ ## Get Started
31
+
32
+ To use this model, please install the `cleanrl` package with the following command:
33
+
34
+ ```
35
+ pip install "cleanrl[c51_atari_jax]"
36
+ python -m cleanrl_utils.enjoy --exp-name c51_atari_jax --env-id BreakoutNoFrameskip-v4
37
+ ```
38
+
39
+ Please refer to the [documentation](https://docs.cleanrl.dev/get-started/zoo/) for more detail.
40
+
41
+
42
+ ## Command to reproduce the training
43
+
44
+ ```bash
45
+ curl -OL https://huggingface.co/kinalmehta/BreakoutNoFrameskip-v4-c51_atari_jax-seed1/raw/main/c51_atari_jax.py
46
+ curl -OL https://huggingface.co/kinalmehta/BreakoutNoFrameskip-v4-c51_atari_jax-seed1/raw/main/pyproject.toml
47
+ curl -OL https://huggingface.co/kinalmehta/BreakoutNoFrameskip-v4-c51_atari_jax-seed1/raw/main/poetry.lock
48
+ poetry install --all-extras
49
+ python c51_atari_jax.py --save-model --upload-model --hf-entity kinalmehta --env-id BreakoutNoFrameskip-v4
50
+ ```
51
+
52
+ # Hyperparameters
53
+ ```python
54
+ {'batch_size': 32,
55
+ 'buffer_size': 1000000,
56
+ 'capture_video': False,
57
+ 'end_e': 0.01,
58
+ 'env_id': 'BreakoutNoFrameskip-v4',
59
+ 'exp_name': 'c51_atari_jax',
60
+ 'exploration_fraction': 0.1,
61
+ 'gamma': 0.99,
62
+ 'hf_entity': 'kinalmehta',
63
+ 'learning_rate': 0.00025,
64
+ 'learning_starts': 80000,
65
+ 'n_atoms': 51,
66
+ 'save_model': True,
67
+ 'seed': 1,
68
+ 'start_e': 1,
69
+ 'target_network_frequency': 10000,
70
+ 'total_timesteps': 10000000,
71
+ 'track': False,
72
+ 'train_frequency': 4,
73
+ 'upload_model': True,
74
+ 'v_max': 10,
75
+ 'v_min': -10,
76
+ 'wandb_entity': None,
77
+ 'wandb_project_name': 'cleanRL'}
78
+ ```
79
+
c51_atari_jax.cleanrl_model ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:b4c53c8c75c10dc9472efbfb3d2e0a3a1bba8a0970148fba9195a3109e498090
3
+ size 7155869
c51_atari_jax.py ADDED
@@ -0,0 +1,337 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # docs and experiment results can be found at https://docs.cleanrl.dev/rl-algorithms/c51/#c51_atari_jaxpy
2
+ import argparse
3
+ import os
4
+ import random
5
+ import time
6
+ from distutils.util import strtobool
7
+
8
+ os.environ[
9
+ "XLA_PYTHON_CLIENT_MEM_FRACTION"
10
+ ] = "0.7" # see https://github.com/google/jax/discussions/6332#discussioncomment-1279991
11
+
12
+ import flax
13
+ import flax.linen as nn
14
+ import gym
15
+ import jax
16
+ import jax.numpy as jnp
17
+ import numpy as np
18
+ import optax
19
+ from flax.training.train_state import TrainState
20
+ from stable_baselines3.common.atari_wrappers import (
21
+ ClipRewardEnv,
22
+ EpisodicLifeEnv,
23
+ FireResetEnv,
24
+ MaxAndSkipEnv,
25
+ NoopResetEnv,
26
+ )
27
+ from stable_baselines3.common.buffers import ReplayBuffer
28
+ from torch.utils.tensorboard import SummaryWriter
29
+
30
+
31
+ def parse_args():
32
+ # fmt: off
33
+ parser = argparse.ArgumentParser()
34
+ parser.add_argument("--exp-name", type=str, default=os.path.basename(__file__).rstrip(".py"),
35
+ help="the name of this experiment")
36
+ parser.add_argument("--seed", type=int, default=1,
37
+ help="seed of the experiment")
38
+ parser.add_argument("--track", type=lambda x: bool(strtobool(x)), default=False, nargs="?", const=True,
39
+ help="if toggled, this experiment will be tracked with Weights and Biases")
40
+ parser.add_argument("--wandb-project-name", type=str, default="cleanRL",
41
+ help="the wandb's project name")
42
+ parser.add_argument("--wandb-entity", type=str, default=None,
43
+ help="the entity (team) of wandb's project")
44
+ parser.add_argument("--capture-video", type=lambda x: bool(strtobool(x)), default=False, nargs="?", const=True,
45
+ help="whether to capture videos of the agent performances (check out `videos` folder)")
46
+ parser.add_argument("--save-model", type=lambda x: bool(strtobool(x)), default=False, nargs="?", const=True,
47
+ help="whether to save model into the `runs/{run_name}` folder")
48
+ parser.add_argument("--upload-model", type=lambda x: bool(strtobool(x)), default=False, nargs="?", const=True,
49
+ help="whether to upload the saved model to huggingface")
50
+ parser.add_argument("--hf-entity", type=str, default="",
51
+ help="the user or org name of the model repository from the Hugging Face Hub")
52
+
53
+ # Algorithm specific arguments
54
+ parser.add_argument("--env-id", type=str, default="BreakoutNoFrameskip-v4",
55
+ help="the id of the environment")
56
+ parser.add_argument("--total-timesteps", type=int, default=10000000,
57
+ help="total timesteps of the experiments")
58
+ parser.add_argument("--learning-rate", type=float, default=2.5e-4,
59
+ help="the learning rate of the optimizer")
60
+ parser.add_argument("--n-atoms", type=int, default=51,
61
+ help="the number of atoms")
62
+ parser.add_argument("--v-min", type=float, default=-10,
63
+ help="the number of atoms")
64
+ parser.add_argument("--v-max", type=float, default=10,
65
+ help="the number of atoms")
66
+ parser.add_argument("--buffer-size", type=int, default=1000000,
67
+ help="the replay memory buffer size")
68
+ parser.add_argument("--gamma", type=float, default=0.99,
69
+ help="the discount factor gamma")
70
+ parser.add_argument("--target-network-frequency", type=int, default=10000,
71
+ help="the timesteps it takes to update the target network")
72
+ parser.add_argument("--batch-size", type=int, default=32,
73
+ help="the batch size of sample from the reply memory")
74
+ parser.add_argument("--start-e", type=float, default=1,
75
+ help="the starting epsilon for exploration")
76
+ parser.add_argument("--end-e", type=float, default=0.01,
77
+ help="the ending epsilon for exploration")
78
+ parser.add_argument("--exploration-fraction", type=float, default=0.1,
79
+ help="the fraction of `total-timesteps` it takes from start-e to go end-e")
80
+ parser.add_argument("--learning-starts", type=int, default=80000,
81
+ help="timestep to start learning")
82
+ parser.add_argument("--train-frequency", type=int, default=4,
83
+ help="the frequency of training")
84
+ args = parser.parse_args()
85
+ # fmt: on
86
+ return args
87
+
88
+
89
+ def make_env(env_id, seed, idx, capture_video, run_name):
90
+ def thunk():
91
+ env = gym.make(env_id)
92
+ env = gym.wrappers.RecordEpisodeStatistics(env)
93
+ if capture_video:
94
+ if idx == 0:
95
+ env = gym.wrappers.RecordVideo(env, f"videos/{run_name}")
96
+ env = NoopResetEnv(env, noop_max=30)
97
+ env = MaxAndSkipEnv(env, skip=4)
98
+ env = EpisodicLifeEnv(env)
99
+ if "FIRE" in env.unwrapped.get_action_meanings():
100
+ env = FireResetEnv(env)
101
+ env = ClipRewardEnv(env)
102
+ env = gym.wrappers.ResizeObservation(env, (84, 84))
103
+ env = gym.wrappers.GrayScaleObservation(env)
104
+ env = gym.wrappers.FrameStack(env, 4)
105
+ env.seed(seed)
106
+ env.action_space.seed(seed)
107
+ env.observation_space.seed(seed)
108
+ return env
109
+
110
+ return thunk
111
+
112
+
113
+ # ALGO LOGIC: initialize agent here:
114
+ class QNetwork(nn.Module):
115
+ action_dim: int
116
+ n_atoms: int
117
+
118
+ @nn.compact
119
+ def __call__(self, x):
120
+ x = jnp.transpose(x, (0, 2, 3, 1))
121
+ x = x / (255.0)
122
+ x = nn.Conv(32, kernel_size=(8, 8), strides=(4, 4), padding="VALID")(x)
123
+ x = nn.relu(x)
124
+ x = nn.Conv(64, kernel_size=(4, 4), strides=(2, 2), padding="VALID")(x)
125
+ x = nn.relu(x)
126
+ x = nn.Conv(64, kernel_size=(3, 3), strides=(1, 1), padding="VALID")(x)
127
+ x = nn.relu(x)
128
+ x = x.reshape((x.shape[0], -1))
129
+ x = nn.Dense(512)(x)
130
+ x = nn.relu(x)
131
+ x = nn.Dense(self.action_dim * self.n_atoms)(x)
132
+ x = x.reshape((x.shape[0], self.action_dim, self.n_atoms))
133
+ x = nn.softmax(x, axis=-1) # pmfs
134
+ return x
135
+
136
+
137
+ class TrainState(TrainState):
138
+ target_params: flax.core.FrozenDict
139
+ atoms: jnp.ndarray
140
+
141
+
142
+ def linear_schedule(start_e: float, end_e: float, duration: int, t: int):
143
+ slope = (end_e - start_e) / duration
144
+ return max(slope * t + start_e, end_e)
145
+
146
+
147
+ if __name__ == "__main__":
148
+ args = parse_args()
149
+ run_name = f"{args.env_id}__{args.exp_name}__{args.seed}__{int(time.time())}"
150
+ if args.track:
151
+ import wandb
152
+
153
+ wandb.init(
154
+ project=args.wandb_project_name,
155
+ entity=args.wandb_entity,
156
+ sync_tensorboard=True,
157
+ config=vars(args),
158
+ name=run_name,
159
+ monitor_gym=True,
160
+ save_code=True,
161
+ )
162
+ writer = SummaryWriter(f"runs/{run_name}")
163
+ writer.add_text(
164
+ "hyperparameters",
165
+ "|param|value|\n|-|-|\n%s" % ("\n".join([f"|{key}|{value}|" for key, value in vars(args).items()])),
166
+ )
167
+
168
+ # TRY NOT TO MODIFY: seeding
169
+ random.seed(args.seed)
170
+ np.random.seed(args.seed)
171
+ key = jax.random.PRNGKey(args.seed)
172
+ key, q_key = jax.random.split(key, 2)
173
+
174
+ # env setup
175
+ envs = gym.vector.SyncVectorEnv([make_env(args.env_id, args.seed, 0, args.capture_video, run_name)])
176
+ assert isinstance(envs.single_action_space, gym.spaces.Discrete), "only discrete action space is supported"
177
+
178
+ obs = envs.reset()
179
+ q_network = QNetwork(action_dim=envs.single_action_space.n, n_atoms=args.n_atoms)
180
+ q_state = TrainState.create(
181
+ apply_fn=q_network.apply,
182
+ params=q_network.init(q_key, obs),
183
+ target_params=q_network.init(q_key, obs),
184
+ # directly using jnp.linspace leads to numerical errors
185
+ atoms=jnp.asarray(np.linspace(args.v_min, args.v_max, num=args.n_atoms)),
186
+ tx=optax.adam(learning_rate=args.learning_rate, eps=0.01 / args.batch_size),
187
+ )
188
+ q_network.apply = jax.jit(q_network.apply)
189
+ # This step is not necessary as init called on same observation and key will always lead to same initializations
190
+ q_state = q_state.replace(target_params=optax.incremental_update(q_state.params, q_state.target_params, 1))
191
+
192
+ rb = ReplayBuffer(
193
+ args.buffer_size,
194
+ envs.single_observation_space,
195
+ envs.single_action_space,
196
+ "cpu",
197
+ optimize_memory_usage=True,
198
+ handle_timeout_termination=True,
199
+ )
200
+
201
+ @jax.jit
202
+ def update(q_state, observations, actions, next_observations, rewards, dones):
203
+ next_pmfs = q_network.apply(q_state.target_params, next_observations) # (batch_size, num_actions, num_atoms)
204
+ next_vals = (next_pmfs * q_state.atoms).sum(axis=-1) # (batch_size, num_actions)
205
+ next_action = jnp.argmax(next_vals, axis=-1) # (batch_size,)
206
+ next_pmfs = next_pmfs[np.arange(next_pmfs.shape[0]), next_action]
207
+ next_atoms = rewards + args.gamma * q_state.atoms * (1 - dones)
208
+ # projection
209
+ delta_z = q_state.atoms[1] - q_state.atoms[0]
210
+ tz = jnp.clip(next_atoms, a_min=(args.v_min), a_max=(args.v_max))
211
+
212
+ b = (tz - args.v_min) / delta_z
213
+ l = jnp.clip(jnp.floor(b), a_min=0, a_max=args.n_atoms - 1)
214
+ u = jnp.clip(jnp.ceil(b), a_min=0, a_max=args.n_atoms - 1)
215
+ # (l == u).astype(jnp.float) handles the case where bj is exactly an integer
216
+ # example bj = 1, then the upper ceiling should be uj= 2, and lj= 1
217
+ d_m_l = (u + (l == u).astype(jnp.float32) - b) * next_pmfs
218
+ d_m_u = (b - l) * next_pmfs
219
+ target_pmfs = jnp.zeros_like(next_pmfs)
220
+
221
+ def project_to_bins(i, val):
222
+ val = val.at[i, l[i].astype(jnp.int32)].add(d_m_l[i])
223
+ val = val.at[i, u[i].astype(jnp.int32)].add(d_m_u[i])
224
+ return val
225
+
226
+ target_pmfs = jax.lax.fori_loop(0, target_pmfs.shape[0], project_to_bins, target_pmfs)
227
+
228
+ def loss(q_params, observations, actions, target_pmfs):
229
+ pmfs = q_network.apply(q_params, observations)
230
+ old_pmfs = pmfs[np.arange(pmfs.shape[0]), actions.squeeze()]
231
+
232
+ old_pmfs_l = jnp.clip(old_pmfs, a_min=1e-5, a_max=1 - 1e-5)
233
+ loss = (-(target_pmfs * jnp.log(old_pmfs_l)).sum(-1)).mean()
234
+ return loss, (old_pmfs * q_state.atoms).sum(-1)
235
+
236
+ (loss_value, old_values), grads = jax.value_and_grad(loss, has_aux=True)(
237
+ q_state.params, observations, actions, target_pmfs
238
+ )
239
+ q_state = q_state.apply_gradients(grads=grads)
240
+ return loss_value, old_values, q_state
241
+
242
+ @jax.jit
243
+ def get_action(q_state, obs):
244
+ pmfs = q_network.apply(q_state.params, obs)
245
+ q_vals = (pmfs * q_state.atoms).sum(axis=-1)
246
+ actions = q_vals.argmax(axis=-1)
247
+ return actions
248
+
249
+ start_time = time.time()
250
+
251
+ # TRY NOT TO MODIFY: start the game
252
+ obs = envs.reset()
253
+ for global_step in range(args.total_timesteps):
254
+ # ALGO LOGIC: put action logic here
255
+ epsilon = linear_schedule(args.start_e, args.end_e, args.exploration_fraction * args.total_timesteps, global_step)
256
+ if random.random() < epsilon:
257
+ actions = np.array([envs.single_action_space.sample() for _ in range(envs.num_envs)])
258
+ else:
259
+ actions = get_action(q_state, obs)
260
+ actions = jax.device_get(actions)
261
+
262
+ # TRY NOT TO MODIFY: execute the game and log data.
263
+ next_obs, rewards, dones, infos = envs.step(actions)
264
+
265
+ # TRY NOT TO MODIFY: record rewards for plotting purposes
266
+ for info in infos:
267
+ if "episode" in info.keys():
268
+ print(f"global_step={global_step}, episodic_return={info['episode']['r']}")
269
+ writer.add_scalar("charts/episodic_return", info["episode"]["r"], global_step)
270
+ writer.add_scalar("charts/episodic_length", info["episode"]["l"], global_step)
271
+ writer.add_scalar("charts/epsilon", epsilon, global_step)
272
+ break
273
+
274
+ # TRY NOT TO MODIFY: save data to reply buffer; handle `terminal_observation`
275
+ real_next_obs = next_obs.copy()
276
+ for idx, d in enumerate(dones):
277
+ if d:
278
+ real_next_obs[idx] = infos[idx]["terminal_observation"]
279
+ rb.add(obs, real_next_obs, actions, rewards, dones, infos)
280
+
281
+ # TRY NOT TO MODIFY: CRUCIAL step easy to overlook
282
+ obs = next_obs
283
+
284
+ # ALGO LOGIC: training.
285
+ if global_step > args.learning_starts and global_step % args.train_frequency == 0:
286
+ data = rb.sample(args.batch_size)
287
+ loss, old_val, q_state = update(
288
+ q_state,
289
+ data.observations.numpy(),
290
+ data.actions.numpy(),
291
+ data.next_observations.numpy(),
292
+ data.rewards.numpy(),
293
+ data.dones.numpy(),
294
+ )
295
+
296
+ if global_step % 100 == 0:
297
+ writer.add_scalar("losses/loss", jax.device_get(loss), global_step)
298
+ writer.add_scalar("losses/q_values", jax.device_get(old_val.mean()), global_step)
299
+ print("SPS:", int(global_step / (time.time() - start_time)))
300
+ writer.add_scalar("charts/SPS", int(global_step / (time.time() - start_time)), global_step)
301
+
302
+ # update the target network
303
+ if global_step % args.target_network_frequency == 0:
304
+ q_state = q_state.replace(target_params=optax.incremental_update(q_state.params, q_state.target_params, 1))
305
+
306
+ if args.save_model:
307
+ model_path = f"runs/{run_name}/{args.exp_name}.cleanrl_model"
308
+ model_data = {
309
+ "model_weights": q_state.params,
310
+ "args": vars(args),
311
+ }
312
+ with open(model_path, "wb") as f:
313
+ f.write(flax.serialization.to_bytes(model_data))
314
+ print(f"model saved to {model_path}")
315
+ from cleanrl_utils.evals.c51_jax_eval import evaluate
316
+
317
+ episodic_returns = evaluate(
318
+ model_path,
319
+ make_env,
320
+ args.env_id,
321
+ eval_episodes=10,
322
+ run_name=f"{run_name}-eval",
323
+ Model=QNetwork,
324
+ epsilon=0.05,
325
+ )
326
+ for idx, episodic_return in enumerate(episodic_returns):
327
+ writer.add_scalar("eval/episodic_return", episodic_return, idx)
328
+
329
+ if args.upload_model:
330
+ from cleanrl_utils.huggingface import push_to_hub
331
+
332
+ repo_name = f"{args.env_id}-{args.exp_name}-seed{args.seed}"
333
+ repo_id = f"{args.hf_entity}/{repo_name}" if args.hf_entity else repo_name
334
+ push_to_hub(args, episodic_returns, repo_id, "DQN", f"runs/{run_name}", f"videos/{run_name}-eval")
335
+
336
+ envs.close()
337
+ writer.close()
events.out.tfevents.1672682026.home-pc.22471.0 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:b39d2ef770a9cbdc8865dbecb373d1ed027c1c35acc6472552bd798a9d205b24
3
+ size 16736234
poetry.lock ADDED
The diff for this file is too large to render. See raw diff
 
pyproject.toml ADDED
@@ -0,0 +1,178 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [tool.poetry]
2
+ name = "cleanrl-test"
3
+ version = "1.1.0"
4
+ description = "High-quality single file implementation of Deep Reinforcement Learning algorithms with research-friendly features"
5
+ authors = ["Costa Huang <[email protected]>"]
6
+ packages = [
7
+ { include = "cleanrl" },
8
+ { include = "cleanrl_utils" },
9
+ ]
10
+ keywords = ["reinforcement", "machine", "learning", "research"]
11
+ license="MIT"
12
+ readme = "README.md"
13
+
14
+ [tool.poetry.dependencies]
15
+ python = ">=3.7.1,<3.10"
16
+ tensorboard = "^2.10.0"
17
+ wandb = "^0.13.6"
18
+ gym = "0.23.1"
19
+ torch = ">=1.12.1"
20
+ stable-baselines3 = "1.2.0"
21
+ gymnasium = "^0.26.3"
22
+ moviepy = "^1.0.3"
23
+ pygame = "2.1.0"
24
+ huggingface-hub = "^0.11.1"
25
+
26
+ ale-py = {version = "0.7.4", optional = true}
27
+ AutoROM = {extras = ["accept-rom-license"], version = "^0.4.2"}
28
+ opencv-python = {version = "^4.6.0.66", optional = true}
29
+ pybullet = {version = "3.1.8", optional = true}
30
+ procgen = {version = "^0.10.7", optional = true}
31
+ pytest = {version = "^7.1.3", optional = true}
32
+ mujoco = {version = "^2.2", optional = true}
33
+ imageio = {version = "^2.14.1", optional = true}
34
+ free-mujoco-py = {version = "^2.1.6", optional = true}
35
+ mkdocs-material = {version = "^8.4.3", optional = true}
36
+ markdown-include = {version = "^0.7.0", optional = true}
37
+ jax = {version = "^0.3.17", optional = true}
38
+ jaxlib = {version = "^0.3.15", optional = true}
39
+ flax = {version = "^0.6.0", optional = true}
40
+ optuna = {version = "^3.0.1", optional = true}
41
+ optuna-dashboard = {version = "^0.7.2", optional = true}
42
+ rich = {version = "<12.0", optional = true}
43
+ envpool = {version = "^0.6.4", optional = true}
44
+ PettingZoo = {version = "1.18.1", optional = true}
45
+ SuperSuit = {version = "3.4.0", optional = true}
46
+ multi-agent-ale-py = {version = "0.1.11", optional = true}
47
+ boto3 = {version = "^1.24.70", optional = true}
48
+ awscli = {version = "^1.25.71", optional = true}
49
+ shimmy = {version = "^0.1.0", optional = true}
50
+ dm-control = {version = "^1.0.8", optional = true}
51
+
52
+ [tool.poetry.group.dev.dependencies]
53
+ pre-commit = "^2.20.0"
54
+
55
+ [tool.poetry.group.atari]
56
+ optional = true
57
+ [tool.poetry.group.atari.dependencies]
58
+ ale-py = "0.7.4"
59
+ AutoROM = {extras = ["accept-rom-license"], version = "^0.4.2"}
60
+ opencv-python = "^4.6.0.66"
61
+
62
+ [tool.poetry.group.pybullet]
63
+ optional = true
64
+ [tool.poetry.group.pybullet.dependencies]
65
+ pybullet = "3.1.8"
66
+
67
+ [tool.poetry.group.procgen]
68
+ optional = true
69
+ [tool.poetry.group.procgen.dependencies]
70
+ procgen = "^0.10.7"
71
+
72
+ [tool.poetry.group.pytest]
73
+ optional = true
74
+ [tool.poetry.group.pytest.dependencies]
75
+ pytest = "^7.1.3"
76
+
77
+ [tool.poetry.group.mujoco]
78
+ optional = true
79
+ [tool.poetry.group.mujoco.dependencies]
80
+ mujoco = "^2.2"
81
+ imageio = "^2.14.1"
82
+
83
+ [tool.poetry.group.mujoco_py]
84
+ optional = true
85
+ [tool.poetry.group.mujoco_py.dependencies]
86
+ free-mujoco-py = "^2.1.6"
87
+
88
+ [tool.poetry.group.docs]
89
+ optional = true
90
+ [tool.poetry.group.docs.dependencies]
91
+ mkdocs-material = "^8.4.3"
92
+ markdown-include = "^0.7.0"
93
+
94
+ [tool.poetry.group.jax]
95
+ optional = true
96
+ [tool.poetry.group.jax.dependencies]
97
+ jax = "^0.3.17"
98
+ jaxlib = "^0.3.15"
99
+ flax = "^0.6.0"
100
+
101
+ [tool.poetry.group.optuna]
102
+ optional = true
103
+ [tool.poetry.group.optuna.dependencies]
104
+ optuna = "^3.0.1"
105
+ optuna-dashboard = "^0.7.2"
106
+ rich = "<12.0"
107
+
108
+ [tool.poetry.group.envpool]
109
+ optional = true
110
+ [tool.poetry.group.envpool.dependencies]
111
+ envpool = "^0.6.4"
112
+
113
+ [tool.poetry.group.pettingzoo]
114
+ optional = true
115
+ [tool.poetry.group.pettingzoo.dependencies]
116
+ PettingZoo = "1.18.1"
117
+ SuperSuit = "3.4.0"
118
+ multi-agent-ale-py = "0.1.11"
119
+
120
+ [tool.poetry.group.cloud]
121
+ optional = true
122
+ [tool.poetry.group.cloud.dependencies]
123
+ boto3 = "^1.24.70"
124
+ awscli = "^1.25.71"
125
+
126
+ [tool.poetry.group.isaacgym]
127
+ optional = true
128
+ [tool.poetry.group.isaacgym.dependencies]
129
+ isaacgymenvs = {git = "https://github.com/vwxyzjn/IsaacGymEnvs.git", rev = "poetry"}
130
+ isaacgym = {path = "cleanrl/ppo_continuous_action_isaacgym/isaacgym", develop = true}
131
+
132
+ [tool.poetry.group.dm_control]
133
+ optional = true
134
+ [tool.poetry.group.dm_control.dependencies]
135
+ shimmy = "^0.1.0"
136
+ dm-control = "^1.0.8"
137
+ mujoco = "^2.2"
138
+
139
+ [build-system]
140
+ requires = ["poetry-core"]
141
+ build-backend = "poetry.core.masonry.api"
142
+
143
+ [tool.poetry.extras]
144
+ atari = ["ale-py", "AutoROM", "opencv-python"]
145
+ pybullet = ["pybullet"]
146
+ procgen = ["procgen"]
147
+ plot = ["pandas", "seaborn"]
148
+ pytest = ["pytest"]
149
+ mujoco = ["mujoco", "imageio"]
150
+ mujoco_py = ["free-mujoco-py"]
151
+ jax = ["jax", "jaxlib", "flax"]
152
+ docs = ["mkdocs-material", "markdown-include"]
153
+ envpool = ["envpool"]
154
+ optuna = ["optuna", "optuna-dashboard", "rich"]
155
+ pettingzoo = ["PettingZoo", "SuperSuit", "multi-agent-ale-py"]
156
+ cloud = ["boto3", "awscli"]
157
+ dm_control = ["shimmy", "dm-control", "mujoco"]
158
+
159
+ # dependencies for algorithm variant (useful when you want to run a specific algorithm)
160
+ dqn = []
161
+ dqn_atari = ["ale-py", "AutoROM", "opencv-python"]
162
+ dqn_jax = ["jax", "jaxlib", "flax"]
163
+ dqn_atari_jax = [
164
+ "ale-py", "AutoROM", "opencv-python", # atari
165
+ "jax", "jaxlib", "flax" # jax
166
+ ]
167
+ c51 = []
168
+ c51_atari = ["ale-py", "AutoROM", "opencv-python"]
169
+ c51_jax = ["jax", "jaxlib", "flax"]
170
+ c51_atari_jax = [
171
+ "ale-py", "AutoROM", "opencv-python", # atari
172
+ "jax", "jaxlib", "flax" # jax
173
+ ]
174
+ ppo_atari_envpool_xla_jax_scan = [
175
+ "ale-py", "AutoROM", "opencv-python", # atari
176
+ "jax", "jaxlib", "flax", # jax
177
+ "envpool", # envpool
178
+ ]
replay.mp4 ADDED
Binary file (346 kB). View file
 
videos/BreakoutNoFrameskip-v4__c51_atari_jax__1__1672682026-eval/rl-video-episode-0.mp4 ADDED
Binary file (519 kB). View file
 
videos/BreakoutNoFrameskip-v4__c51_atari_jax__1__1672682026-eval/rl-video-episode-1.mp4 ADDED
Binary file (415 kB). View file
 
videos/BreakoutNoFrameskip-v4__c51_atari_jax__1__1672682026-eval/rl-video-episode-8.mp4 ADDED
Binary file (346 kB). View file