metadata

library_name: rl-algo-impls
tags:
  - MicrortsRandomEnemyShapedReward3-v1
  - ppo
  - deep-reinforcement-learning
  - reinforcement-learning
model-index:
  - name: ppo
    results:
      - metrics:
          - type: mean_reward
            value: 52.8 +/- 1.66
            name: mean_reward
        task:
          type: reinforcement-learning
          name: reinforcement-learning
        dataset:
          name: MicrortsRandomEnemyShapedReward3-v1
          type: MicrortsRandomEnemyShapedReward3-v1

PPO Agent playing MicrortsRandomEnemyShapedReward3-v1

This is a trained model of a PPO agent playing MicrortsRandomEnemyShapedReward3-v1 using the /sgoodfriend/rl-algo-impls repo.

All models trained at this commit can be found at https://api.wandb.ai/links/sgoodfriend/z3kioih3.

Training Results

This model was trained from 3 trainings of PPO agents using different initial seeds. These agents were trained by checking out fb34ab8. 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).

algo	env	seed	reward_mean	reward_std	eval_episodes	best	wandb_url
ppo	MicrortsRandomEnemyShapedReward3-v1	1	21.395	20.7029	16		wandb
ppo	MicrortsRandomEnemyShapedReward3-v1	2	52.7958	1.66337	16	*	wandb
ppo	MicrortsRandomEnemyShapedReward3-v1	3	25.5122	15.8365	16		wandb

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

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: fb34ab8.

# Downloads the model, sets hyperparameters, and runs agent for 3 episodes
python enjoy.py --wandb-run-path=sgoodfriend/rl-algo-impls-benchmarks/j08n0vi5

Setup hasn't been completely worked out yet, so you might be best served by using Google Colab starting from the 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: fb34ab8. While training is deterministic, different hardware will give different results.

python train.py --algo ppo --env MicrortsRandomEnemyShapedReward3-v1 --seed 2

Setup hasn't been completely worked out yet, so you might be best served by using Google Colab starting from the colab_train.ipynb notebook.

Benchmarking (with Lambda Labs instance)

This and other models from https://api.wandb.ai/links/sgoodfriend/z3kioih3 were generated by running a script on a Lambda Labs instance. In a Lambda Labs instance terminal:

git clone [email protected]:sgoodfriend/rl-algo-impls.git
cd rl-algo-impls
bash ./lambda_labs/setup.sh
wandb login
bash ./lambda_labs/benchmark.sh [-a {"ppo a2c dqn vpg"}] [-e ENVS] [-j {6}] [-p {rl-algo-impls-benchmarks}] [-s {"1 2 3"}]

Alternative: Google Colab Pro+

As an alternative, 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/ppo.yml, but instead the Wandb Run Config. However, it's very close and has some additional data:

algo: ppo
algo_hyperparams:
  batch_size: 256
  clip_range: 0.1
  clip_range_decay: none
  clip_range_vf: 0.1
  ent_coef: 0.01
  learning_rate: 0.00025
  learning_rate_decay: linear
  n_epochs: 4
  n_steps: 128
  vf_coef: 0.5
device: auto
env: MicrortsRandomEnemyShapedReward3-v1
env_hyperparams:
  mask_actions: true
  n_envs: 8
  vec_env_class: sync
env_id: null
eval_params:
  deterministic: false
n_timesteps: 2000000
policy_hyperparams:
  activation_fn: relu
  cnn_feature_dim: 128
  cnn_style: microrts
seed: 2
use_deterministic_algorithms: true
wandb_entity: null
wandb_group: null
wandb_project_name: rl-algo-impls-benchmarks
wandb_tags:
- benchmark_fb34ab8
- host_155-248-210-13