AutoDoc 自定义模板占位符

以下各节介绍 AutoDoc 的自定义模板特征的占位符。

使用占位符

您可使用占位符自定义 AutoDoc 报告中显示的内容。当您将占位符插入模板中时，该特定占位符的唯一内容会显示在生成报告中的插入位置上。

占位符定义如下：

{{p section.render('placeholder_name')}}

下例显示如何定义 Experiment Overview.DAI 实验管道列类型 占位符：

{{p section.render('Experiment Overview.DAI Experiment Pipeline Column Types')}}

占位符列表

与 实验概述 相关的占位符：

名称	描述
Experiment Overview.DAI Experiment Pipeline Column Types	包含 DAI 的不同列类型和类型说明的表格
Experiment Overview.DAI Experiment Pipeline Time Series	包含 DAI 时间序列设置和各个设置的定义的表格
Experiment Overview.DAI GPU Specifications	说明 DAI 是否使用了可用 GPU 的句子
Experiment Overview.DAI Intro Model Goal	关于模型尝试优化的评分器的介绍性段落
Experiment Overview.DAI Iterative Tuning	描述 DAI 实验管道中不同迭代步骤的部分（即模型、特征、目标调优和特征演变）
Experiment Overview.DAI Validation Schema Options	文档类型部分，定义用户可用的不同类型的验证策略
Experiment Overview.Performance	摘要性能表。此表格包括用户所选评分器的每个数据拆分（例如培训、验证、测试）的性能

与 数据概述 相关的占位符：

名称	描述
Data Overview.DAI NLP Feature Preprocessing	如果适用，包括基于 NLP 转换的架构相关信息。
Data Overview.DAI Target Transformation Description	描述是否执行了目标调优以及尝试了哪些目标转换的部分
Data Overview.Intro	包含数据集信息的表格，例如与 DAI 安装位置相关的文件路径、行数和列数
Data Overview.template	本节指向以下占位符：Data Overview.Intro、Data Overview.Training、Data Overview.Shift
Data Overview.Training	包含训练数据摘要统计数据的表格。此占位符可在标准 AutoDoc 中使用。内容类似于 Data Overview.DAI 训练数据详情，但描述性文本较少，且不包含关于缺失值的信息

与 方法 相关的占位符：

名称	描述
Methodology.Assumptions	DAI 的假设和限制的高级概述。本节包括关于是否在数据集之间检测到移位的详细信息
Methodology.DAI Assumptions Detailed	描述用户是否提供了验证数据集以及是否检测到数据集之间分布移位的部分。该小节和 Methodology.Assumptions 部分有一些重叠部分
Methodology.DAI Pipeline Formatted	此占位符类似于 Methodology.Pipeline 模板，但它采用的格式不同（例如，标头使用不同的 Word docx 样式）
Methodology.DAI Preventing Overfit	解释 DAI 一般如何避免过拟合的文档类型部分
Methodology.Intro	一个简要介绍“方法”部分的短句
Methodology.Settings	列示实验设置的部分
Methodology.template	此占位符调用以下占位符：Methodology.Intro、Methodology.Assumptions、Methodology.Pipeline、Methodology.Settings

与 数据抽样 相关的占位符：

名称	描述
Data Sampling.DAI NLP Sampling	如果适用，此占位符提供关于基于 NLP 转换器所执行抽样的信息

与 验证策略 相关的占位符：

名称	描述
Validation Strategy.DAI Fold Information	此占位符旨在与 Validation Strategy.template 配合使用 - 它是 Validation Strategy.template 的占位符
Validation Strategy.DAI Recipe Validation	此模板旨在与 Validation Strategy.template 配合使用 - 它是 Validation Strategy.template 的占位符
Validation Strategy.DAI Time Series Validation	此模板旨在与 Validation Strategy.template 配合使用 - 它是 Validation Strategy.template 的占位符

与 特征演变 相关的占位符：

名称	描述
Feature Evolution.DAI Iteration Plot	DAI 实验页面中的迭代模型绘图
Feature Evolution.DAI Top Feature Evolution Features	特征演变阶段中的主要特征表
Feature Evolution.template	本节概述了特征演变阶段和尝试的一些转换

与 特征转换 相关的占位符：

名称	描述
Feature Transformations.Feature Importance	特征重要性表
Feature Transformations.Intro	介绍特征重要性的部分，包括 Feature Transformations.Feature 重要性部分中的特征重要性表
Feature Transformations.Permutation Feature Importance	介绍排列特征重要性的部分。注意，必须在 AutoDoc 专家设置中启用排列特征重要性，以便在此部分中呈现信息
Feature Transformations.template	此模板用于调用占位符：Feature Transformation.Intro、Feature Transformations.Permutation 特征重要性、NLP.DAI NLP 详情

与 最终模型 相关的占位符：

