From 3ab1489f7cd421cd57652c4f83743f4ed9ba211e Mon Sep 17 00:00:00 2001 From: Villu Ruusmann Date: Mon, 5 Aug 2024 21:03:35 +0300 Subject: [PATCH] Updated documentation --- NEWS.md | 34 ++++++++++++++++++++++++++++++++++ README.md | 6 +++--- 2 files changed, 37 insertions(+), 3 deletions(-) diff --git a/NEWS.md b/NEWS.md index 534b985..7bbe4ec 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,37 @@ +# 0.110.0 # + +## Breaking changes + +None. + +## New features + +* Added `pmml_schema` parameter to the `sklearn2pmml.sklearn2pmml(estimator, pmml_path)` utility function. + +This parameter allows downgrading PMML schema version from the default 4.4 version to any 3.X or 4.X version. +However, the downgrade is "soft", meaning that it only succeeds if the in-memory PMML document is naturally compatible with the requested PMML schema version. +The downgrade fails if there are structural changes needed. + +Exprting a pipeline into a PMML schema version 4.3 document: + +``` python +from sklearn2pmml import sklearn2pmml + +pipeline = Pipeline([...]) +pipeline.fit(X, y) + +sklearn2pmml(pipeline, "Pipeline-v43.pmml", pmml_schema = "4.3") +``` + +See [SkLearn2PMML-423](https://github.com/jpmml/sklearn2pmml/issues/423#issuecomment-2264552688) + +Complex downgrades will be implemented based on customer needs. + +## Minor improvements and fixes + +None. + + # 0.109.0 # ## Breaking changes diff --git a/README.md b/README.md index ec2dec8..e9ceeb3 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.109.0** (19 June, 2024): +The current version is **0.110.0** (5 August, 2024): ``` -pip install sklearn2pmml==0.109.0 +pip install sklearn2pmml==0.110.0 ``` -See the [NEWS.md](https://github.com/jpmml/sklearn2pmml/blob/master/NEWS.md#01090) file. +See the [NEWS.md](https://github.com/jpmml/sklearn2pmml/blob/master/NEWS.md#01100) file. # Prerequisites #