Metadata-Version: 2.4
Name: solas-ai
Version: 0.6.0
Summary: A Python Library of Curated Disparity Testing Metrics for Use in Real-World Settings
Project-URL: Homepage, https://solas.ai/
Project-URL: Documentation, https://github.com/SolasAI/solas-ai-disparity/
Project-URL: Repository, https://github.com/SolasAI/solas-ai-disparity/
Project-URL: Issues, https://github.com/SolasAI/solas-ai-disparity/issues
Author-email: SolasAI Team <support@solas.ai>
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: <3.13,>=3.8
Requires-Dist: dynaconf>=3.1.11
Requires-Dist: geopandas>=0.13.2
Requires-Dist: httpx
Requires-Dist: importlib-resources>=5.10.0
Requires-Dist: jinja2
Requires-Dist: kaleido
Requires-Dist: markdown>=3.3.7
Requires-Dist: nbformat>=5.4.0
Requires-Dist: numpy<3,>=1
Requires-Dist: pandas<3
Requires-Dist: plotly>=5.8.2
Requires-Dist: pyarrow>=8.0.0
Requires-Dist: pydantic<2.0
Requires-Dist: rich[jupyter]>=13.5.2
Requires-Dist: rtree!=1.4.1,>=1.0.0
Requires-Dist: scikit-learn>=1.0.2
Requires-Dist: scipy>=1.5.3
Requires-Dist: shapely>=2.0.0
Requires-Dist: statsmodels>=0.13.2
Requires-Dist: stringcase>=1.2.0
Requires-Dist: tabulate>=0.8.9
Requires-Dist: tqdm>=4.65.0
Requires-Dist: xlsxwriter>=3.0.3
Provides-Extra: dev
Requires-Dist: auditwheel>=5.1.2; extra == 'dev'
Requires-Dist: bandit; extra == 'dev'
Requires-Dist: build; extra == 'dev'
Requires-Dist: cibuildwheel[uv]; extra == 'dev'
Requires-Dist: ipykernel; extra == 'dev'
Requires-Dist: mypy>=0.981; extra == 'dev'
Requires-Dist: nbmake>=1.3.0; extra == 'dev'
Requires-Dist: nbstripout>=0.6.1; extra == 'dev'
Requires-Dist: nuitka==2.8.5; extra == 'dev'
Requires-Dist: pytest<8.0.0; (python_version < '3.9') and extra == 'dev'
Requires-Dist: pytest>=8.0.0; (python_version >= '3.9') and extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

# SolasAI: Algorithmic Fairness, Explainability, and Mitigation Software

![SolasAI banner](./examples/assets/solas_banner.png)

[![Tests and Scans](https://github.com/SolasAI/solas-ai/actions/workflows/1-scan-and-test.yml/badge.svg)](https://github.com/SolasAI/solas-ai/actions/workflows/1-scan-and-test.yml)

## Installing

```bash
# Create a virtual environment; supports Python 3.8 through 3.12 (inclusive)
#
#     -p [VERSION] to specify desired Python version
#     -c to make uv "clean" (delete/recreate) a .venv if one exists
#
#     -cp [VERSION] to do both together
#
uv venv -cp 3.12

# Install solas-ai and all its dependencies
uv pip install -e '.[dev]'
```

## Development

### Running tests
To run the entire test suite in verbose mode and also see a unit test coverage report:

```bash
pytest -vv --cov
```

To run only solas_disparity unit tests:

```bash
pytest -vv --cov tests/solas_disparity/
```

To run only solas_proxy unit tests:

```bash
pytest -vv --cov tests/solas_proxy/
```

### Installing ONLY the disparity or solas_proxy packages

`solas_disparity`:

```bash
uv venv -cp 3.12  # Or desired Python version
cp disparity-pyproject.toml pyproject.toml
uv pip install -e '.[dev]'
```

`solas_proxy`:

```bash
uv venv -cp 3.12  # Or desired Python version
cp proxy-pyproject.toml pyproject.toml
uv pip install -e '.[dev]'
```

## Confidentiality and Copyright

**All contents of this repository are confidential and are owned and copyrighted by SolasAI, Inc. unless stated otherwise. All rights are reserved.**

[Please review the license in detail.](/LICENSE)
