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: 17.0 +/- 0.0
+      value: -0.6 +/- 16.4
       name: mean_reward
 ---
 
@@ -60,23 +60,7 @@ python3 -u run.py
 ```
 **run.py**
 ```python
-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"))
-# Instantiate the agent
-agent = DQNAgent(
-    env="PongNoFrameskip", 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)
-
+# [More Information Needed]
 ```
 </details>
 
@@ -91,20 +75,7 @@ python3 -u run.py
 ```
 **run.py**
 ```python
-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="PongNoFrameskip", 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)
-
+# [More Information Needed]
 ```
 </details>
 
@@ -121,31 +92,7 @@ python3 -u train.py
 ```
 **train.py**
 ```python
-from ding.bonus import DQNAgent
-from huggingface_ding import push_model_to_hub
-
-# Instantiate the agent
-agent = DQNAgent(env="PongNoFrameskip", exp_name="PongNoFrameskip-v4-DQN")
-# Train the agent
-return_ = agent.train(step=int(10000000), collector_env_num=8, evaluator_env_num=8, debug=False)
-print("-----wandb url is----:", return_.wandb_url)
-# 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"
-)
-
+# [More Information Needed]
 ```
 </details>
 
@@ -172,7 +119,8 @@ exp_config = {
         'env_id': 'PongNoFrameskip-v4',
         'collector_env_num': 8,
         'evaluator_env_num': 8,
-        'fram_stack': 4
+        'fram_stack': 4,
+        'env_wrapper': 'atari_default'
     },
     'policy': {
         'model': {
@@ -214,6 +162,7 @@ exp_config = {
                     'render_freq': -1,
                     'mode': 'train_iter'
                 },
+                'figure_path': None,
                 'cfg_type': 'InteractionSerialEvaluatorDict',
                 'stop_value': 20,
                 'n_episode': 8
@@ -258,7 +207,7 @@ exp_config = {
 
 **Training Procedure** 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-- **Weights & Biases (wandb):** [monitor link](https://wandb.ai/ruoyugao/PongNoFrameskip-v4-DQN)
+- **Weights & Biases (wandb):** [monitor link](https://wandb.ai/zjowowen/PongNoFrameskip-v4-DQN)
 
 ## Model Information
 <!-- Provide the basic links for the model. -->
@@ -268,7 +217,7 @@ 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-06-14
+- **Last Update Date:** 2023-07-23
 
 ## 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. -->
@@ -276,5 +225,5 @@ exp_config = {
 - **Task:** PongNoFrameskip-v4
 - **Gym version:** 0.25.1
 - **DI-engine version:** v0.4.8
-- **PyTorch version:** 1.7.1
+- **PyTorch version:** 2.0.1+cu117
 - **Doc**: [DI-engine-docs Environments link](https://di-engine-docs.readthedocs.io/en/latest/13_envs/atari.html)