Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,290 @@
+---
+language: en
+license: apache-2.0
+library_name: pytorch
+tags:
+- deep-reinforcement-learning
+- reinforcement-learning
+- DI-engine
+- Pendulum-v1
+benchmark_name: OpenAI/Gym/ClassicControl
+task_name: Pendulum-v1
+pipeline_tag: reinforcement-learning
+model-index:
+- name: TD3
+  results:
+  - task:
+      type: reinforcement-learning
+      name: reinforcement-learning
+    dataset:
+      name: OpenAI/Gym/ClassicControl-Pendulum-v1
+      type: OpenAI/Gym/ClassicControl-Pendulum-v1
+    metrics:
+    - type: mean_reward
+      value: -200.85 +/- 155.78
+      name: mean_reward
+---
+
+# Play **Pendulum-v1** with **TD3** Policy
+
+## Model Description
+<!-- Provide a longer summary of what this model is. -->
+This is a simple **TD3** implementation to OpenAI/Gym/ClassicControl **Pendulum-v1** 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
+<details close>
+<summary>(Click for Details)</summary>
+
+```shell
+# install huggingface_ding
+git clone https://github.com/opendilab/huggingface_ding.git
+pip3 install -e ./huggingface_ding/
+# install environment dependencies if needed
+pip3 install DI-engine[common_env]
+```
+</details>
+
+### Git Clone from Huggingface and Run the Model
+
+<details close>
+<summary>(Click for Details)</summary>
+
+```shell
+# running with trained model
+python3 -u run.py
+```
+**run.py**
+```python
+from ding.bonus import TD3Agent
+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 = TD3Agent(
+    env="pendulum", exp_name="Pendulum-v1-TD3", 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>
+
+### Run Model by Using Huggingface_ding
+
+<details close>
+<summary>(Click for Details)</summary>
+
+```shell
+# running with trained model
+python3 -u run.py
+```
+**run.py**
+```python
+from ding.bonus import TD3Agent
+from huggingface_ding import pull_model_from_hub
+
+# Pull model from Hugggingface hub
+policy_state_dict, cfg = pull_model_from_hub(repo_id="OpenDILabCommunity/Pendulum-v1-TD3")
+# Instantiate the agent
+agent = TD3Agent(
+    env="pendulum",
+    exp_name="Pendulum-v1-TD3",
+    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>
+
+## Model Training
+
+### Train the Model and Push to Huggingface_hub
+
+<details close>
+<summary>(Click for Details)</summary>
+
+```shell
+#Training Your Own Agent
+python3 -u train.py
+```
+**train.py**
+```python
+from ding.bonus import TD3Agent
+from huggingface_ding import push_model_to_hub
+
+# Instantiate the agent
+agent = TD3Agent("pendulum", exp_name="Pendulum-v1-TD3")
+# Train the agent
+return_ = agent.train(step=int(4000000))
+# Push model to huggingface hub
+push_model_to_hub(
+    agent=agent.best,
+    env_name="OpenAI/Gym/ClassicControl",
+    task_name="Pendulum-v1",
+    algo_name="TD3",
+    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/td3.html",
+    github_doc_env_url="https://di-engine-docs.readthedocs.io/en/latest/13_envs/pendulum.html",
+    installation_guide="pip3 install DI-engine[common_env]",
+    usage_file_by_git_clone="./td3/pendulum_td3_deploy.py",
+    usage_file_by_huggingface_ding="./td3/pendulum_td3_download.py",
+    train_file="./td3/pendulum_td3.py",
+    repo_id="OpenDILabCommunity/Pendulum-v1-TD3"
+)
+
+```
+</details>
+
+**Configuration**
+<details close>
+<summary>(Click for Details)</summary>
+
+
+```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': -250,
+        'collector_env_num': 8,
+        'evaluator_env_num': 5,
+        'act_scale': True,
+        'n_evaluator_episode': 5
+    },
+    'policy': {
+        'model': {
+            'twin_critic': True,
+            'obs_shape': 3,
+            'action_shape': 1,
+            'action_space': 'regression'
+        },
+        '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': 2,
+            'batch_size': 128,
+            'learning_rate_actor': 0.001,
+            'learning_rate_critic': 0.001,
+            'ignore_done': True,
+            'target_theta': 0.005,
+            'discount_factor': 0.99,
+            'actor_update_freq': 2,
+            'noise': True,
+            'noise_sigma': 0.1,
+            'noise_range': {
+                'min': -0.5,
+                'max': 0.5
+            }
+        },
+        'collect': {
+            'collector': {
+                'collect_print_freq': 1000
+            },
+            'unroll_len': 1,
+            'noise_sigma': 0.1,
+            'n_sample': 48
+        },
+        'eval': {
+            'evaluator': {
+                'eval_freq': 100,
+                'render': {
+                    'render_freq': -1,
+                    'mode': 'train_iter'
+                },
+                'cfg_type': 'InteractionSerialEvaluatorDict',
+                'n_episode': 5,
+                'stop_value': -250
+            }
+        },
+        'other': {
+            'replay_buffer': {
+                'replay_buffer_size': 20000
+            }
+        },
+        'on_policy': False,
+        'cuda': False,
+        'multi_gpu': False,
+        'bp_update_sync': True,
+        'traj_len_inf': False,
+        'type': 'td3',
+        'priority': False,
+        'priority_IS_weight': False,
+        'random_collect_size': 800,
+        'transition_with_policy_data': False,
+        'action_space': 'continuous',
+        'reward_batch_norm': False,
+        'multi_agent': False,
+        'cfg_type': 'TD3PolicyDict'
+    },
+    'exp_name': 'Pendulum-v1-TD3',
+    'seed': 0,
+    'wandb_logger': {
+        'gradient_logger': True,
+        'video_logger': True,
+        'plot_logger': True,
+        'action_logger': True,
+        'return_logger': False
+    }
+}
+
+```
+</details>
+
+**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/zhangpaipai/Pendulum-v1-TD3)
+
+## Model Information
+<!-- Provide the basic links for the model. -->
+- **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/td3.html)
+- **Configuration:** [config link](https://huggingface.co/OpenDILabCommunity/Pendulum-v1-TD3/blob/main/policy_config.py)
+- **Demo:** [video](https://huggingface.co/OpenDILabCommunity/Pendulum-v1-TD3/blob/main/replay.mp4)
+<!-- Provide the size information for the model. -->
+- **Parameters total size:** 53.01 KB
+- **Last Update Date:** 2023-04-29
+
+## 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/ClassicControl
+- **Task:** Pendulum-v1
+- **Gym version:** 0.25.1
+- **DI-engine version:** v0.4.7
+- **PyTorch version:** 1.7.1
+- **Doc**: [DI-engine-docs Environments link](https://di-engine-docs.readthedocs.io/en/latest/13_envs/pendulum.html)