Skip to content

Commit 09d34bf

Browse files
committed
dev(hansbug): update the docs homepage
1 parent 3cada11 commit 09d34bf

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/source/index.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,19 @@ Welcome to DI-toolkit's Documentation
44
Overview
55
-------------
66

7-
``DI-toolkit`` is a module which can parse and manage the \
8-
configuration file's structure and their versions.
7+
``DI-toolkit`` is a fundamental utility library within the OpenDILab ecosystem, designed to provide stable and efficient foundational support for other repositories in OpenDILab. It not only parses and manages the structure and versions of configuration files but also offers a range of practical tools to simplify common tasks such as distributed training, log management, and TensorBoard data processing, thereby accelerating the process of deep reinforcement learning research and development.
8+
9+
The design philosophy of this library is to provide modular and reusable components, reducing redundant efforts and ensuring consistency across OpenDILab projects. By abstracting underlying complexities, ``DI-toolkit`` enables developers to focus more on algorithmic innovation rather than infrastructure setup.
10+
11+
Key Features
12+
-----------------
13+
14+
``DI-toolkit`` provides the following core functional modules to meet common requirements in deep reinforcement learning projects:
15+
16+
* **Config Management**: Powerful configuration file parsing and management capabilities, supporting structured definition, version control, and dynamic loading of configuration files, ensuring flexibility and traceability in experimental configurations.
17+
* **Distributed Training Utilities**: Offers a series of convenient helper functions for PyTorch distributed training, including distributed environment detection, process-level information retrieval (such as rank and world size), and master process determination, greatly simplifying the writing and debugging of distributed training code.
18+
* **Logging System**: Provides a feature-rich logging solution, supporting terminal output, file output, and custom loggers, helping developers efficiently track and debug model training processes.
19+
* **TensorBoard Data Processing**: Includes tools for extracting and processing log data from TensorBoard event files, particularly scalar data, making it easier for users to analyze and visualize experimental results.
920

1021
.. toctree::
1122
:maxdepth: 2

0 commit comments

Comments
 (0)