Release Notes Model Exporter Version 3 5: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Donal
(Created page with "__TOC__ ==Introduction== Model_Exporter converts models created within the PLS_Toolbox or Solo chemometrics modeling environments into an interpre...")
 
imported>Donal
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__TOC__
Version 3.5 of Model_Exporter was released in June, 2018. For general product information, see [[Model_Exporter_User_Guide]].
==Introduction==


[[Model_Exporter]] converts models created within the [[Software_User_Guide|PLS_Toolbox or Solo]] chemometrics modeling environments into an interpretable format for use outside of these products. These exported models can be used with the included C# or Java interpreters or with a user-supplied interpreter to make predictions on new data.
==NEW FEATURES / FIXES==


Model_Exporter takes as input a standard model structure created in PLS_Toolbox or Solo and outputs the model into one of three formats: an [[#XML_File_Format|XML file]] (executable by a user-supplied external parser or the Java or C# [[Model _Exporter Interpreter]] class provided with Model_Exporter), an [[#M-file_Format|m-file]] (executable in MATLAB – separately distributed by Mathworks, Inc – without any additional toolboxes, or LabView with their MathScript addon package) or a [[#TCL_File_Format|TCL file]] (executable in a Tcl interpreter or in the Symbion software package – by Symbion Systems, Inc.).
===Model Exporter===


The exported model requires very few resources to be executed. Specifically, it requires floating-point numerical calculations, a small amount of memory, and the overhead resources required by the specific interpreter.
Add support for:
* Model export of Model-Centric Calibration Transfer (MCCT) transformed models
* Model export to Python language


This documentation describes the use of the Model_Exporter, the use of exported [[#M-file_Format|M-file]] and [[#TCL_File_Format|TCL-file]] formats as well as to help in the design of external [[#XML_File_Format|XML parsing engines]]. Model_Exporter includes a freely-distributable interpreter class with versions in C# and Java as described on the [[Model_Exporter Interpreter]] page. In addition, an example interpreter engine is supplied for the PHP language (often used for web-page scripting predictions; see http://www.php.net for more information on PHP). Additional engines may be available - [mailto:helpdesk@eigenvector.com Contact Eigenvector Research, Inc.] for more information.
Added:
* Examples of exported models for all model types and to Matlab, Python and XML
* Usage example code for exported models


Latest version release notes can be found at http://wiki.eigenvector.com/index.php?title=Model_Exporter_Release_Notes
===Model Interpreter===


==System Requirements==
* Added TestJava class showing use of exported XML in Java, for PLS and PLSDA examples
 
Model_Exporter can be executed from either the MATLAB computational environment ([http://mathworks.com Mathworks, Inc., Natick, MA]), or  [[Software User Guide|Solo]] (Eigenvector Research, Inc., Wenatchee, WA). Model_Exporter converts models created by PLS_Toolbox 3.5 or higher or Solo 4.0 or higher.
 
===Matlab-Based Exporter Requirements===
 
For execution of Model_Exporter within the MATLAB environment, the following is required:
 
:Compatible with any version of Matlab released within five years of this product's release.  For example, Model exporter 3.3.0 released in 2016, is guaranteed to be compatible with any version of Matlab released within 5 years of the 2016 release data, so in this case Matlab 2011 would be the oldest version of Matlab that we fully guarantee compatibility. 
:256 MB RAM (recommended – less may be required)
 
===Solo-Based Exporter Requirements===
 
For execution of the Model_Exporter, the following is recommended
 
:Solo+Model_Exporter 4.1 or higher
:Operating system requirements as listed for the specified Solo version
:200 MB Disk Space (for installation; some models may require additional space)
:256 MB RAM (recommended – less may be required)
 
===Requirements for Using Exported Models===
 
The requirements to execute an exported model vary depending on the interpreter used, the number of variables in the modeled data, and the complexity of the model (i.e. the number of factors/components included in the model and the types of preprocessing used).
 
Memory requirements depend on the precision required for the application, the number of variables in the data and the total number of factors in the model. For example, a model working on 10,000 variables and 5 factors would require around 1MB for double-precision calculations and 500KB single-precision calculations.
 
The software which executes the specific file formats may have additional requirements. See the file format description sections later in this manual for where to locate model execution details.

Latest revision as of 21:40, 11 June 2018

Version 3.5 of Model_Exporter was released in June, 2018. For general product information, see Model_Exporter_User_Guide.

NEW FEATURES / FIXES

Model Exporter

Add support for:

  • Model export of Model-Centric Calibration Transfer (MCCT) transformed models
  • Model export to Python language

Added:

  • Examples of exported models for all model types and to Matlab, Python and XML
  • Usage example code for exported models

Model Interpreter

  • Added TestJava class showing use of exported XML in Java, for PLS and PLSDA examples
Retrieved from "https://www.wiki.eigenvector.com/index.php?title=Release_Notes_Model_Exporter_Version_3_5&oldid=9835"