DMG logo PMML 4.3 - Header
PMML4.3 Menu

Home

Changes

XML Schema

Conformance

Interoperability

General Structure

Field Scope

Header

Data
Dictionary


Mining
Schema


Transformations

Statistics

Taxomony

Targets

Output

Functions

Built-in Functions

Model Verification

Model Explanation

Multiple Models

Association Rules

Baseline Models

Bayesian Network

Cluster
Models


Gaussian
Process


General
Regression


k-Nearest
Neighbors


Naive
Bayes


Neural
Network


Regression

Ruleset

Scorecard

Sequences

Text Models

Time Series

Trees

Vector Machine

PMML 4.3 - Header

<xs:element name="Header">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="Extension" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element minOccurs="0" ref="Application"/>
      <xs:element minOccurs="0" maxOccurs="unbounded" ref="Annotation"/>
      <xs:element minOccurs="0" ref="Timestamp"/>
    </xs:sequence>
    <xs:attribute name="copyright" type="xs:string"/>
    <xs:attribute name="description" type="xs:string"/>
    <xs:attribute name="modelVersion" type="xs:string"/>
  </xs:complexType>
</xs:element>

<xs:element name="Application">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="Extension" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="name" type="xs:string" use="required"/>
    <xs:attribute name="version" type="xs:string"/>
  </xs:complexType>
</xs:element>

<xs:element name="Annotation">
  <xs:complexType mixed="true">
    <xs:sequence>
      <xs:element ref="Extension" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

<xs:element name="Timestamp">
  <xs:complexType mixed="true">
    <xs:sequence>
      <xs:element ref="Extension" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

Header: The top level tag that marks the beginning of the header information.

copyright: This attribute contains the copyright information for this model. Applications producing PMML may allow users to specify the copyright string to be placed here. Starting with PMML 4.1 this attribute is optional.

description: This attribute contains a non-specific description for the model. It should contain information necessary to use this model in further applications, but not information that could be better defined in the application element, annotation, and the data dictionary section. This attribute should only contain human readable information.

modelVersion: This attribute contains information about the version of the model represented. Same or similar models may be constructed multiple times and it becomes important to use an identification to keep track of which model is being dealt with; this attribute provides that information.

Application: This element describes the software application that generated the model. Although the PMML models are created to be portable, different mechanisms may create different models from the same data set. It is of interest to the user from which application these models were generated.

name: The name of the application that generated the model.

version: The version of the application that generated this model.

Annotation: Document modification history is embedded here. Each annotation is free text and, like the description attribute in the head element, makes sense to the human eye only. Users can store their own remarks, for example

<Annotation>This is a churn model for 1999 customers who ..
  <Extension name="author">John Doe</Extension>
</Annotation>

Timestamp: This element allows a model creation timestamp, it is recommended that its format should follow the XML standard described at http://www.w3.org/TR/xmlschema-2/#dateTime.

e-mail info at dmg.org