From a219696ed1090f5b89acc7e88454162c99d77ae5 Mon Sep 17 00:00:00 2001 From: Villu Ruusmann Date: Wed, 29 May 2024 09:32:07 +0300 Subject: [PATCH] Updated documentation --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8d82ded..04b4643 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Java library and command-line application for converting [StatsModels](https://w # Installation # Enter the project root directory and build using [Apache Maven](https://maven.apache.org/): + ``` mvn clean install ``` @@ -39,7 +40,7 @@ A typical workflow can be summarized as follows: 1. Use Python to fit a model. 2. Save the model fitting results in `pickle` data format to a file in a local filesystem. -3. Use the JPMML-StatsModels command-line converter application to turn the pickle file to a PMML file. +3. Use the JPMML-StatsModels command-line converter application to turn the Pickle file to a PMML file. ### The Python side of operations @@ -69,12 +70,14 @@ results.save("model.pkl", remove_data = True) ### The JPMML-StatsModels side of operations -Converting the model fitting results pickle file `model.pkl` to a PMML file `model.pmml`: +Converting the model fitting results Pickle file `model.pkl` to a PMML file `model.pmml`: + ``` java -jar pmml-statsmodels-example/target/pmml-statsmodels-example-executable-1.1-SNAPSHOT.jar --pkl-input model.pkl --pmml-output model.pmml ``` Getting help: + ``` java -jar pmml-statsmodels-example/target/pmml-statsmodels-example-executable-1.1-SNAPSHOT.jar --help ```