Skip to content

Commit 22f47a8

Browse files
committed
Merge branch 'main' into feature/multiclass_confusion_matrix
# Conflicts: # docs/tutorials/performance_estimation/multiclass_performance_estimation.rst
2 parents 287e49a + dd20ef7 commit 22f47a8

File tree

58 files changed

+12621
-156
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+12621
-156
lines changed

.bumpversion.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 0.9.0
2+
current_version = 0.9.1
33
commit = True
44
tag = True
55

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,4 @@ repos:
3838
- types-python-dateutil
3939
- types-click
4040
- sqlmodel
41+
- types-requests

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [0.9.1] - 2023-07-12
8+
9+
### Changed
10+
11+
- Updated Mendable client library version to deal with styling overrides in the RTD documentation theme
12+
- Removed superfluous limits for confidence bands in the CBPE class (these are present in the metric classes instead)
13+
- Threshold value limiting behaviour (e.g. overriding a value and emitting a warning) will be triggered not only when
14+
the value crosses the threshold but also when it is equal to the threshold value. This is because we interpret the
15+
threshold as a theoretical maximum.
16+
17+
### Added
18+
19+
- Added a new example notebook walking through a full use case using the NYC Green Taxi dataset, based on the blog of [@santiviquez](https://github.com/santiviquez)
20+
21+
### Fixed
22+
23+
- Fixed broken Docker container build due to changes in public Poetry installation procedure
24+
- Fixed broken image source link in the README, thanks [@NeoKish](https://github.com/NeoKish)!
25+
726
## [0.9.0] - 2023-06-26
827

928
### Changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ RUN apt-get update && \
3636
build-essential
3737

3838
# Install Poetry - respects $POETRY_VERSION & $POETRY_HOME
39-
RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py | python
39+
RUN curl -sSL https://install.python-poetry.org | python3 - --version $POETRY_VERSION
4040
ENV PATH="$POETRY_HOME/bin:$PATH"
4141

4242
# Import our project files

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,15 @@ Allowing you to have the following benefits:
7171
| 🔬 **[Technical reference]** | Monitor the performance of your ML models. |
7272
| 🔎 **[Blog]** | Thoughts on post-deployment data science from the NannyML team. |
7373
| 📬 **[Newsletter]** | All things post-deployment data science. Subscribe to see the latest papers and blogs. |
74-
| 💎 **[New in v0.9.0]** | New features, bug fixes. |
74+
| 💎 **[New in v0.9.1]** | New features, bug fixes. |
7575
| 🧑‍💻 **[Contribute]** | How to contribute to the NannyML project and codebase. |
7676
| <img src="https://raw.githubusercontent.com/NannyML/nannyml/main/media/slack.png" height='15'> **[Join slack]** | Need help with your specific use case? Say hi on slack! |
7777

7878
[nannyml 101]: https://nannyml.readthedocs.io/en/stable/
7979
[performance estimation]: https://nannyml.readthedocs.io/en/stable/how_it_works/performance_estimation.html
8080
[key concepts]: https://nannyml.readthedocs.io/en/stable/glossary.html
8181
[technical reference]: https://nannyml.readthedocs.io/en/stable/nannyml/modules.html
82-
[new in v0.9.0]: https://github.com/NannyML/nannyml/releases/latest/
82+
[new in v0.9.1]: https://github.com/NannyML/nannyml/releases/latest/
8383
[real world example]: https://nannyml.readthedocs.io/en/stable/examples/california_housing.html
8484
[blog]: https://www.nannyml.com/blog
8585
[newsletter]: https://mailchi.mp/022c62281d13/postdeploymentnewsletter
@@ -100,7 +100,7 @@ NannyML can also **track the realised performance** of your machine learning mod
100100

101101
To detect **multivariate feature drift** NannyML uses [PCA-based data reconstruction](https://nannyml.readthedocs.io/en/main/how_it_works/data_reconstruction.html). Changes in the resulting reconstruction error are monitored over time and data drift alerts are logged when the reconstruction error in a certain period exceeds a threshold. This threshold is calculated based on the reconstruction error observed in the reference period.
102102

103-
<p><img src="https://raw.githubusercontent.com/NannyML/nannyml/main/docs/_static/drift-guide-multivariate.svg"></p>
103+
<p><img src="https://raw.githubusercontent.com/NannyML/nannyml/main/docs/_static/butterfly-multivariate-drift.svg"></p>
104104

105105
NannyML utilises statistical tests to detect **univariate feature drift**. We have just added a bunch of new univariate tests including Jensen-Shannon Distance and L-Infinity Distance, check out the [comprehensive list](https://nannyml.readthedocs.io/en/stable/how_it_works/univariate_drift_detection.html#methods-for-continuous-features). The results of these tests are tracked over time, properly corrected to counteract multiplicity and overlayed on the temporal feature distributions. (It is also possible to visualise the test-statistics over time, to get a notion of the drift magnitude.)
106106

@@ -264,11 +264,11 @@ Curious what we are working on next? Have a look at our [roadmap](https://bit.ly
264264

265265
To cite NannyML in academic papers, please use the following BibTeX entry.
266266

267-
### Version 0.9.0
267+
### Version 0.9.1
268268

269269
```
270270
@misc{nannyml,
271-
title = {{N}anny{ML} (release 0.9.0)},
271+
title = {{N}anny{ML} (release 0.9.1)},
272272
howpublished = {\url{https://github.com/NannyML/nannyml}},
273273
month = mar,
274274
year = 2023,

docs/_static/example_green_taxi_all_udc.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/_static/example_green_taxi_dle.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/_static/example_green_taxi_dle_vs_realized.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)