Upload README.md with huggingface_hub

README.md

@@ -21,7 +21,7 @@ model-index:
       type: OpenAI/Gym/Atari-PongNoFrameskip-v4
     metrics:
     - type: mean_reward
-      value: 16.6 +/- 8.8
+      value: 20.7 +/- 0.46
       name: mean_reward
 ---
 
@@ -60,7 +60,23 @@ python3 -u run.py
 ```
 **run.py**
 ```python
-# [More Information Needed]
+from ding.bonus import DQNAgent
+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 = DQNAgent(
+    env_id="PongNoFrameskip-v4", exp_name="PongNoFrameskip-v4-DQN", 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>
 
@@ -75,7 +91,20 @@ python3 -u run.py
 ```
 **run.py**
 ```python
-# [More Information Needed]
+from ding.bonus import DQNAgent
+from huggingface_ding import pull_model_from_hub
+
+# Pull model from Hugggingface hub
+policy_state_dict, cfg = pull_model_from_hub(repo_id="OpenDILabCommunity/PongNoFrameskip-v4-DQN")
+# Instantiate the agent
+agent = DQNAgent(
+    env_id="PongNoFrameskip-v4", exp_name="PongNoFrameskip-v4-DQN", 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>
 
@@ -92,7 +121,31 @@ python3 -u train.py
 ```
 **train.py**
 ```python
-# [More Information Needed]
+from ding.bonus import DQNAgent
+from huggingface_ding import push_model_to_hub
+
+# Instantiate the agent
+agent = DQNAgent(env_id="PongNoFrameskip-v4", exp_name="PongNoFrameskip-v4-DQN")
+# Train the agent
+return_ = agent.train(step=int(20000000), collector_env_num=8, evaluator_env_num=8, debug=False)
+# Push model to huggingface hub
+push_model_to_hub(
+    agent=agent.best,
+    env_name="OpenAI/Gym/Atari",
+    task_name="PongNoFrameskip-v4",
+    algo_name="DQN",
+    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/dqn.html",
+    github_doc_env_url="https://di-engine-docs.readthedocs.io/en/latest/13_envs/atari.html",
+    installation_guide="pip3 install DI-engine[common_env]",
+    usage_file_by_git_clone="./dqn/pong_dqn_deploy.py",
+    usage_file_by_huggingface_ding="./dqn/pong_dqn_download.py",
+    train_file="./dqn/pong_dqn.py",
+    repo_id="OpenDILabCommunity/PongNoFrameskip-v4-DQN",
+    create_repo=False
+)
+
 ```
 </details>
 
@@ -163,7 +216,6 @@ exp_config = {
                     'mode': 'train_iter'
                 },
                 'figure_path': None,
-                'return_env_info': True,
                 'cfg_type': 'InteractionSerialEvaluatorDict',
                 'stop_value': 30,
                 'n_episode': 8
@@ -218,13 +270,13 @@ exp_config = {
 - **Demo:** [video](https://huggingface.co/OpenDILabCommunity/PongNoFrameskip-v4-DQN/blob/main/replay.mp4)
 <!-- Provide the size information for the model. -->
 - **Parameters total size:** 55703.03 KB
-- **Last Update Date:** 2023-07-27
+- **Last Update Date:** 2023-09-21
 
 ## 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. -->
 - **Benchmark:** OpenAI/Gym/Atari
 - **Task:** PongNoFrameskip-v4
 - **Gym version:** 0.25.1
-- **DI-engine version:** v0.4.8
+- **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/atari.html)