Skip to content

Commit ce677ea

Browse files
WIP Update to 0.2
1 parent b05aecc commit ce677ea

5 files changed

Lines changed: 23 additions & 18 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# Changelog
22

3+
## [0.2] - 2025-12-26
4+
5+
### Changed
6+
- Update Khiops dependency to version 11.
7+
38
## [0.1] - 2025-10-17
9+
410
### Added
511
- `KhalibClassifier` class
612
- `calibration_error` function
713
- `build_reliability_diagram` function
814

9-
[Unreleased]: https://github.com/yourusername/yourproject/compare/0.1...HEAD
10-
[1.0.0]: https://github.com/yourusername/yourproject/releases/tag/0.1
15+
[Unreleased]: https://github.com/yourusername/yourproject/compare/0.2...HEAD
16+
[0.2]: https://github.com/yourusername/yourproject/compare/0.1...0.2
17+
[0.1]: https://github.com/yourusername/yourproject/releases/tag/0.1

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@ suite.
66

77
## Features
88
- `KhalibClassifier`: A scikit-learn estimator to calibrate classifiers with a similar interface
9-
fashion as [CalibratedClassifierCV][sk-calclf].
9+
as [CalibratedClassifierCV][sk-calclf].
1010
- `calibration_error` : A function to estimate the Estimated Calibration Error (ECE).
11-
- `build_reliability_diagram` : A function that builds a reliability diagram.
11+
- `build_reliability_diagram` : A function to build a reliability diagram.
1212

1313
These features are based on Khiops's non-parametric supervised histograms, so there is no need to
1414
specify the number and width of the bins, as they are automatically estimated from data.
1515

16+
[khiops-org]: https://khiops.org
17+
[sk-calclf]: https://scikit-learn.org/stable/modules/generated/sklearn.calibration.CalibratedClassifierCV.html
18+
1619
<!-- end-summary -->
1720

1821
See the [documentation][khalib-docs] for more information.
@@ -23,9 +26,10 @@ See the [documentation][khalib-docs] for more information.
2326
- [Install Khiops][khiops-setup]
2427
- Install the `khalib` python library:
2528

26-
```bash
27-
pip install https://github.com/KhiopsLab/khalib/archive/refs/tags/0.1.zip
29+
```sh
30+
pip install khalib
2831
```
32+
[khiops-setup]: https://khiops.org/setup/
2933

3034
<!-- end-install -->
3135

@@ -35,8 +39,4 @@ pip install https://github.com/KhiopsLab/khalib/archive/refs/tags/0.1.zip
3539
See https://khiopslab.github.io/khalib/
3640

3741

38-
[khiops-org]: https://khiops.org
39-
[khiops11-setup]: https://khiops.org/11.0.0-b.0/setup/
40-
[sk-calclf]: https://scikit-learn.org/stable/modules/generated/sklearn.calibration.CalibratedClassifierCV.html
4142
[khalib-docs]: https://khiopslab.github.io/khalib
42-

docs/index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,14 @@
1111
## How does it work
1212

1313
`khalib` proposes histogram-based calibration and its error estimation. Its differentiating factor
14-
is that uses [Khiops][khiops-org] to construct the histogram in which {math}`P(Y = 1 | S)` is
15-
estimated. These histograms have the following properties:
14+
is that uses Khiops to construct the histogram in which {math}`P(Y = 1 | S)` is estimated. These
15+
histograms have the following properties:
1616
- They balance class purity, model complexity and data fitness.
1717
- They are non-parametric: The optimal histogram is searched without constraint in number of bins or
1818
bin width. This implies that the user doesn't need to set a number of bins nor their widths.
1919

2020

21-
[khiops-org]: https://khiops.org
22-
[khiops-setup]: https://khiops.org/setup/
23-
[sk-calclf]: https://scikit-learn.org/stable/modules/generated/sklearn.calibration.CalibratedClassifierCV.html
24-
[khalib-docs]: https://khiopsml.github.io/khalib
21+
<!--[khiops-org]: https://khiops.org-->
2522

2623

2724
See the [Quickstart](quickstart) and [API reference](api) to learn how to use the library.
@@ -40,5 +37,6 @@ API Reference <api>
4037
:hidden:
4138
4239
Khiops <https://www.khiops.org>
40+
Github <https://github.com/KhiopsLab/khalib>
4341
```
4442

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "khalib"
7-
version = "0.2rc2"
7+
version = "0.2"
88
description = "Classifier Calibration with Khiops"
99
authors = [{ name = "Felipe Olmos", email = "luisfelipe.olmosmarchant@orange.com" }]
1010
requires-python = ">=3.11"

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)