Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Note: We try to adhere to these practices as of version v1.1.1.
Version v1.1.5 - 2024-04-30
Added
- Unit tests: adds a simple performance benchmark to test that for a small problem, generating a counterfactual using the generic generator takes at most 4700 allocations. Only run on julia
v1.10
and higher. #436
Changed
- The
find_potential_neighbours
is now only triggered if one of the penalties of the generator requires access to samples from the target domain. This improves scalability because calling the function can be computationally costly (forward-pass). #436 - The target variable encodings are now handled more efficiently. Previously certain tasks were repeated, which was not necessary. #436
Removed
- Removed the assertion checking that the model ever predicts the target value. While this assertion is useful, it is not essential. For large enough models and datasets, this forward pass can be very costly. #436
- Removed redundant
distance_from_targets
function. #436
Version v1.1.4 - 2024-04-25
Changed
- Refactors the encodings and decodings such that it is now more streamlined. Instead of conditional statements, encodings are now dispatched on the type of a new unifying
data.input_encoder
field. #432 - Refactors the check for redundancy. This is now based on the convergence type and done right before the counterfactual search begins, if not redundant. #432
Added
- Added additional unit tests. #437
Version v1.1.3 - 2024-04-17
Added
- Adds a section on
Convergence
to the documentation,Changelog.jl
functionality and a few doc tests. #429
Changed
- Changes style of taking gradients for the counterfactual search from implicit to explicit. #430
- Removed all implicit imports. #430
Removed
- Removed CUDA.jl dependency, because redundant. #430
- Removed Parameters.jl dependency, because redundant. #430
Version v1.1.2 - 2024-04-16
Changed
- Replaces the GIF in the README and introduction of docs for a static image.
Version v1.1.1 - 2024-04-15
Added
- Added tests for LaplaceRedux extension. Bumped upper compat bound for LaplaceRedux.jl. #428