ding.config

配置

class ding.config.Config(cfg_dict: dict | None = None, cfg_text: str | None = None, filename: str | None = None)

Overview:

配置的基类。

Interface:

__init__, file_to_dict

Property:

cfg_dict

__init__(cfg_dict: dict | None = None, cfg_text: str | None = None, filename: str | None = None) → None

Overview:

初始化方法。创建配置，包括字典类型配置和文本类型配置。

Arguments:

• cfg_dict (Optional[dict]): 字典类型的配置

• cfg_text (Optional[str]): 文本类型配置

• 文件名 (Optional[str]): 配置文件名称

static _file_to_dict(filename: str) → Tuple[dict, str]

Overview:

读取配置文件并将配置文件转换为字典类型的配置和文本类型的配置。

Arguments:

• 文件名 (Optional[str]): 配置文件名。

Returns:

• cfg_dict (Optional[dict]): 字典类型的配置

• cfg_text (Optional[str]): 文本类型配置

static file_to_dict(filename: str) → Config

Overview:

读取配置文件并创建配置。

Arguments:

• 文件名 (Optional[str]): 配置文件名。

Returns:

• cfg_dict (Config): 配置类

读取配置

ding.config.read_config(path: str) → Tuple[dict, dict]

Overview:

从文件路径读取配置（目前仅支持python文件）。并选择一些合适的部分。

Arguments:

• 路径 (str): 配置文件的路径

Returns:

• cfg (Tuple[dict, dict]): 配置字典的集合（元组），分为main_config和create_cfg两部分。

保存配置

ding.config.save_config(config_: dict, path: str, type_: str = 'py', save_formatted: bool = False) → None

Overview:

将配置保存到python文件或yaml文件

Arguments:

• 配置 (dict): 配置字典

• 路径 (str): 目标 yaml 或目标 python 文件的路径

• 类型 (str): 如果类型是 yaml，则将配置保存到yaml文件。如果类型是 py，则将配置保存到python文件。

• save_formatted (bool): 如果 save_formatted 为真，则将格式化配置保存到路径。 格式化配置可以直接由 serial_pipeline 读取。

compile_config

ding.config.compile_config(cfg: ~easydict.EasyDict, env_manager: type | None = None, policy: type | None = None, learner: type = <class 'ding.worker.learner.base_learner.BaseLearner'>, collector: type | None = None, evaluator: type = <class 'ding.worker.collector.interaction_serial_evaluator.InteractionSerialEvaluator'>, buffer: type | None = None, env: type | None = None, reward_model: type | None = None, world_model: type | None = None, seed: int = 0, auto: bool = False, create_cfg: dict | None = None, save_cfg: bool = True, save_path: str = 'total_config.py', renew_dir: bool = True) → EasyDict

Overview:

将输入的配置信息与其他输入信息结合。 编译配置以便其他程序更容易调用。

Arguments:

• cfg (EasyDict): 输入配置字典，将在以下管道中使用

• env_manager (type): 将在以下管道中使用的Env_manager类

• 策略 (type): 用于以下管道的策略类

• 学习者 (type): 输入学习者类，默认为 BaseLearner

• 收集器 (type): 输入收集器类，默认为 BaseSerialCollector

• 评估器 (type): 输入评估器类，默认为 InteractionSerialEvaluator

• 缓冲区 (type): 输入缓冲区类，默认为 IBuffer

• 环境 (type): 用于以下流水线的环境类

• reward_model (type): 奖励模型类，旨在提供多样且有价值的奖励

• seed (int): 随机数种子

• auto (bool): 是否编译create_config字典

• create_cfg (dict): 输入创建配置字典

• save_cfg (bool): 是否保存配置

• 保存路径 (str): 保存文件的路径

• renew_dir (bool): 是否新建一个目录来保存配置。

Returns:

• cfg (EasyDict): 编译后的配置