Skip to content

Commit

Permalink
Prep for release
Browse files Browse the repository at this point in the history
  • Loading branch information
kwinkunks committed Apr 21, 2024
1 parent e20da54 commit 43a8ce9
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Changelog


## 0.4.3, coming April 2024
## 0.5.0, 21 April 2024

- This is a minor release making more changes to the tests and documentation in reponse to the review process for [the submission](https://joss.theoj.org/papers/e1ca575ec0c5344144f87176539ef547) to JOSS (see below).
- This release makes more changes to the tests and documentation in reponse to the review process for [the submission](https://joss.theoj.org/papers/e1ca575ec0c5344144f87176539ef547) to JOSS (see below).
- In particular, see the following issue: [#97](https://github.com/scienxlab/redflag/issues/97)
- Changed the method of handling dynamic versioning. For now the package `__version__` attribute is still defined, but it is deprecated and will be removed in `0.5.0`. Use `from importlib.metadata.version('redflag')` to get the version information instead.
- Changed the method of handling dynamic versioning. For now the package `__version__` attribute is still defined, but it is deprecated and will be removed in `0.6.0`. Use `from importlib.metadata.version('redflag')` to get the version information instead.
- Changed the default `get_outliers()` method from isolation forest (`'iso'`) to Mahalanobis (`'mah'`) to match other functions, eg `has_outliers()` and the `sklearn` pipeline object.
- Updated `actions/setup-python` to use v5.


## 0.4.2, 10 December 2023
Expand Down
2 changes: 1 addition & 1 deletion src/redflag/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# information from the package metadata directly, eg by using
# importlib.metadata.version (see below).
#
# This will be deprecated in v0.5.0 but for now we do this:
# This will be deprecated in v0.6.0 but for now we do this:
#
from importlib.metadata import version
__version__ = version(__package__ or __name__)
2 changes: 1 addition & 1 deletion src/redflag/outliers.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ def mahalanobis_outliers(X: ArrayLike,


def get_outliers(a: ArrayLike,
method: Optional[str]=None, # Can change to 'mah' in 0.5.0.
method: Optional[str]=None, # Can change to 'mah' in 0.6.0.
p: float=0.99,
threshold: Optional[float]=None,
) -> np.ndarray:
Expand Down

0 comments on commit 43a8ce9

Please sign in to comment.