---
language: en
license: apache-2.0
library_name: pytorch
tags:
- deep-reinforcement-learning
- reinforcement-learning
- DI-engine
- HalfCheetah-v3
benchmark_name: OpenAI/Gym/MuJoCo
task_name: HalfCheetah-v3
pipeline_tag: reinforcement-learning
model-index:
- name: SAC
results:
- task:
type: reinforcement-learning
name: reinforcement-learning
dataset:
name: OpenAI/Gym/MuJoCo-HalfCheetah-v3
type: OpenAI/Gym/MuJoCo-HalfCheetah-v3
metrics:
- type: mean_reward
value: 11902.91 +/- 87.23
name: mean_reward
---
# Play **HalfCheetah-v3** with **SAC** Policy
## Model Description
This is a simple **SAC** implementation to OpenAI/Gym/MuJoCo **HalfCheetah-v3** using the [DI-engine library](https://github.com/opendilab/di-engine) and the [DI-zoo](https://github.com/opendilab/DI-engine/tree/main/dizoo).
**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)
```shell
# 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]
```
### Git Clone from Huggingface and Run the Model
(Click for Details)
```shell
# running with trained model
python3 -u run.py
```
**run.py**
```python
# [More Information Needed]
```
### Run Model by Using Huggingface_ding
(Click for Details)
```shell
# running with trained model
python3 -u run.py
```
**run.py**
```python
# [More Information Needed]
```
## Model Training
### Train the Model and Push to Huggingface_hub
(Click for Details)
```shell
#Training Your Own Agent
python3 -u train.py
```
**train.py**
```python
# [More Information Needed]
```
**Configuration**
(Click for Details)
```python
exp_config = {
'env': {
'manager': {
'episode_num': float("inf"),
'max_retry': 1,
'retry_type': 'reset',
'auto_reset': True,
'step_timeout': None,
'reset_timeout': None,
'retry_waiting_time': 0.1,
'cfg_type': 'BaseEnvManagerDict'
},
'stop_value': 12000,
'n_evaluator_episode': 8,
'env_id': 'HalfCheetah-v3',
'collector_env_num': 1,
'evaluator_env_num': 8,
'env_wrapper': 'mujoco_default'
},
'policy': {
'model': {
'twin_critic': True,
'action_space': 'reparameterization',
'obs_shape': 17,
'action_shape': 6,
'actor_head_hidden_size': 256,
'critic_head_hidden_size': 256
},
'learn': {
'learner': {
'train_iterations': 1000000000,
'dataloader': {
'num_workers': 0
},
'log_policy': True,
'hook': {
'load_ckpt_before_run': '',
'log_show_after_iter': 100,
'save_ckpt_after_iter': 10000,
'save_ckpt_after_run': True
},
'cfg_type': 'BaseLearnerDict'
},
'update_per_collect': 1,
'batch_size': 256,
'learning_rate_q': 0.001,
'learning_rate_policy': 0.001,
'learning_rate_alpha': 0.0003,
'target_theta': 0.005,
'discount_factor': 0.99,
'alpha': 0.2,
'auto_alpha': False,
'log_space': True,
'target_entropy': None,
'ignore_done': True,
'init_w': 0.003,
'reparameterization': True
},
'collect': {
'collector': {},
'n_sample': 1,
'unroll_len': 1,
'collector_logit': False
},
'eval': {
'evaluator': {
'eval_freq': 1000,
'render': {
'render_freq': -1,
'mode': 'train_iter'
},
'figure_path': None,
'cfg_type': 'InteractionSerialEvaluatorDict',
'stop_value': 12000,
'n_episode': 8
}
},
'other': {
'replay_buffer': {
'replay_buffer_size': 1000000
}
},
'on_policy': False,
'cuda': True,
'multi_gpu': False,
'bp_update_sync': True,
'traj_len_inf': False,
'type': 'sac',
'priority': False,
'priority_IS_weight': False,
'random_collect_size': 10000,
'transition_with_policy_data': True,
'multi_agent': False,
'cfg_type': 'SACPolicyDict',
'command': {}
},
'exp_name': 'HalfCheetah-v3-SAC',
'seed': 0,
'wandb_logger': {
'gradient_logger': True,
'video_logger': True,
'plot_logger': True,
'action_logger': True,
'return_logger': False
}
}
```
**Training Procedure**
- **Weights & Biases (wandb):** [monitor link](https://wandb.ai/zjowowen/HalfCheetah-v3-SAC)
## Model Information
- **Github Repository:** [repo link](https://github.com/opendilab/DI-engine)
- **Doc**: [DI-engine-docs Algorithm link](https://di-engine-docs.readthedocs.io/en/latest/12_policies/sac.html)
- **Configuration:** [config link](https://huggingface.co/OpenDILabCommunity/HalfCheetah-v3-SAC/blob/main/policy_config.py)
- **Demo:** [video](https://huggingface.co/OpenDILabCommunity/HalfCheetah-v3-SAC/blob/main/replay.mp4)
- **Parameters total size:** 1702.11 KB
- **Last Update Date:** 2023-09-19
## Environments
- **Benchmark:** OpenAI/Gym/MuJoCo
- **Task:** HalfCheetah-v3
- **Gym version:** 0.25.1
- **DI-engine version:** v0.4.9
- **PyTorch version:** 2.0.1+cu117
- **Doc**: [DI-engine-docs Environments link](https://di-engine-docs.readthedocs.io/en/latest/13_envs/mujoco.html)