This package is a tool that validates and calibrates supervised classification models against bias. We hope to empower users to audit models and develop diagnostic plots that help identify and quantify bias in supervised ML models.
- Explore KiTE's User-friendly Interface!
- Please refer to our documentation for additional guidance
Type this into your Python environment!
pip install git+https://github.com/A-Good-System-for-Smart-Cities/KiTE-utils.git
Please submit any feedback, questions, or issues in the Issues Tab of this Repository. One of our team members will promptly respond to help you out!
- To format code, run
black .
- To lint code, run
flake8 .
- To install requirements, run
pip install -r requirements.txt
- To run tests, run
pytest -s KiTE
- Fork this Repo
- Clone the Repo onto your computer -- You may need to setup an SSH Key on your device.
- Run
pip install -r requirements.txt
to get all the packages you need.
- Create a branch (
git checkout -b new-feature
) - Make Changes
- Run necessary quality assurance tools
- Add your changes (
git commit -am "Commit Message"
orgit add <whatever files/folders you want to add>
followed bygit commit -m "Commit Message"
) - Push your changes to the repo (
git push origin new-feature
) - Create a pull request
You can locally build the package with pip install -e .
and run unit tests with pytest -s KiTE
.
black formatter automatically formats code
- Run
pip install black
to get the package. - After making changes, run
black ./
.
flake8 lints code
Notifies you if any code is not currently up to Python standards.
- Run
pip install flake8
to get the package. - After making changes, run
flake8
.
pytest runs unit tests
- Run
pip install pytest
to get the package. - After making changes, you can run
pytest -s KiTE
to run all unit tests
We use pdoc to create KiTE's documentation.
pip install pdoc
into your working environment- Preview edits with
pdoc -t doc_template --docformat numpy KiTE
.- This will locally host the documentation site (that will update as you make edits)
- Edit documentation by adding/modifying docstrings in
KiTE