zjowowen commited on
Commit
b97b404
·
1 Parent(s): 0b1ff7b

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +11 -61
README.md CHANGED
@@ -21,7 +21,7 @@ model-index:
21
  type: OpenAI/Gym/Atari-QbertNoFrameskip-v4
22
  metrics:
23
  - type: mean_reward
24
- value: 2531.25 +/- 3547.33
25
  name: mean_reward
26
  ---
27
 
@@ -60,23 +60,7 @@ python3 -u run.py
60
  ```
61
  **run.py**
62
  ```python
63
- from ding.bonus import C51Agent
64
- from ding.config import Config
65
- from easydict import EasyDict
66
- import torch
67
-
68
- # Pull model from files which are git cloned from huggingface
69
- policy_state_dict = torch.load("pytorch_model.bin", map_location=torch.device("cpu"))
70
- cfg = EasyDict(Config.file_to_dict("policy_config.py"))
71
- # Instantiate the agent
72
- agent = C51Agent(
73
- env="QbertNoFrameskip", exp_name="QbertNoFrameskip-v4-C51", cfg=cfg.exp_config, policy_state_dict=policy_state_dict
74
- )
75
- # Continue training
76
- agent.train(step=5000)
77
- # Render the new agent performance
78
- agent.deploy(enable_save_replay=True)
79
-
80
  ```
81
  </details>
82
 
@@ -91,20 +75,7 @@ python3 -u run.py
91
  ```
92
  **run.py**
93
  ```python
94
- from ding.bonus import C51Agent
95
- from huggingface_ding import pull_model_from_hub
96
-
97
- # Pull model from Hugggingface hub
98
- policy_state_dict, cfg = pull_model_from_hub(repo_id="OpenDILabCommunity/QbertNoFrameskip-v4-C51")
99
- # Instantiate the agent
100
- agent = C51Agent(
101
- env="QbertNoFrameskip", exp_name="QbertNoFrameskip-v4-C51", cfg=cfg.exp_config, policy_state_dict=policy_state_dict
102
- )
103
- # Continue training
104
- agent.train(step=5000)
105
- # Render the new agent performance
106
- agent.deploy(enable_save_replay=True)
107
-
108
  ```
109
  </details>
110
 
@@ -121,30 +92,7 @@ python3 -u train.py
121
  ```
122
  **train.py**
123
  ```python
