From ae0498fc4fd45abb390bc870d8afe31b42343507 Mon Sep 17 00:00:00 2001 From: Villu Ruusmann Date: Sat, 14 Dec 2024 12:25:23 +0200 Subject: [PATCH] Updated documentation --- NEWS.md | 37 ++++++++++++++++++++++++++++++++++++- README.md | 6 +++--- 2 files changed, 39 insertions(+), 4 deletions(-) diff --git a/NEWS.md b/NEWS.md index d74e43b..1bc324f 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,38 @@ +# 0.112.1 # + +## Breaking changes + +None. + +## New features + +* Added support for in-place file conversion. + +If the `estimator` parameter to the `sklearn2pmml.sklearn2pmml(estimator, pmml_path)` utility function is a path-like object (eg. `pathlib.Path` or string), then the Pytho side of the SkLearn2PMML package shall pass it forward to the Java side (without making any efforts to load or modify anything about it). + +This opens the door for the safe conversion of legacy and/or potentially harmful Pickle files. + +For example, attempting to convert an unknown origin and composition estimator file to a PMML document: + +```python +from sklearn2pmml import sklearn2pmml + +sklearn2pmml("/path/to/estimator.pkl", "estimator.pmml") +``` + +## Minor improvements and fixes + +* Added `--version` command-line option. + +Checking the version of the currently installed command-line application: + +``` +sklearn2pmml --version +``` + +* Fixed the version standardization transformation. + + # 0.112.0 # ## Breaking changes @@ -6,7 +41,7 @@ This requirement stems from underlying package requirements, most notably that of the NumPy package (`numpy>=1.24`). -Portions of the SkLearn2PMML package may be usable with earlier Python versions. +Portions of the SkLearn2PMML package are still usable with earlier Python versions. For example, the `sklearn2pmml.sklearn2pmml(estimator, pmml_path)` utlity function should work with any Python 2.7, 3.4 or newer version. * Migrated setup from `distutils` to `setuptools`. diff --git a/README.md b/README.md index 8330986..be8da94 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ This package is a thin Python wrapper around the [JPMML-SkLearn](https://github. # News and Updates # -The current version is **0.112.0** (8 December, 2024): +The current version is **0.112.1** (14 December, 2024): ``` -pip install sklearn2pmml==0.112.0 +pip install sklearn2pmml==0.112.1 ``` -See the [NEWS.md](https://github.com/jpmml/sklearn2pmml/blob/master/NEWS.md#01120) file. +See the [NEWS.md](https://github.com/jpmml/sklearn2pmml/blob/master/NEWS.md#01121) file. # Prerequisites #