> [!WARNING]
> This is a breaking refactor. It significantly changes the API of some functions and deprecates others.
Breaking changes
- All metrics (COD, PRD, etc.) now have the same inputs (`estimate`, `sale_price`) and return the same output (a single `float`). Previously, some metrics had one input (COD) or different outputs (PRD)
- The sub-functions of `detect_chasing` and `is_outlier` are no longer exported to the user. Instead they can be selected via an argument in their respective functions
- `detect_chasing` is renamed to `is_sales_chased` for consistency with `is_outlier`
- Sample datasets are renamed to reflect their respective sources
Other changes
- Removed as much `numpy` as possible for compatibility with Spark/Athena
- Added static types to almost everything, which should make this package easier to maintain in the long run
- Replaced all unit tests with a fixtures matrix and parameters
- Updated a lot of the documentation structure
- Updated the example ratio study notebook