US 12,743,574 B2 · Model documentation generation system

Abstract

Systems, apparatuses, methods, and computer program products are disclosed for at least semi-automated generation of model documentation. In an example embodiment, a template corresponding to a model is selected. User input populating portions of a build notebook is received. The build notebook comprises a model identifier identifying the model and executable code. The build notebook is executed using an execution engine to cause an intermediary file encoded in a type-setting system to be generated. Executing the build notebook causes cross-references of elements of the model documentation to be mapped to appropriate locations within the intermediary file. The elements comprise graphical representations of results of model tests executed on the model and/or extracted or user-defined artifacts required for the model documentation. The intermediary file is executed using a type-setting system compiler to assemble user-provided text and the elements, in accordance with the template, to generate the model documentation.

Claims20

Dependent claims

A method for generating model documentation in an at least semi-automated manner, the method comprising:

receiving, from a first computing device, first user input selecting or providing information used to select a template corresponding to a model;
processing, via a processor, the template to cause a build notebook to be generated;
receiving, from the first computing device, second user input comprising executable code;
in response to receiving the second user input, executing, via the processor, the executable code to generate a result;
in response to executing the executable code:
populating, via the processor, at least a portion of the build notebook with a first format output that represents the result in a first format,
displaying, via the processor, the first format output to a user, and
generating, via the processor, a second format output that represents the result in a second format that is different from the first format;
executing, via the processor, the build notebook to cause an intermediary file to be generated, wherein the intermediary file comprises the second format output and one or more cross-references to elements to be included in the model documentation;
compiling, via the processor, the intermediary file to generate the model documentation;
and
causing transmission of the model documentation to the first computing device.

9 more elements

A computer program product for generating model documentation in an at least semi-automated manner, the computer program product comprising at least one non-transitory computer-readable storage medium storing software instructions that, when executed, cause an apparatus to:

receive, from a first computing device, first user input selecting or providing information used to select a template corresponding to a model;
process, via a processor, the template to cause a build notebook to be generated;
receive, from the first computing device, second user input comprising executable code;
in response to receiving the second user input, execute, via the processor, the executable code to generate a result;
in response to executing the executable code:
populate, via the processor, at least a portion of the build notebook with a first format output that represents the result in a first format,
display, via the processor, the first format output to a user, and
generate, via the processor, a second format output that represents the result in a second format that is different from the first format;
execute, via the processor, the build notebook to cause an intermediary file to be generated, wherein the intermediary file comprises the second format output and one or more cross-references to elements to be included in the model documentation;
compile, via the processor, the intermediary file to generate the model documentation;
and
cause transmission of the model documentation to the first computing device.

9 more elements

Dependencies are inferred from the claim text.

Model documentation generation system

Life of this patent

Model documentation generation system

Life of this patent

Abstract

Claims20