DI-toolkit

一个为opendilab设计的简单工具包，包含以下实用工具：

• ditk.logging，一个易于使用的日志系统
• ditk.annonated，一个注释文档生成脚本
• ditk.tensorboard，用于从tensorboard日志文件中提取数据的工具
  • ditk.tensorboard.plot，用于绘制从tensorboard日志文件中提取的数据的绘图工具

安装

您可以使用pip命令行从官方PyPI站点简单安装它。

pip install DI-toolkit

或者从最新的源代码安装，如下所示：

git clone https://github.com/opendilab/DI-toolkit.git
cd di-toolkit
pip install . --user

快速入门

ditk.logging 示例

这是一个日志记录的例子。

from ditk import logging

if __name__ == '__main__':
    logging.try_init_root(logging.INFO)
    logging.info('这是信息')
    logging.warning('这是带有整数233的警告')
    logging.error('这是带有字符串\'233\'的错误。')

    try:
        _ = 1 / 0
    except ZeroDivisionError as err:
        logging.exception(err)

ditk.logging的接口与原生logging模块几乎相同。您可以直接用from ditk import logging替换代码中的import logging。

ditk.annonated

Python注释文档生成脚本，如下所示

使用方法

python -m ditk.doc.annotated create -i ditk/doc/annotated/ppo.py -o my_doc/index.html -L zh

您将得到

my_doc
├── assets
│   ├── pylit.css
│   └── solarized.css
└── index.html

帮助信息

• python -m ditk.doc.annotated --help

Usage: python -m ditk.doc.annotated [OPTIONS] COMMAND [ARGS]...

  创建注释文档的工具。

Options:
  -v, --version  显示版本信息。
  -h, --help     显示此帮助信息并退出。

Commands:
  create  从本地代码创建注释文档的工具。

• python -m ditk.doc.annotated create --help

Usage: python -m ditk.doc.annotated create [OPTIONS]

  从本地代码创建注释文档的工具。

Options:
  -i, --input_file FILE       输入源代码。  [必需]
  -o, --output_file FILE      输出注释文档代码。  [必需]
  -A, --assets_dir DIRECTORY  此文档的资源文件目录。
  -L, --language [zh|en]      文档语言。  [默认: en]
  -T, --title TEXT            文档标题。  [默认: <未命名文档>]
  -h, --help                  显示此帮助信息并退出。

相关库

• KaTex
• codemirror5
• yattag

创建多种子多算法基准图

import matplotlib.pyplot as plt
import seaborn as sns

from ditk.tensorboard.plots import tb_create_range_plots

sns.set()

tb_create_range_plots(
    'test/testfile/pong_tb',  # tensorboard日志目录
    xname='step',
    yname='evaluator_step/reward_mean',
)

plt.show()

贡献

我们感谢所有为改进DI-toolkit做出的贡献，无论是逻辑还是系统设计。请参阅CONTRIBUTING.md获取更多指南。

许可证

DI-toolkit在Apache 2.0许可下发布。