Initial commit

.gitattributes

@@ -32,3 +32,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+*.mp4 filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,74 @@
+---
+library_name: stable-baselines3
+tags:
+- ALE/MsPacman-v5
+- deep-reinforcement-learning
+- reinforcement-learning
+- stable-baselines3
+model-index:
+- name: PPO
+  results:
+  - task:
+      type: reinforcement-learning
+      name: reinforcement-learning
+    dataset:
+      name: ALE/MsPacman-v5
+      type: ALE/MsPacman-v5
+    metrics:
+    - type: mean_reward
+      value: 600.00 +/- 273.20
+      name: mean_reward
+      verified: false
+---
+
+# **PPO** Agent playing **ALE/MsPacman-v5**
+This is a trained model of a **PPO** agent playing **ALE/MsPacman-v5**
+using the [stable-baselines3 library](https://github.com/DLR-RM/stable-baselines3)
+and the [RL Zoo](https://github.com/DLR-RM/rl-baselines3-zoo).
+
+The RL Zoo is a training framework for Stable Baselines3
+reinforcement learning agents,
+with hyperparameter optimization and pre-trained agents included.
+
+## Usage (with SB3 RL Zoo)
+
+RL Zoo: https://github.com/DLR-RM/rl-baselines3-zoo<br/>
+SB3: https://github.com/DLR-RM/stable-baselines3<br/>
+SB3 Contrib: https://github.com/Stable-Baselines-Team/stable-baselines3-contrib
+
+```
+# Download model and save it into the logs/ folder
+python -m rl_zoo3.load_from_hub --algo ppo --env ALE/MsPacman-v5 -orga xaeroq -f logs/
+python enjoy.py --algo ppo --env ALE/MsPacman-v5  -f logs/
+```
+
+If you installed the RL Zoo3 via pip (`pip install rl_zoo3`), from anywhere you can do:
+```
+python -m rl_zoo3.load_from_hub --algo ppo --env ALE/MsPacman-v5 -orga xaeroq -f logs/
+rl_zoo3 enjoy --algo ppo --env ALE/MsPacman-v5  -f logs/
+```
+
+## Training (with the RL Zoo)
+```
+python train.py --algo ppo --env ALE/MsPacman-v5 -f logs/
+# Upload the model and generate video (when possible)
+python -m rl_zoo3.push_to_hub --algo ppo --env ALE/MsPacman-v5 -f logs/ -orga xaeroq
+```
+
+## Hyperparameters
+```python
+OrderedDict([('batch_size', 256),
+             ('clip_range', 'lin_0.1'),
+             ('ent_coef', 0.01),
+             ('env_wrapper',
+              ['stable_baselines3.common.atari_wrappers.AtariWrapper']),
+             ('frame_stack', 4),
+             ('learning_rate', 'lin_2.5e-4'),
+             ('n_envs', 8),
+             ('n_epochs', 4),
+             ('n_steps', 128),
+             ('n_timesteps', 100000.0),
+             ('policy', 'CnnPolicy'),
+             ('vf_coef', 0.5),
+             ('normalize', False)])
+```

args.yml

@@ -0,0 +1,79 @@
+!!python/object/apply:collections.OrderedDict
+- - - algo
+    - ppo
+  - - device
+    - auto
+  - - env
+    - ALE/MsPacman-v5
+  - - env_kwargs
+    - null
+  - - eval_episodes
+    - 5
+  - - eval_freq
+    - 25000
+  - - gym_packages
+    - []
+  - - hyperparams
+    - null
+  - - log_folder
+    - logs/
+  - - log_interval
+    - -1
+  - - max_total_trials
+    - null
+  - - n_eval_envs
+    - 1
+  - - n_evaluations
+    - null
+  - - n_jobs
+    - 1
+  - - n_startup_trials
+    - 10
+  - - n_timesteps
+    - -1
+  - - n_trials
+    - 500
+  - - no_optim_plots
+    - false
+  - - num_threads
+    - -1
+  - - optimization_log_path
+    - null
+  - - optimize_hyperparameters
+    - false
+  - - progress
+    - false
+  - - pruner
+    - median
+  - - sampler
+    - tpe
+  - - save_freq
+    - -1
+  - - save_replay_buffer
+    - false
+  - - seed
+    - 1957088056
+  - - storage
+    - null
+  - - study_name
+    - null
+  - - tensorboard_log
+    - ''
+  - - track
+    - false
+  - - trained_agent
+    - ''
+  - - truncate_last_trajectory
+    - true
+  - - uuid
+    - false
+  - - vec_env
+    - dummy
+  - - verbose
+    - 1
+  - - wandb_entity
+    - null
+  - - wandb_project_name
+    - sb3
+  - - yaml_file
+    - null

config.yml

@@ -0,0 +1,25 @@
+!!python/object/apply:collections.OrderedDict
+- - - batch_size
+    - 256
+  - - clip_range
+    - lin_0.1
+  - - ent_coef
+    - 0.01
+  - - env_wrapper
+    - - stable_baselines3.common.atari_wrappers.AtariWrapper
+  - - frame_stack
+    - 4
+  - - learning_rate
+    - lin_2.5e-4
+  - - n_envs
+    - 8
+  - - n_epochs
+    - 4
+  - - n_steps
+    - 128
+  - - n_timesteps
+    - 100000.0
+  - - policy
+    - CnnPolicy
+  - - vf_coef
+    - 0.5

env_kwargs.yml

@@ -0,0 +1 @@
+{}

ppo-ALE-MsPacman-v5.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:963460d73a3808a1b9392f215084a36475dc2c64f8a9a0956dbc06ac0e04bbd6
+size 20460412

ppo-ALE-MsPacman-v5/_stable_baselines3_version

@@ -0,0 +1 @@
+1.6.2

ppo-ALE-MsPacman-v5/policy.optimizer.pth

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:aaa38a624806115921bb6154e31ccc602cfbe7f24edb044dbae96ccb2de8e425
+size 13523769

ppo-ALE-MsPacman-v5/policy.pth

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:24363ec453853613689e8bb58d407a45e6ee6060d7d40c163eab1e44ec0f27a4
+size 6761153

ppo-ALE-MsPacman-v5/pytorch_variables.pth

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d030ad8db708280fcae77d87e973102039acd23a11bdecc3db8eb6c0ac940ee1
+size 431

ppo-ALE-MsPacman-v5/system_info.txt

@@ -0,0 +1,7 @@
+OS: Linux-5.10.133+-x86_64-with-Ubuntu-18.04-bionic #1 SMP Fri Aug 26 08:44:51 UTC 2022
+Python: 3.7.15
+Stable-Baselines3: 1.6.2
+PyTorch: 1.12.1+cu113
+GPU Enabled: True
+Numpy: 1.21.6
+Gym: 0.21.0

replay.mp4

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b813f1446d56d84b233e9d30f53c234a4b05a5a2879b84fcdcab874617638fb7
+size 296608

results.json

@@ -0,0 +1 @@
+{"mean_reward": 600.0, "std_reward": 273.20322106446696, "is_deterministic": false, "n_eval_episodes": 10, "eval_datetime": "2022-11-24T00:53:39.799849"}

train_eval_metrics.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d66542c2255a2b66e4d269824d379a050be792598cbbfa340af33cb0537944a5
+size 17914