Upload folder using huggingface_hub

.gitattributes

@@ -32,4 +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
-replay.mp4 filter=lfs diff=lfs merge=lfs -text
+*.mp4 filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,143 +1,75 @@
 ---
-library_name: rl-algo-impls
+library_name: stable-baselines3
 tags:
 - SpaceInvadersNoFrameskip-v4
-- dqn
 - deep-reinforcement-learning
 - reinforcement-learning
+- stable-baselines3
 model-index:
-- name: dqn
+- name: QRDQN
   results:
-  - metrics:
-    - type: mean_reward
-      value: 2510.31 +/- 474.33
-      name: mean_reward
-    task:
+  - task:
       type: reinforcement-learning
       name: reinforcement-learning
     dataset:
       name: SpaceInvadersNoFrameskip-v4
       type: SpaceInvadersNoFrameskip-v4
+    metrics:
+    - type: mean_reward
+      value: 1059.00 +/- 439.89
+      name: mean_reward
+      verified: false
 ---
-# **DQN** Agent playing **SpaceInvadersNoFrameskip-v4**
-
-This is a trained model of a **DQN** agent playing **SpaceInvadersNoFrameskip-v4** using the [/sgoodfriend/rl-algo-impls](https://github.com/sgoodfriend/rl-algo-impls) repo.
-
-All models trained at this commit can be found at https://api.wandb.ai/links/sgoodfriend/v7d6z818.
 
-## Training Results
+# **QRDQN** Agent playing **SpaceInvadersNoFrameskip-v4**
+This is a trained model of a **QRDQN** agent playing **SpaceInvadersNoFrameskip-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).
 
