search

microsoft / responsible-ai-toolbox-mitigations

Python library for implementing Responsible AI mitigations.
https://responsible-ai-toolbox-mitigations.readthedocs.io/en/latest/
MIT License
57 stars 6 forks source link

No installation instructions #20

Closed morrissharp closed 2 years ago

morrissharp commented 2 years ago

I have noticed that there are no installation instructions in the main README.md as well as the documentation.

mrfmendonca commented 2 years ago

Currently the installation is done using "pip install -e .", but this will change when the library is officially released. When we add an official version in PyPi, the installation will be done using "pip install raimitigations". However, I think it's important to leave the instructions of how to install it even though the official version is not out yet. We can then change this pretty easily. Thanks for pointing this out!

morrissharp commented 2 years ago

When it is officially released, I think it is fine to leave pip install -e . as a secondary option for installation. Here is an example of a library I was just looking at that has this: https://github.com/py-why/dowhy#id7

mrfmendonca commented 2 years ago

Nice! It's good to have these examples. Then I'll leave the pip install -e . even after the official package is released.