Changelog for v0.0.5 and Readme fix for pip install of HyperSHAP

Author: mwever

CHANGELOG.md

@@ -1,3 +1,16 @@
+# v0.0.5
+
+## Features
+- Added seed parameter for controlled pseudo-randomization
+- Dealing with conditions on hyperparameters of configuration spaces
+
+## Improvements
+- Bumped shapiq dependency to most recent version (v1.4.1)
+- Automatically configure approximator with the help of shapiq's helper function.
+
+## Documentation
+- Added installation instructions to README.md for pip install.
+
 # v0.0.4
 - Added pseudorandomization
 - Added index-specific approximation

README.md

@@ -35,7 +35,21 @@ HyperSHAP – a game‑theoretic Python library for explaining Hyperparameter Op
 
 ## Installation
 
+First, create a virtual environment, e.g., via `conda`:
 ```sh
+$ conda create -n hypershap python=3.10
+$ conda activate hypershap
+```
+
+Now, you can just pip install HyperSHAP as follows:
+```sh
+$ pip install hypershap
+```
+
+Or, clone the git repository and install hypershap via the Makefile:
+```sh
+$ git clone https://github.com/automl/hypershap
+$ cd hypershap
 $ make install
 ```
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hypershap"
-version = "0.0.4"
+version = "0.0.5"
 description = "HyperSHAP is a post-hoc explanation method for hyperparameter optimization."
 authors = [{ name = "Marcel Wever", email = "[email protected]" }]
 readme = "README.md"