Metadata-Version: 2.1
Name: explainability-challenges
Version: 0.0.1
Summary: A package implementing dataset alterations to test explainability methods for machine learning.
Author-email: Anna Cai <annacai@cs.cmu.edu>, Jacob Rast <jrast@cmu.edu>, Abhishek Vijayakumar <abhishev@cs.cmu.edu>
Project-URL: Homepage, https://github.com/inkyubeytor/explainability-challenges
Project-URL: Bug Tracker, https://github.com/inkyubeytor/explainability-challenges/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

# explainability-challenges

## Testing

The test suite is executable via the `pytest` package.
First, install `pytest` with 
```bash
pip install pytest
```
Then, install the package locally for development purposes by running
```bash
pip install -e .
```
in the root directory of the project.
Finally, run the test suite with
```bash
pytest
```
To run only fast tests, run
```bash
pytest -m "not slow"
```

## OS-Specific Issue

For Windows devices, if the script hangs due to `kaleido`, run
```bash
pip uninstall kaleido
pip install kaleido==0.1.0.post1
```
