Hugging Face's logo

OpenDILabCommunity
/
Hopper-v3-PPO

Reinforcement Learning
PyTorch
English
deep-reinforcement-learning
DI-engine
Hopper-v3
Model card Files Community
Hopper-v3-PPO / README.md
zjowowen's picture
zjowowen
Upload README.md with huggingface_hub
11bc9e0
preview code
|
raw
history blame contribute delete
7.76 kB
metadata
language: en
license: apache-2.0
library_name: pytorch
tags:
  - deep-reinforcement-learning
  - reinforcement-learning
  - DI-engine
  - Hopper-v3
benchmark_name: OpenAI/Gym/MuJoCo
task_name: Hopper-v3
pipeline_tag: reinforcement-learning
model-index:
  - name: PPO
    results:
      - task:
          type: reinforcement-learning
          name: reinforcement-learning
        dataset:
          name: OpenAI/Gym/MuJoCo-Hopper-v3
          type: OpenAI/Gym/MuJoCo-Hopper-v3
        metrics:
          - type: mean_reward
            value: 3795.27 +/- 26.06
            name: mean_reward

Play Hopper-v3 with PPO Policy

Model Description

This is a simple PPO implementation to OpenAI/Gym/MuJoCo Hopper-v3 using the DI-engine library and the DI-zoo.

DI-engine is a python library for solving general decision intelligence problems, which is based on implementations of reinforcement learning framework using PyTorch or JAX. This library aims to standardize the reinforcement learning framework across different algorithms, benchmarks, environments, and to support both academic researches and prototype applications. Besides, self-customized training pipelines and applications are supported by reusing different abstraction levels of DI-engine reinforcement learning framework.

Model Usage

Install the Dependencies

(Click for Details) 
# install huggingface_ding
git clone https://github.com/opendilab/huggingface_ding.git
pip3 install -e ./huggingface_ding/
# install environment dependencies if needed

sudo apt update -y     && sudo apt install -y     build-essential     libgl1-mesa-dev     libgl1-mesa-glx     libglew-dev     libosmesa6-dev     libglfw3     libglfw3-dev     libsdl2-dev     libsdl2-image-dev     libglm-dev     libfreetype6-dev     patchelf

mkdir -p ~/.mujoco
wget https://mujoco.org/download/mujoco210-linux-x86_64.tar.gz -O mujoco.tar.gz
tar -xf mujoco.tar.gz -C ~/.mujoco
echo "export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:~/.mujoco/mjpro210/bin:~/.mujoco/mujoco210/bin" >> ~/.bashrc
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:~/.mujoco/mjpro210/bin:~/.mujoco/mujoco210/bin
pip3 install "cython<3"
pip3 install DI-engine[common_env,video]

Git Clone from Huggingface and Run the Model

(Click for Details) 
# running with trained model
python3 -u run.py

run.py

from ding.bonus import PPOF
from ding.config import Config
from easydict import EasyDict
import torch

# Pull model from files which are git cloned from huggingface
policy_state_dict = torch.load("pytorch_model.bin", map_location=torch.device("cpu"))
cfg = EasyDict(Config.file_to_dict("policy_config.py").cfg_dict)
# Instantiate the agent
agent = PPOF(env_id="Hopper-v3", exp_name="Hopper-v3-PPO", cfg=cfg.exp_config, policy_state_dict=policy_state_dict)
# Continue training
agent.train(step=5000)
# Render the new agent performance
agent.deploy(enable_save_replay=True)

Run Model by Using Huggingface_ding

(Click for Details) 
# running with trained model
python3 -u run.py

run.py

from ding.bonus import PPOF
from huggingface_ding import pull_model_from_hub

# Pull model from Hugggingface hub
policy_state_dict, cfg = pull_model_from_hub(repo_id="OpenDILabCommunity/Hopper-v3-PPO")
# Instantiate the agent
agent = PPOF(env_id="Hopper-v3", exp_name="Hopper-v3-PPO", cfg=cfg.exp_config, policy_state_dict=policy_state_dict)
# Continue training
agent.train(step=5000)
# Render the new agent performance
agent.deploy(enable_save_replay=True)

Model Training

Train the Model and Push to Huggingface_hub

(Click for Details) 
#Training Your Own Agent
python3 -u train.py

train.py

from ding.bonus import PPOF
from huggingface_ding import push_model_to_hub

# Instantiate the agent
agent = PPOF(env_id="Hopper-v3", exp_name="Hopper-v3-PPO")
# Train the agent
return_ = agent.train(step=int(10000000), collector_env_num=4, evaluator_env_num=4, debug=False)
# Push model to huggingface hub
push_model_to_hub(
    agent=agent.best,
    env_name="OpenAI/Gym/MuJoCo",
    task_name="Hopper-v3",
    algo_name="PPO",
    wandb_url=return_.wandb_url,
    github_repo_url="https://github.com/opendilab/DI-engine",
    github_doc_model_url="https://di-engine-docs.readthedocs.io/en/latest/12_policies/ppo.html",
    github_doc_env_url="https://di-engine-docs.readthedocs.io/en/latest/13_envs/mujoco.html",
    installation_guide='''
sudo apt update -y \
    && sudo apt install -y \
    build-essential \
    libgl1-mesa-dev \
    libgl1-mesa-glx \
    libglew-dev \
    libosmesa6-dev \
    libglfw3 \
    libglfw3-dev \
    libsdl2-dev \
    libsdl2-image-dev \
    libglm-dev \
    libfreetype6-dev \
    patchelf

mkdir -p ~/.mujoco
wget https://mujoco.org/download/mujoco210-linux-x86_64.tar.gz -O mujoco.tar.gz
tar -xf mujoco.tar.gz -C ~/.mujoco
echo "export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:~/.mujoco/mjpro210/bin:~/.mujoco/mujoco210/bin" >> ~/.bashrc
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:~/.mujoco/mjpro210/bin:~/.mujoco/mujoco210/bin
pip3 install "cython<3"
pip3 install DI-engine[common_env,video]
''',
    usage_file_by_git_clone="./ppo/hopper_ppo_deploy.py",
    usage_file_by_huggingface_ding="./ppo/hopper_ppo_download.py",
    train_file="./ppo/hopper_ppo.py",
    repo_id="OpenDILabCommunity/Hopper-v3-PPO",
    create_repo=False
)

Configuration

(Click for Details) 
exp_config = {
    'type': 'ppo',
    'on_policy': True,
    'cuda': True,
    'action_space': 'continuous',
    'discount_factor': 0.99,
    'gae_lambda': 0.95,
    'epoch_per_collect': 10,
    'batch_size': 320,
    'learning_rate': 0.0003,
    'lr_scheduler': None,
    'weight_decay': 0,
    'value_weight': 0.5,
    'entropy_weight': 0.01,
    'clip_ratio': 0.2,
    'adv_norm': True,
    'value_norm': 'baseline',
    'ppo_param_init': True,
    'grad_norm': 0.5,
    'n_sample': 3200,
    'unroll_len': 1,
    'deterministic_eval': True,
    'model': {},
    'cfg_type': 'PPOFPolicyDict',
    'env_id': 'Hopper-v3',
    'exp_name': 'Hopper-v3-PPO'
}

Training Procedure

Model Information

Environments