名称	描述
Final Model.DAI All Feature Transformations	此占位符设计用于附录部分。此部分包括完整的特征重要性数据集，并且不限于用户指定的特征数量
Final Model.DAI Final Model Architecture	介绍最终模型组件的部分
Final Model.DAI Final Model Components Table	包含最终模型的摘要组件的表格，如模型类型、模型权重、折叠数等。
Final Model.DAI Final Model Performance Table	包含最终模型在可用评分器中的性能的表格
Final Model.DAI Final Model Performance Text	此模板应该在 Experiment Overview.DAI 迭代调优占位符之后直接调用。此占位符包括一段关于最终模型选择的简短段落和一个性能表
Final Model.DAI Model and Component Table	此部分包括模型组件表（即此占位符调用 Final Model.DAI 最终模型组件表），其中显示模型类型、模型权重、折叠数等信息。
Final Model.DAI Model Objective Table	包含最终模型优化损失函数的表格 - 它与用户选择的评分器不同。此占位符由 Final Model.DAI 损失函数占位符调用
Final Model.DAI Model Package Description	此表提供算法名称、包名称、包版本和包的主要文档字符串。此占位符由 Final Model.DAI 模型组件占位符调用
Final Model.DAI Models Evaluated Table	此表包含 DAI 中的可用算法，以及为最终模型选择或不选择某个算法的原因。此占位符由 Final Model.DAI 模型组件占位符调用
Final Model.Pipeline Overview	此占位符由 Final Model.Pipeline 占位符调用，并显示最终模型组件的表格。如果有基础学习器，则显示基础学习器的模型组件
Final Model.template	此占位符调用以下占位符：Image Processing.template、Final Model.Pipeline、Final Model.Performance、Final Model.GLM、Final Model.PSI、Final Model.Prediction Statistics、Final Model.Response Rates、Final Model.Additional Performance

与 广义线性模型 (GLM) 相关的占位符：

名称	描述
GLM.template	如果适用，此部分显示有关 kLIME 全局系数和本地原因码的详细信息

与 文献 相关的占位符：

名称	描述
Literature.DAI Assumptions and Limitations Intro	介绍 DAI 建模技术特定的假设和限制部分的几句话
Literature.DAI Literature Intro	介绍 DAI 文献部分的句子
Literature.DAI Model References	提供 DAI 中模型的说明和参考的部分

与 机器学习可解释性 (MLI) 相关的占位符：

名称	描述
MLI.DAI MLI Intro	此部分包括关于全局可解释性技术的文档样式信息
MLI.DAI MLI Section	此部分包含 kLIME 顶部和底部全局系数表、kLIME 绘图、替代决策树绘图，以及局部可解释性的文档样式概述，之后是 kLIME 原因码、ICE 和 LOCO 绘图。注意，基于局部可解释性的绘图和表格要求用户使用 Python 客户端的 individual_rows 参数指定各个相关记录
MLI.KLIME Plot	kLIME 的说明，带 kLIME 绘图
MLI.KLIME Reason Code Text	介绍 kLIME 原因码的文档类型部分
MLI.Local Interpretability Row Information	仅在提供了用户指定的 individual_rows 时，此占位符才可用。此占位符由 DAI MLI 部分占位符调用
MLI.Surrogate DT	替代决策树绘图。注意，此部分需要一个 mli 密钥，或者如果通过 MLI UI 运行，请确保运行替代决策树解释器和 AutoDoc

与 模型调优 相关的占位符：

名称	描述
Model Tuning.template	类似于 Model Tuning.DAI 超参数占位符。此模板特定于标准 AutoDoc

与 自然语言处理 (NLP) 相关的占位符：

名称	描述
NLP.DAI NLP Detail	类似于 DAI NLP 假设，但包含有关 NLP 转换器抽样和限制的信息，且不区分图像和 NLP 转换器（即，您会在此子模板的正文中看到 NLP/图像）。此模板可在标准 AutoDoc 中使用
NLP.DAI NLP Pipeline Description	此文档类型部分概述了 DAI 的 NLP 转换管道，并定义不同阶段

与 部分依赖性图 (PDP) 相关的占位符：

名称	描述
Partial Dependence Plots.DAI Out-of-Range PDP	此部分显示超范围 PDP，但 Partial Dependence Plots.template 也可显示超范围值
Partial Dependence Plots.DAI Residual Analysis	此部分介绍残差分析并提供有关残差的部分依赖性图
Partial Dependence Plots.DAI Sensitivity Analysis	类似于部分依赖性图 (PDP) 模板。一般来说，此子模板包括有关敏感性分析的更多解释，并显示记录的原始特征值以及叠加到 PDP 上的 ICE。此模板期望用户将 individual_rows 参数传递给有相关记录的 Python 客户端
Partial Dependence Plots.template	此部分介绍部分依赖性图的工作方式，并显示部分依赖性图。此部分用于标准 AutoDoc 模板

与 附录 相关的占位符：

名称	描述
Appendix.DAI Performance Metrics	DAI 性能指标术语表
Appendix.DAI References	标准 AutoDoc 的参考。对于使用 “装袋式集成”（粘贴）的模型，将显示此参考
Appendix.NLP Appendix	完整的 NLP 架构信息。
Appendix.PSI_Appendix	用于计算 PSI 的表格
Appendix.Response_Rates_Appendix	分位数基数绘图计算表。
Appendix.template	此模板指向 Appendix.PSI、Appendix.Response_Rates_Appendix 和 Appendix.NLP 附录。如果最终模型是或包含 GLM，此部分还包括完整的 GLM 系数表和关于如何理解 GLM 系数表的文档。如果用户已将 AutoDoc 设置为显示所有配置，则完整的配置表将显示在附录中。最后，如果使用了装袋式集成（粘贴），则将列出该模型类型的参考