Upload README.md with huggingface_hub

README.md

@@ -70,7 +70,21 @@ python3 -u run.py
 ```
 **run.py**
 ```python
-# [More Information Needed]
+from ding.bonus import SACAgent
+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 = SACAgent(env_id="HalfCheetah-v3", exp_name="HalfCheetah-v3-SAC", 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)
+
 ```
 </details>
 
@@ -85,7 +99,18 @@ python3 -u run.py
 ```
 **run.py**
 ```python
-# [More Information Needed]
+from ding.bonus import SACAgent
+from huggingface_ding import pull_model_from_hub
+
+# Pull model from Hugggingface hub
+policy_state_dict, cfg = pull_model_from_hub(repo_id="OpenDILabCommunity/HalfCheetah-v3-SAC")
+# Instantiate the agent
+agent = SACAgent(env_id="HalfCheetah-v3", exp_name="HalfCheetah-v3-SAC", 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)
+
 ```
 </details>
 
@@ -102,7 +127,54 @@ python3 -u train.py
 ```
 **train.py**
 ```python
-# [More Information Needed]
+from ding.bonus import SACAgent
+from huggingface_ding import push_model_to_hub
+
+# Instantiate the agent
+agent = SACAgent(env_id="HalfCheetah-v3", exp_name="HalfCheetah-v3-SAC")
+# Train the agent
+return_ = agent.train(step=int(5000000))
+# Push model to huggingface hub
+push_model_to_hub(
+    agent=agent.best,
+    env_name="OpenAI/Gym/MuJoCo",
+    task_name="HalfCheetah-v3",
+    algo_name="SAC",
+    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/sac.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]
+''',
+    usage_file_by_git_clone="./sac/halfcheetah_sac_deploy.py",
+    usage_file_by_huggingface_ding="./sac/halfcheetah_sac_download.py",
+    train_file="./sac/halfcheetah_sac.py",
+    repo_id="OpenDILabCommunity/HalfCheetah-v3-SAC",
+    create_repo=False
+)
+
 ```
 </details>
 
@@ -234,7 +306,7 @@ exp_config = {
 - **Demo:** [video](https://huggingface.co/OpenDILabCommunity/HalfCheetah-v3-SAC/blob/main/replay.mp4)
 <!-- Provide the size information for the model. -->
 - **Parameters total size:** 1702.11 KB
-- **Last Update Date:** 2023-09-19
+- **Last Update Date:** 2023-09-20
 
 ## Environments
 <!-- Address questions around what environment the model is intended to be trained and deployed at, including the necessary information needed to be provided for future users. -->