optbinning-slim 0.22.0__tar.gz

optbinning_slim-0.22.0/CHANGELOG.md

@@ -0,0 +1,108 @@
+# Changelog
+
+Release notes for `optbinning-slim`, a maintenance fork of
+[optbinning](https://github.com/guillermo-navas-palencia/optbinning). Versions
+before 0.22.0 are upstream's; their notes are in the
+[upstream documentation](http://gnpalencia.org/optbinning/release_notes.html).
+
+The fork adds no algorithms. Everything below is packaging, currency with the
+Python and dependency stack, defect fixes and test coverage.
+
+## 0.22.0 (2026-08-23)
+
+First release of the fork, branched at upstream 0.21.0.
+
+### Requirements
+
+- **Python >= 3.13.** Tested on 3.13 and 3.14; both are in CI and in the trove
+  classifiers. Upstream 0.21.0 declared `>=3.7` and tested up to 3.12.
+- **Dependency floors raised**, and the `ortools` upper cap **dropped**:
+  `matplotlib>=3.10`, `numpy>=2.3`, `ortools>=9.14` (was `>=9.4,<9.12`),
+  `pandas>=2.3`, `ropwr>=1.2`, `scikit-learn>=1.7`, `scipy>=1.15`. The cap was
+  not protecting against anything the suite can reach: on OR-Tools 9.15 every
+  solver status, split and IV is unchanged.
+
+### Packaging
+
+- `setup.py`, `requirements.txt` and `test_requirements.txt` replaced by a
+  single PEP 621 `pyproject.toml`. `environment.yml` builds the conda
+  environment and restates no dependency.
+- The distribution is named **`optbinning-slim`**; the import package stays
+  `optbinning`, so it is a drop-in replacement. The two distributions claim the
+  same import package and must not share an environment.
+- Upstream's Sphinx sources (`doc/`) and the unused Travis configuration were
+  removed. Docstrings remain the user-facing documentation; upstream's rendered
+  documentation still describes the library.
+
+### Removed
+
+- **`solver="ls"` and the LocalSolver integration.** `localsolver` is not
+  distributed on PyPI and the `hexaly` package that succeeds it provides no
+  `localsolver` module, so the option could not be used by anyone installing
+  this package. `OptimalBinning` now accepts `("cp", "mip")`, matching every
+  other estimator.
+
+### Added
+
+- `OptimalPWBinning` and `ContinuousOptimalPWBinning` accept
+  **`solver="clarabel"`**. `ropwr` 1.2 resolves `solver="auto"` to Clarabel on
+  constrained problems, and the estimators previously rejected the solver they
+  were themselves using.
+- `OptimalBinningSketch.plot_progress` takes **`savefig`** and `save_kwargs`,
+  like every other plot method. It previously always called `plt.show()`, which
+  blocks on an interactive backend.
+- `PWContinuousBinningTable.quality_score`, which `analysis()` computed but did
+  not publish, unlike the three sibling binning tables.
+
+### Fixed
+
+- **pandas 3.0 support.** A variable whose column carries pandas' string dtype
+  was classified as numerical and its strings reached `check_array`, raising
+  `could not convert string to float`. `BinningProcess` now tests
+  `is_numeric_dtype` directly. As a consequence a categorical column is binned
+  as categorical, where it was previously treated as numerical.
+- **`read_json` produced an unusable estimator.** It rebuilt the binning table
+  but restored none of the state `transform` and `splits` read, so a loaded
+  estimator returned `None` from `.splits` and raised `TypeError` from
+  `.transform`. Affected `OptimalBinning`, `ContinuousOptimalBinning` and
+  `MulticlassOptimalBinning`.
+- **`to_json` could not write a categorical binning at all** (`Object of type
+  ... is not JSON serializable`), and the payload could not represent one: it
+  saved the grouped categories rather than the split positions needed to
+  rebuild them. Both are fixed, and the payload gained `splits_optimal`. Files
+  written by earlier versions raise a `ValueError` naming the problem rather
+  than loading a broken estimator.
+- **MDLP applied its stopping criterion to the recursion only**, so every node
+  with a viable candidate contributed a split and `min_samples_split` could not
+  prevent the first one. The Fayyad-Irani criterion now decides whether the
+  split is accepted. **This changes results**: on breast-cancer "mean radius"
+  the default fit goes from 7 splits to 3, and
+  `OptimalBinning(prebinning_method="mdlp")` from IV 4.79132740 to 4.76862756.
+  A target carrying no information now yields no splits.
+- **MDLP rejected an integral float target** with a numpy cast error that did
+  not mention the target. It is now accepted; non-integral or negative labels
+  raise a `ValueError` that names it.
+- `ContinuousOptimalBinning2D` accepted `prebinning_method="mdlp"` and failed
+  during `fit`; it is now rejected by parameter validation, like the 1D
+  estimator.
+- `OptimalBinningSketch`'s docstring advertised `solver="ls"`, which its own
+  validation rejected.
+
+### Testing
+
+- 176 tests to **212**, and coverage from 85% to **89%**. The suite passes on
+  Python 3.13 and 3.14.
+- `MDLP`'s only two algorithmic tests were commented out upstream, leaving the
+  recursion, split search and stopping criterion uncovered; they are replaced
+  by property-based tests. JSON persistence had no tests at all.
+- `tests/test_package.py` pins that ortools still solves after
+  `import optbinning`. ortools and highspy ship colliding `libhighs.so.1`
+  libraries, so the import order in `optbinning/__init__.py` is load-bearing —
+  see `reports/OPEN_ITEMS.md`.
+
+### Known issues
+
+- cvxpy's HIGHS backend is unavailable in any process that imports optbinning,
+  because ortools and highspy ship different HiGHS builds under the same
+  SONAME. optbinning's own `solver="highs"` is unaffected. Full diagnosis in
+  `reports/OPEN_ITEMS.md`.

optbinning_slim-0.22.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

optbinning_slim-0.22.0/MANIFEST.in

@@ -0,0 +1,11 @@
+# LICENSE, README.md and pyproject.toml are included by setuptools already.
+include CHANGELOG.md
+# The test suite and its fixtures ship in the sdist so a downstream packager can
+# run pytest against the released tarball; the artifacts tests write do not.
+recursive-include tests *.py
+recursive-include tests/data *
+recursive-include assets *
+prune tests/results
+prune .github
+prune .idea
+prune reports