# Template Builder for compliance reports

> Template Builder for compliance reports - For regulated industries, how to use Template Builder to
> generate required documentation using the provided compliance template or a custom template.

This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context.

Companion generated at `2026-04-24T16:03:56.580086+00:00` (UTC).

## Primary page

- [Template Builder for compliance reports](https://docs.datarobot.com/en/docs/classic-ui/modeling/analyze-models/compliance-classic/template-builder.html): Full documentation for this topic (HTML).

## Sections on this page

- [Create and edit templates](https://docs.datarobot.com/en/docs/classic-ui/modeling/analyze-models/compliance-classic/template-builder.html#create-and-edit-templates): In-page section heading.
- [Customize templates with key values](https://docs.datarobot.com/en/docs/classic-ui/modeling/analyze-models/compliance-classic/template-builder.html#customize-templates-with-key-values): In-page section heading.
- [Share a template](https://docs.datarobot.com/en/docs/classic-ui/modeling/analyze-models/compliance-classic/template-builder.html#share-a-template): In-page section heading.

## Related documentation

- [Classic UI documentation](https://docs.datarobot.com/en/docs/classic-ui/index.html): Linked from this page.
- [Modeling](https://docs.datarobot.com/en/docs/classic-ui/modeling/index.html): Linked from this page.
- [Model insights](https://docs.datarobot.com/en/docs/classic-ui/modeling/analyze-models/index.html): Linked from this page.
- [Compliance](https://docs.datarobot.com/en/docs/classic-ui/modeling/analyze-models/compliance-classic/index.html): Linked from this page.
- [custom template for regression models](https://docs.datarobot.com/en/docs/classic-ui/mlops/deployment/registry/custom-template-for-models-without-null-imputation-regression.json): Linked from this page.
- [custom template for binary classification models](https://docs.datarobot.com/en/docs/classic-ui/mlops/deployment/registry/custom-template-for-models-without-null-imputation-binary.json): Linked from this page.
- [Retrieve the default template](https://docs.datarobot.com/en/docs/api/reference/sdk/compliance-documentation.html#datarobot.models.compliance_doc.ComplianceDocTemplate.get_default): Linked from this page.
- [Retrieve the default documentation template](https://docs.datarobot.com/en/docs/api/reference/public-api/compliance_documentation.html#retrieve-the-default-documentation-template): Linked from this page.
- [added key values to a registered model](https://docs.datarobot.com/en/docs/classic-ui/mlops/deployment/registry/reg-key-values.html): Linked from this page.

## Documentation content

# Template Builder

In some regulated industries, models have to go through a rigorous validation process which can be tedious, time-consuming, and can potentially block the deployment of models to production. DataRobot's [Automated Compliance Documentation](https://docs.datarobot.com/en/docs/classic-ui/modeling/analyze-models/compliance-classic/index.html) accelerates this process by automating the necessary documentation requirements that accompany such use cases. The Template Builder allows you to create, edit, and share custom documentation templates to fit your needs and speed up the validation process. Generate automated documentation using the provided compliance documentation template or create and share custom, user-defined templates that are more closely aligned with your documentation requirements.

## Create and edit templates

For a user with template administrator permissions, the Template Builder can be found by going to the user dropdown menu found in the upper-right corner of the application.

From the Template Builder page, if this is the first template, click Create template in the center of the page. If one or more templates exist, click + Create new template in the upper-left corner of the page:

**No templates:**
[https://docs.datarobot.com/en/docs/images/template-builder-1a.png](https://docs.datarobot.com/en/docs/images/template-builder-1a.png)

**One or more templates:**
[https://docs.datarobot.com/en/docs/images/template-builder-1b.png](https://docs.datarobot.com/en/docs/images/template-builder-1b.png)


> [!NOTE] Get the default template or work with JSON via API
> The DataRobot default compliance template is not available for download in the UI. To retrieve the default template as JSON, create a template from a JSON file, or update templates programmatically using the API:
> 
> Python API client:
> Retrieve the default template
> and
> create a template from a JSON file
> .
> REST API:
> Retrieve the default documentation template
> ; use the endpoints on the linked page to create or update templates from JSON.

In the Select a project type dialog box, click Time series, Non-time series, or Text generation to determine which sections and components are available for the template.

To view the available sections and components, click + Add new section and select a new section to add to the template.

If the template includes one or more sections, to add sections and components to a specific location, click the section menu, then, hover over Add section > and select Above, Below, or Sub:

> [!TIP] Edit or delete existing sections
> From the section menu, you can also Edit or Delete the existing sections.

In the New content panel, switch between Sections and Components to view and select the new content you want to add to the custom template.

- Sectionsare predefined portions of content describing different aspects of the specified model. They usually include a visualization such as a chart or a table with associated explanation text. You can edit sections added from theCustom Sectionlist to display custom text and organization of the document.
- Componentsare more granular than sections. They only contain certain visualizations describing results of the model without the surrounding explanation text.

> [!TIP] Cancel new section addition
> Cancel the addition of a new section or component by clicking the delete icon in the upper-right corner of the New content panel.

To rearrange the sections and subsections added to the custom template, click Rearrange sections.

On the Rearrange Sections page, click a section and drag it to the desired position. Drag a section up or down to reorder the template, or, drag a section left or right to determine if that section is a subsection of the section immediately above it. Click Apply to accept the new section arrangement for the template.

After the template is finalized, click Save changes. Then, use the preview option to see what a document rendered from the template would look like before assigning it to users in your organization to generate model documentation. This step inserts dummy data for the preview. It is not a finished document because it is not associated with a model yet.

## Customize templates with key values

If you've [added key values to a registered model](https://docs.datarobot.com/en/docs/classic-ui/mlops/deployment/registry/reg-key-values.html), you can build custom compliance documentation template with references to those key values. Referencing key values in a compliance documentation template adds the associated data to the generated compliance documentation, limiting the amount of manual editing needed to complete the compliance documentation.

To reference key values in a compliance documentation template:

1. In the template, on theKey Valuespanel, select a model package with key values from theRegistered Model Versionlist.
2. To add a key value reference to the template, edit a section, click to place the cursor where you want to insert the reference, then click the key value in theKey Valuespanel. NoteYou can include string, numeric, boolean, image, and dataset key values in custom compliance documentation templates. After you add a value, you can remove it by deleting the reference from the section.
3. To preview the document, clickSave changesand then clickPreview template. As the template is not applied to any specific model package until you generate the compliance documentation, the preview displays placeholders for the key value.

## Share a template

Once you have created a template you can share it with other users, groups, or organizations within the DataRobot platform. Navigate to the Template Builder homepage where all templates are listed and click on the action menu for the template you would like to share.

Once on the menu, you can view and edit the permissions for the template. To add permissions, search the name of the user, group, or organization you want to share with in the Share with others field. Choose the permission level (User or Owner) and then save the modifications.
