polish(pu): add customization documentation section in readme

opendilab · Mar 15, 2024 · 52ec71e · 52ec71e
1 parent 3a7424d
commit 52ec71e
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@
 [![Contributors](https://img.shields.io/github/contributors/opendilab/LightZero)](https://github.com/opendilab/LightZero/graphs/contributors)
 [![GitHub license](https://img.shields.io/github/license/opendilab/LightZero)](https://github.com/opendilab/LightZero/blob/master/LICENSE)
 
-Updated on 2024.02.08 LightZero-v0.0.4
+Updated on 2024.03.15 LightZero-v0.0.4
 
 > LightZero is a lightweight, efficient, and easy-to-understand open-source algorithm toolkit that combines Monte Carlo Tree Search (MCTS) and Deep Reinforcement Learning (RL). 
 
@@ -207,6 +207,15 @@ cd LightZero
 python3 -u zoo/board_games/tictactoe/config/tictactoe_muzero_bot_mode_config.py
 ```
 
+## Customization Documentation
+
+For those looking to tailor environments and algorithms, we offer comprehensive guides:
+
+- **Environments:** [Customize Environments](https://github.com/opendilab/LightZero/blob/main/docs/source/tutorials/envs/customize_envs.md)
+- **Algorithms:** [Customize Algorithms](https://github.com/opendilab/LightZero/blob/main/docs/source/tutorials/algos/customize_algos.md)
+
+Should you have any questions, feel free to contact us for support.
+
 ## Benchmark
 
 <details open><summary>Click to collapse</summary>

diff --git a/README.zh.md b/README.zh.md
@@ -27,7 +27,7 @@
 [![Contributors](https://img.shields.io/github/contributors/opendilab/LightZero)](https://github.com/opendilab/LightZero/graphs/contributors)
 [![GitHub license](https://img.shields.io/github/license/opendilab/LightZero)](https://github.com/opendilab/LightZero/blob/master/LICENSE)
 
-最近更新于 2024.02.08 LightZero-v0.0.4
+最近更新于 2024.03.15 LightZero-v0.0.4
 
 > LightZero 是一个轻量、高效、易懂的 MCTS+RL 开源算法库。
 
@@ -191,6 +191,14 @@ python3 -u zoo/atari/config/atari_muzero_config.py
 cd LightZero
 python3 -u zoo/board_games/tictactoe/config/tictactoe_muzero_bot_mode_config.py
 ```
+## 定制化文档
+
+为希望定制环境和算法的用户，我们提供了全面的指南：
+
+- **环境定制：** [定制环境](https://github.com/opendilab/LightZero/blob/main/docs/source/tutorials/envs/customize_envs_zh.md)
+- **算法定制：** [定制算法](https://github.com/opendilab/LightZero/blob/main/docs/source/tutorials/algos/customize_algos_zh.md)
+
+如有任何疑问，欢迎随时联系我们寻求帮助。
 
 ## 基线算法比较