Initial commit

.gitattributes

@@ -33,3 +33,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,84 @@
+---
+library_name: stable-baselines3
+tags:
+- BeamRiderNoFrameskip-v4
+- deep-reinforcement-learning
+- reinforcement-learning
+- stable-baselines3
+model-index:
+- name: PPO
+  results:
+  - task:
+      type: reinforcement-learning
+      name: reinforcement-learning
+    dataset:
+      name: BeamRiderNoFrameskip-v4
+      type: BeamRiderNoFrameskip-v4
+    metrics:
+    - type: mean_reward
+      value: 5161.60 +/- 1606.96
+      name: mean_reward
+      verified: false
+---
+
+# **PPO** Agent playing **BeamRiderNoFrameskip-v4**
+This is a trained model of a **PPO** agent playing **BeamRiderNoFrameskip-v4**
+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
+
+Install the RL Zoo (with SB3 and SB3-Contrib):
+```bash
+pip install rl_zoo3
+```
+
+```
+# Download model and save it into the logs/ folder
+python -m rl_zoo3.load_from_hub --algo ppo --env BeamRiderNoFrameskip-v4 -orga MattStammers -f logs/
+python -m rl_zoo3.enjoy --algo ppo --env BeamRiderNoFrameskip-v4  -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 BeamRiderNoFrameskip-v4 -orga MattStammers -f logs/
+python -m rl_zoo3.enjoy --algo ppo --env BeamRiderNoFrameskip-v4  -f logs/
+```
+
+## Training (with the RL Zoo)
+```
+python -m rl_zoo3.train --algo ppo --env BeamRiderNoFrameskip-v4 -f logs/
+# Upload the model and generate video (when possible)
+python -m rl_zoo3.push_to_hub --algo ppo --env BeamRiderNoFrameskip-v4 -f logs/ -orga MattStammers
+```
+
+## 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', 10000000.0),
+             ('normalize', False),
+             ('policy', 'CnnPolicy'),
+             ('vf_coef', 0.5)])
+```
+
+# Environment Arguments
+```python
+{'render_mode': 'rgb_array'}
+```

args.yml

@@ -0,0 +1,81 @@
+!!python/object/apply:collections.OrderedDict
+- - - algo
+    - ppo
+  - - conf_file
+    - settings/ppo-beamrider.yaml
+  - - device
+    - auto
+  - - env
+    - BeamRiderNoFrameskip-v4
+  - - 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
+    - 2669915583
+  - - 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
+  - - wandb_tags
+    - []

config.yml

@@ -0,0 +1,27 @@
+!!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
+    - 10000000.0
+  - - normalize
+    - false
+  - - policy
+    - CnnPolicy
+  - - vf_coef
+    - 0.5

env_kwargs.yml

@@ -0,0 +1 @@
+render_mode: rgb_array

ppo-BeamRiderNoFrameskip-v4.zip

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

ppo-BeamRiderNoFrameskip-v4/_stable_baselines3_version

@@ -0,0 +1 @@
+2.1.0

ppo-BeamRiderNoFrameskip-v4/policy.optimizer.pth

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

ppo-BeamRiderNoFrameskip-v4/policy.pth

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

ppo-BeamRiderNoFrameskip-v4/pytorch_variables.pth

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

ppo-BeamRiderNoFrameskip-v4/system_info.txt

@@ -0,0 +1,9 @@
+- OS: Linux-5.15.109+-x86_64-with-glibc2.35 # 1 SMP Fri Jun 9 10:57:30 UTC 2023
+- Python: 3.10.12
+- Stable-Baselines3: 2.1.0
+- PyTorch: 2.0.1+cu118
+- GPU Enabled: False
+- Numpy: 1.23.5
+- Cloudpickle: 2.2.1
+- Gymnasium: 0.29.1
+- OpenAI Gym: 0.26.2

replay.mp4

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

results.json

@@ -0,0 +1 @@
+{"mean_reward": 5161.6, "std_reward": 1606.9630487350976, "is_deterministic": false, "n_eval_episodes": 10, "eval_datetime": "2023-08-24T15:21:42.714657"}

train_eval_metrics.zip

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