124
- from ding.bonus import C51Agent
125
- from huggingface_ding import push_model_to_hub
126
-
127
- # Instantiate the agent
128
- agent = C51Agent(env="QbertNoFrameskip", exp_name="QbertNoFrameskip-v4-C51")
129
- # Train the agent
130
- return_ = agent.train(step=int(20000000))
131
- # Push model to huggingface hub
132
- push_model_to_hub(
133
- agent=agent.best,
134
- env_name="OpenAI/Gym/Atari",
135
- task_name="QbertNoFrameskip-v4",
136
- algo_name="C51",
137
- wandb_url=return_.wandb_url,
138
- github_repo_url="https://github.com/opendilab/DI-engine",
139
- github_doc_model_url="https://di-engine-docs.readthedocs.io/en/latest/12_policies/c51.html",
140
- github_doc_env_url="https://di-engine-docs.readthedocs.io/en/latest/13_envs/atari.html",
141
- installation_guide="pip3 install DI-engine[common_env]",
142
- usage_file_by_git_clone="./c51/qbert_c51_deploy.py",
143
- usage_file_by_huggingface_ding="./c51/qbert_c51_download.py",
144
- train_file="./c51/qbert_c51.py",
145
- repo_id="OpenDILabCommunity/QbertNoFrameskip-v4-C51"
146
- )
147
-
148
  ```
149
  </details>
150
 
@@ -171,7 +119,8 @@ exp_config = {
171
  'collector_env_num': 8,
172
  'evaluator_env_num': 8,
173
  'env_id': 'QbertNoFrameskip-v4',
174
- 'frame_stack': 4
 
175
  },
176
  'policy': {
177
  'model': {
@@ -216,6 +165,7 @@ exp_config = {
216
  'render_freq': -1,
217
  'mode': 'train_iter'
218
  },
 
219
  'cfg_type': 'InteractionSerialEvaluatorDict',
220
  'stop_value': 30000,
221
  'n_episode': 8
@@ -260,7 +210,7 @@ exp_config = {
260
 
261
  **Training Procedure**
262
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
263
- - **Weights & Biases (wandb):** [monitor link](https://wandb.ai/zjowowen/QbertNoFrameskip-v4-C51)
264
 
265
  ## Model Information
266
  <!-- Provide the basic links for the model. -->
@@ -270,13 +220,13 @@ exp_config = {
270
  - **Demo:** [video](https://huggingface.co/OpenDILabCommunity/QbertNoFrameskip-v4-C51/blob/main/replay.mp4)
271
  <!-- Provide the size information for the model. -->
272
  - **Parameters total size:** 55276.2 KB
273
- - **Last Update Date:** 2023-05-18
274
 
275
  ## Environments
276
  <!-- 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. -->
277
  - **Benchmark:** OpenAI/Gym/Atari
278
  - **Task:** QbertNoFrameskip-v4
279
  - **Gym version:** 0.25.1
280
- - **DI-engine version:** v0.4.7
281
- - **PyTorch version:** 1.7.1
282
  - **Doc**: [DI-engine-docs Environments link](https://di-engine-docs.readthedocs.io/en/latest/13_envs/atari.html)
 
21
  type: OpenAI/Gym/Atari-QbertNoFrameskip-v4
22
  metrics:
23
  - type: mean_reward
24
+ value: 8300.0 +/- 0.0
25
  name: mean_reward
26
  ---
27
 
 
60
  ```
61
  **run.py**
62
  ```python
63
+ # [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
64
  ```
65
  </details>
66
 
 
75
  ```
76
  **run.py**
77
  ```python
78
+ # [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
79
  ```
80
  </details>
81
 
 
92
  ```
93
  **train.py**
94
  ```python
95
+ # [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
96
  ```
97
  </details>
98
 
 
119
  'collector_env_num': 8,
120
  'evaluator_env_num': 8,
121
  'env_id': 'QbertNoFrameskip-v4',
122
+ 'frame_stack': 4,
123
+ 'env_wrapper': 'atari_default'
124
  },
125
  'policy': {
126
  'model': {
 
165
  'render_freq': -1,
166
  'mode': 'train_iter'
167
  },
168
+ 'figure_path': None,
169
  'cfg_type': 'InteractionSerialEvaluatorDict',
170
  'stop_value': 30000,
171
  'n_episode': 8
 
210
 
211
  **Training Procedure**
212
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
213
+ - **Weights & Biases (wandb):** [monitor link](https://wandb.ai/anony-moose-281353441759581725/QbertNoFrameskip-v4-C51?apiKey=d148cead9d59fbdabf4ef34f646a7ed95795e5bb)
214
 
215
  ## Model Information
216
  <!-- Provide the basic links for the model. -->
 
220
  - **Demo:** [video](https://huggingface.co/OpenDILabCommunity/QbertNoFrameskip-v4-C51/blob/main/replay.mp4)
221
  <!-- Provide the size information for the model. -->
222
  - **Parameters total size:** 55276.2 KB
223
+ - **Last Update Date:** 2023-07-24
224
 
225
  ## Environments
226
  <!-- 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. -->
227
  - **Benchmark:** OpenAI/Gym/Atari
228
  - **Task:** QbertNoFrameskip-v4
229
  - **Gym version:** 0.25.1
230
+ - **DI-engine version:** v0.4.8
231
+ - **PyTorch version:** 2.0.1+cu117
232
  - **Doc**: [DI-engine-docs Environments link](https://di-engine-docs.readthedocs.io/en/latest/13_envs/atari.html)