src/pmml/doc/doxygen/doxfiles/intro.dox

   1 /*!
   2
   3 \mainpage Introduction
   4
   5 The Predictive Model Markup Language (PMML) is an XML-based file format developed by the Data Mining Group to provide a way for applications to describe and exchange models produced by data mining and machine learning algorithms.
   6
   7 The Salome PMML module allows the handling of PMML files :
   8 - reading of PMML files containing one or more models,
   9 - creation of PMML files with  one or more models,
  10 - supports models of types « NeuralNetwork » and « rRegressionModel »,
  11 - generation of  C++, FORTRAN and Python code from a model specifications.
  12
  13
  14 Furthermore, it is possible to load a model from a PMML file and generate the matching python function through YACS elementary node PyLoadPMML, indicating the PMML file, model name and type. The output port is the python function.
  15
  16
  17 <br />
  18
  19 \section contents Contents
  20 This document is organized as follows:
  21 - Technical presentation of \ref PMMLlib
  22 - \ref cppexamples
  23 - \ref pyexamples
  24
  25
  26 \section install Installation
  27 The install procedure of the %PMMLlib SALOME module can handle a variety of configurations
  28 to suit the needs of its user. Instructions for configuring and
  29 installing the module can be found in \ref pmml_install.
  30
  31
  32 \section references References
  33 Here follows a list of useful references :
  34
  35 -# Data Mining Group reference page : \c http://www.dmg.org/v4-1/GeneralStructure.html
  36
  37 */