From 8221e0fd1fcd7cbef956a9fc84e9910485e57fb7 Mon Sep 17 00:00:00 2001
From: Villu Ruusmann <villu.ruusmann@gmail.com>
Date: Fri, 15 Mar 2024 10:46:47 +0200
Subject: [PATCH] Updated documentation

---
 NEWS.md   | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 README.md |  6 +++---
 2 files changed, 54 insertions(+), 6 deletions(-)

diff --git a/NEWS.md b/NEWS.md
index 5ccd9dd..934e229 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,8 +1,56 @@
+# 0.104.1 #
+
+## Breaking changes
+
+* Removed `sklearn2pmml.ensemble.OrdinalClassifier` class.
+
+The uses of this class should be replaced with the uses of the `sklego.meta.OrdinalClassifier` class (see below), which implements exactly the same algorithm, and offers extra functionality such as calibration and parallelized fitting.
+
+## New features
+
+* Added support for `sklego.meta.OrdinalClassifier` class.
+
+``` python
+from pandas import CategoricalDtype, Series
+
+# A proper ordinal target
+y_bin = Series(_bin(y), dtype = CategoricalDtype(categories = [...], ordered = True), name = "bin(y)")
+
+classifier = OrdinalClassifier(LogisticRegression(), use_calibration = True, ...)
+# Map categories from objects to integer codes
+classifier.fit(X, (y_bin.cat).codes.values)
+
+# Store the categories mapping:
+# the `OrdinalClassifier.classes_` attribute holds integer codes, 
+# and the `OrdinalClassifier.pmml_classes_` holds the corresponding objects
+classifier.pmml_classes_ = y_bin.dtype.categories
+```
+
+See [Scikit-Lego-607](https://github.com/koaning/scikit-lego/issues/607)
+
+## Minor improvements and fixes
+
+* Removed the SkLearn-Pandas package from installation requirements.
+
+The `sklearn_pandas.DataFrameMapper` meta-transformer is giving way to the `sklearn.compose.ColumnTransformer` meta-transformer in most common pipelines.
+
+* Fixed the base-N encoding of missing values.
+
+This bug manifested itself when missing values were assigned to a category by itself.
+
+This bug was discovered when rebuilding integration tests with Category-Encoders 2.6(.3).
+It is currently unclear if the base-N encoding algorithm had its behaviour changed between Category-Encoders 2.5 and 2.6 development lines.
+
+In any case, when using SkLearn2PMML 0.104.1 or newer, it is advisable to upgrade to Category-Encoders 2.6.0 or newer.
+
+* Ensured compatibility with Category-Encoders 2.6.3, Imbalanced-Learn 0.12.0, OptBinning 0.19.0 and Scikit-Lego 0.7.4.
+
+
 # 0.104.0 #
 
 ## Breaking changes
 
-* Updated Scikit-Learn version requirement from `0.18+` to `1.0+`.
+* Updated Scikit-Learn installation requirement from `0.18+` to `1.0+`.
 
 This change helps the SkLearn2PMML package to better cope with breaking changes in Scikit-Learn APIs.
 The underlying [JPMML-SkLearn](https://github.com/jpmml/jpmml-sklear) library retains the maximum version coverage, because it is dealing with Scikit-Learn serialized state (Pickle/Joblib or Dill), which is considerably more stable.
@@ -11,10 +59,10 @@ The underlying [JPMML-SkLearn](https://github.com/jpmml/jpmml-sklear) library re
 
 * Added support for Scikit-Learn 1.4.X.
 
-The JPMML-SkLearn library had its integration tests rebuilt with Scikit-Learn `1.4.0` and `1.4.1.post1` versions.
+The JPMML-SkLearn library integration tests were rebuilt with Scikit-Learn `1.4.0` and `1.4.1.post1` versions.
 All supported transformers and estimators passed cleanly.
 
-See [SkLearn2PMML-409](https://github.com/jpmml/sklearn2pmml/issues/409) and [JPMML-SkLearn-195](https://github.com/jpmml/jpmml-sklearn/issues/195).
+See [SkLearn2PMML-409](https://github.com/jpmml/sklearn2pmml/issues/409) and [JPMML-SkLearn-195](https://github.com/jpmml/jpmml-sklearn/issues/195)
 
 * Added support for `BaseHistGradientBoosting._preprocessor` attribute.
 
diff --git a/README.md b/README.md
index 254906f..869a301 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.104.0** (10 March, 2024):
+The current version is **0.104.1** (14 March, 2024):
 
 ```
-pip install sklearn2pmml==0.104.0
+pip install sklearn2pmml==0.104.1
 ```
 
-See the [NEWS.md](https://github.com/jpmml/sklearn2pmml/blob/master/NEWS.md#01040) file.
+See the [NEWS.md](https://github.com/jpmml/sklearn2pmml/blob/master/NEWS.md#01041) file.
 
 # Prerequisites #