Add a changelog

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [Unreleased]
+
+### Added
+
+- Added `n_points` parameter to all functions in `shap.datasets` (#39).
+- Added the ruff linter (#25, #26, #27).
+
+### Fixed
+
+- Fixed installation of package via setuptools (#51).
+- Fixed failing unit tests (#29).
+- Fixed deprecation warnings from `numpy` types (#7).
+- Fixed deprecation warnings from `Ipython.core.display` (#13).
+- Fixed deprecation warnings from `tensorflow` optimisers (#16).
+- Fixed deprecation warnings from `sklearn.linear_model` (#22).
+- Fixed `plot.waterfall` yticklabels with boolean features (#58).
+
+### Changed
+
+- `shap.datasets` sampling changed to without replacement (#36).
+
+### Removed
+
+- Deprecated the Boston house price dataset (#38).
+- Removed the unused `mimic.py` file (#53).
+
+## [0.41.0] - 2022-06-16 (parent repo)
+
+For details of previous changes, see the release page of the parent repository
+[here](https://github.com/slundberg/shap/releases).

README.md

@@ -2,7 +2,13 @@
 
 This repository is a fork of Scott Lundberg's popular [shap](https://github.com/slundberg/shap) library. Unfortunately, the original shap repo is not currently maintained. This fork attempts to fix shap's current issues and merge old PRs. See the general discussion on the purpose of this repo [here](https://github.com/dsgibbons/shap/discussions/11).
 
-**New contributors are very welcome**, so please feel free to get involved!
+## What has changed on this fork?
+
+This fork primarily adds bug fixes and deprecation updates, to ensure that `shap` works with the latest versions of other libaries. Check out the [changelog](CHANGELOG.md) for full details of updates.
+
+## Contributing
+
+**New contributors are very welcome** so please feel free to get involved, for example by submitting PRs or opening issues!
 
 We are eager to build a broad pool of maintainers, to avoid having a single person responsible for the entire repostitory. This repo adopts a _liberal contribution governance model_, where project decisions are based on a consensus seeking process. For more information, see [here](https://medium.com/the-node-js-collection/healthy-open-source-967fa8be7951).