.. _PHZMachineLearningModel:

Machine Learning Model Product
===============================

$SetSchemaPath phz/euc-test-phz-MachineLearningModel.xsd

Data Product Name
__________________
.. DataProductNameStart

$PrintDataProductName

.. DataProductNameEnd

Data Product Custodian
_______________________
.. DataProductCustodianStart

$PrintDataProductCustodian

.. DataProductCustodianEnd

Name of the Schema File
________________________
.. NameSchemaStart

$PrintSchemaFilename

.. NameSchemaEnd

Data Product Elements
______________________
.. DataProductElementsStart

$PrintDataProductElements

.. DataProductElementsEnd

Schema documentation tag
_________________________
.. SchemaDocTagStart

:emphasis:`Documentation for data product element dpdMachineLearningModel:`

Represents the model used by the machine learning PHZ component to compute the
PDZs. This file is produced outside the pipeline using the Primal software and
it follows an internal binary format.

:emphasis:`Documentation for data product element Header:`

The generic header of the product.

.. SchemaDocTagEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

This product is a binary file containing the machine learning model to be used
by the PHZ PF for producing the PHZ PDF. The format of the file is the one
defined by the *Primal* component of the PHZ PF.

Processing Element(s) creating/using the data product
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. PECreatorStart

* This data product is produced outside the Euclid pipeline using the Primal tool
and is manually ingested in the EAS.
* It is used as input of the machine learning
component of the PHZ PF.

.. PECreatorEnd

Processing function using the data product
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. PFUsingStart

* This product is used as input of the PHZ PF.

.. PFUsingEnd

.. DetailedDescEnd