-This model was trained from 3 trainings of **DQN** agents using different initial seeds. These agents were trained by checking out [e8bc541](https://github.com/sgoodfriend/rl-algo-impls/tree/e8bc541d8b5e67bb4d3f2075282463fb61f5f2c6). The best and last models were kept from each training. This submission has loaded the best models from each training, reevaluates them, and selects the best model from these latest evaluations (mean - std).
+The RL Zoo is a training framework for Stable Baselines3
+reinforcement learning agents,
+with hyperparameter optimization and pre-trained agents included.
 
-| algo   | env                         |   seed |   reward_mean |   reward_std |   eval_episodes | best   | wandb_url                                                                    |
-|:-------|:----------------------------|-------:|--------------:|-------------:|----------------:|:-------|:-----------------------------------------------------------------------------|
-| dqn    | SpaceInvadersNoFrameskip-v4 |      1 |       2510.31 |     474.333  |              16 | *      | [wandb](https://wandb.ai/sgoodfriend/rl-algo-impls-benchmarks/runs/86sbwx1e) |
-| dqn    | SpaceInvadersNoFrameskip-v4 |      2 |       1691.25 |     447.757  |              16 |        | [wandb](https://wandb.ai/sgoodfriend/rl-algo-impls-benchmarks/runs/rcxjbkfx) |
-| dqn    | SpaceInvadersNoFrameskip-v4 |      3 |       1319.38 |      88.4038 |              16 |        | [wandb](https://wandb.ai/sgoodfriend/rl-algo-impls-benchmarks/runs/dw0zab13) |
+## 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
 
-### Prerequisites: Weights & Biases (WandB)
-Training and benchmarking assumes you have a Weights & Biases project to upload runs to.
-By default training goes to a rl-algo-impls project while benchmarks go to
-rl-algo-impls-benchmarks. During training and benchmarking runs, videos of the best
-models and the model weights are uploaded to WandB.
-
-Before doing anything below, you'll need to create a wandb account and run `wandb
-login`.
-
-
-
-## Usage
-/sgoodfriend/rl-algo-impls: https://github.com/sgoodfriend/rl-algo-impls
+Install the RL Zoo (with SB3 and SB3-Contrib):
+```bash
+pip install rl_zoo3
+```
 
-Note: While the model state dictionary and hyperaparameters are saved, the latest
-implementation could be sufficiently different to not be able to reproduce similar
-results. You might need to checkout the commit the agent was trained on:
-[e8bc541](https://github.com/sgoodfriend/rl-algo-impls/tree/e8bc541d8b5e67bb4d3f2075282463fb61f5f2c6).
 ```
-# Downloads the model, sets hyperparameters, and runs agent for 3 episodes
-python enjoy.py --wandb-run-path=sgoodfriend/rl-algo-impls-benchmarks/86sbwx1e
+# Download model and save it into the logs/ folder
+python -m rl_zoo3.load_from_hub --algo qrdqn --env SpaceInvadersNoFrameskip-v4 -orga Mihail-P -f logs/
+python -m rl_zoo3.enjoy --algo qrdqn --env SpaceInvadersNoFrameskip-v4  -f logs/
 ```
 
-Setup hasn't been completely worked out yet, so you might be best served by using Google
-Colab starting from the
-[colab_enjoy.ipynb](https://github.com/sgoodfriend/rl-algo-impls/blob/main/colab_enjoy.ipynb)
-notebook.
-
-
-
-## Training
-If you want the highest chance to reproduce these results, you'll want to checkout the
-commit the agent was trained on: [e8bc541](https://github.com/sgoodfriend/rl-algo-impls/tree/e8bc541d8b5e67bb4d3f2075282463fb61f5f2c6). While
-training is deterministic, different hardware will give different results.
-
+If you installed the RL Zoo3 via pip (`pip install rl_zoo3`), from anywhere you can do:
 ```
-python train.py --algo dqn --env SpaceInvadersNoFrameskip-v4 --seed 1
+python -m rl_zoo3.load_from_hub --algo qrdqn --env SpaceInvadersNoFrameskip-v4 -orga Mihail-P -f logs/
+python -m rl_zoo3.enjoy --algo qrdqn --env SpaceInvadersNoFrameskip-v4  -f logs/
 ```
 
-Setup hasn't been completely worked out yet, so you might be best served by using Google
-Colab starting from the
-[colab_train.ipynb](https://github.com/sgoodfriend/rl-algo-impls/blob/main/colab_train.ipynb)
-notebook.
-
-
-
-## Benchmarking (with Lambda Labs instance)
-This and other models from https://api.wandb.ai/links/sgoodfriend/v7d6z818 were generated by running a script on a Lambda
-Labs instance. In a Lambda Labs instance terminal:
+## Training (with the RL Zoo)
 ```
-git clone git@github.com:sgoodfriend/rl-algo-impls.git
-cd rl-algo-impls
-bash ./lambda_labs/setup.sh
-wandb login
-bash ./lambda_labs/benchmark.sh
+python -m rl_zoo3.train --algo qrdqn --env SpaceInvadersNoFrameskip-v4 -f logs/
+# Upload the model and generate video (when possible)
+python -m rl_zoo3.push_to_hub --algo qrdqn --env SpaceInvadersNoFrameskip-v4 -f logs/ -orga Mihail-P
 ```
 
-### Alternative: Google Colab Pro+
-As an alternative,
-[colab_benchmark.ipynb](https://github.com/sgoodfriend/rl-algo-impls/tree/main/benchmarks#:~:text=colab_benchmark.ipynb),
-can be used. However, this requires a Google Colab Pro+ subscription and running across
-4 separate instances because otherwise running all jobs will exceed the 24-hour limit.
-
-
-
 ## Hyperparameters
-This isn't exactly the format of hyperparams in hyperparams/dqn.yml, but instead the Wandb Run Config. However, it's very
-close and has some additional data:
-```
-algo: dqn
-algo_hyperparams:
-  batch_size: 32
-  buffer_size: 100000
-  exploration_final_eps: 0.01
-  exploration_fraction: 0.1
-  gradient_steps: 2
-  learning_rate: 0.0001
-  learning_starts: 100000
-  target_update_interval: 1000
-  train_freq: 8
-env: impala-SpaceInvadersNoFrameskip-v4
-env_hyperparams:
-  frame_stack: 4
-  n_envs: 8
-  no_reward_fire_steps: 500
-  no_reward_timeout_steps: 1000
-  vec_env_class: subproc
-env_id: SpaceInvadersNoFrameskip-v4
-eval_params:
-  deterministic: false
-n_timesteps: 10000000
-policy_hyperparams:
-  cnn_feature_dim: 256
-  cnn_layers_init_orthogonal: false
-  cnn_style: impala
-  init_layers_orthogonal: true
-seed: 1
-use_deterministic_algorithms: true
-wandb_entity: null
-wandb_project_name: rl-algo-impls-benchmarks
-wandb_tags:
-- benchmark_e8bc541
-- host_192-9-228-51
-
+```python
+OrderedDict([('batch_size', 64),
+             ('buffer_size', 150000),
+             ('env_wrapper',
+              ['stable_baselines3.common.atari_wrappers.AtariWrapper']),
+             ('exploration_fraction', 0.025),
+             ('frame_stack', 4),
+             ('n_timesteps', 10000000.0),
+             ('optimize_memory_usage', False),
+             ('policy', 'CnnPolicy'),
+             ('normalize', False)])
 ```

args.yml

@@ -0,0 +1,83 @@
+!!python/object/apply:collections.OrderedDict
+- - - algo
+    - qrdqn
+  - - conf_file
+    - null
+  - - device
+    - auto
+  - - env
+    - SpaceInvadersNoFrameskip-v4
+  - - env_kwargs
+    - null
+  - - eval_episodes
+    - 25
+  - - eval_freq
+    - 50000
+  - - gym_packages
+    - []
+  - - hyperparams
+    - batch_size: 64
+      buffer_size: 150000
+      exploration_fraction: 0.025
+  - - 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
+    - 10000000
+  - - 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
+    - 1000000
+  - - save_replay_buffer
+    - false
+  - - seed
+    - 1078690446
+  - - storage
+    - null
+  - - study_name
+    - null
+  - - tensorboard_log
+    - /tblogs/
+  - - 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,17 @@
+!!python/object/apply:collections.OrderedDict
+- - - batch_size
+    - 64
+  - - buffer_size
+    - 150000
+  - - env_wrapper
+    - - stable_baselines3.common.atari_wrappers.AtariWrapper
+  - - exploration_fraction
+    - 0.025
+  - - frame_stack
+    - 4
+  - - n_timesteps
+    - 10000000.0
+  - - optimize_memory_usage
+    - false
+  - - policy
+    - CnnPolicy

env_kwargs.yml

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

qrdqn-SpaceInvadersNoFrameskip-v4.zip

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

qrdqn-SpaceInvadersNoFrameskip-v4/_stable_baselines3_version

@@ -0,0 +1 @@
+2.0.0a5

qrdqn-SpaceInvadersNoFrameskip-v4/policy.optimizer.pth

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

qrdqn-SpaceInvadersNoFrameskip-v4/policy.pth

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

qrdqn-SpaceInvadersNoFrameskip-v4/pytorch_variables.pth

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

qrdqn-SpaceInvadersNoFrameskip-v4/system_info.txt

@@ -0,0 +1,9 @@
+- OS: Linux-5.10.147+-x86_64-with-glibc2.31 # 1 SMP Sat Dec 10 16:00:40 UTC 2022
+- Python: 3.9.16
+- Stable-Baselines3: 2.0.0a5
+- PyTorch: 2.0.0+cu118
+- GPU Enabled: True
+- Numpy: 1.22.4
+- Cloudpickle: 2.2.1
+- Gymnasium: 0.28.1
+- OpenAI Gym: 0.26.2

results.json

@@ -0,0 +1 @@
+{"mean_reward": 1059.0, "std_reward": 439.89089556388865, "is_deterministic": false, "n_eval_episodes": 10, "eval_datetime": "2023-04-17T06:17:02.113019"}

train_eval_metrics.zip

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