fairml-datasets 0.2.5
A package for managing and processing datasets for fairness research in machine learning
License: CC BY 4.0
Requires Python: >=3.10

<p align="center">
  <img alt="faiground logo" src="https://raw.githubusercontent.com/reliable-ai/fairground/main/docs/assets/fairground-logo-bg.png" width="40%" align="center">
</p>

# FairML Datasets

[![PyPI](https://img.shields.io/pypi/v/fairml-datasets.svg)](https://pypi.org/project/fairml-datasets/)
[![Tests](https://github.com/reliable-ai/fairground/actions/workflows/tests.yml/badge.svg)](https://github.com/reliable-ai/fairground/actions/workflows/tests.yml)

A comprehensive Python package for loading, processing, and working with datasets used in fair classification.

## Overview

![The dataset preprocessing pipeline supported by the package.](https://raw.githubusercontent.com/reliable-ai/fairground/main/docs/assets/pipeline.png)

FairML Datasets provides tools and interfaces to download, load, transform, and analyze the datasets in the *FairGround* corpus. It handles sensitive attributes and facilitates fairness-aware machine learning experiments. The package supports the full data processing pipeline from downloading data all the way to splitting data for ML training.

## Key Features

- 📦 **Loading**: Easily download, load and prepare any of the 44 supported datasets in the corpus.
- 🗂️ **Collections**: Conveneiently use any of our prespecified collections which have been developed to maximize diversity in algorithmic performance.
- 🔄 **Multi-Dataset Support**: Easily evaluate your algorithm on one scenario, five or fourty using a simple loop.
- ⚙️ **Processing**: Automatically apply dataset (pre)processing with configurable choices and defaults available.
- 📊 **Metadata Generation**: Automatically calculate rich metadata features for datasets.
- 💻 **Command-line Interface**: Access common operations without writing code.

## Installation

```bash
pip install fairml-datasets
```

Or using uv:

```bash
uv add fairml-datasets
```

## Quick Start

```python
from fairml_datasets import Dataset

# Access a specific dataset by ID directly
dataset = Dataset.from_id("folktables_acsincome_small")

# Load the dataset
df = dataset.load()

# Check sensitive attributes
print(f"Sensitive columns: {dataset.sensitive_columns}")

# Transform the dataset
df_transformed, info = dataset.transform(df)

# Create train/test/validation split
df_train, df_test, df_val = dataset.train_test_val_split(df_transformed)
```

Are you curious which datasets are available? Check out the `Datasets Overview` in the side bar to see the list!

## Command-line Usage

The package provides a command-line interface for common operations:

```bash
# Generate and export metadata
python -m fairml_datasets metadata

# Export datasets in various processing stages
python -m fairml_datasets export-datasets --stage prepared

# Export dataset citations in BibTeX format
python -m fairml_datasets export-citations
```

## Development

Development dependencies are managed via `uv`. For information on how to install `uv`, please refer to [official installation instructions](https://docs.astral.sh/uv/getting-started/installation/).

To install all dependencies, run:

```bash
uv sync --dev
```

### Formatting

We're using `ruff` for formatting of code. You can autoformat and lint code by running: 

```bash
ruff check . --fix && ruff format .
```

### Tests

Tests are located in the `tests/` directory. You can run all tests using `pytest`:

```bash
uv run pytest
```

# License

Due to restrictions in some of the third-party code we include, this work is licensed under two licenses.

The primary license of this work is [Creative Commons Attribution 4.0 International License](./LICENSE.md) (CC BY 4.0). This license applies to all assets generated by the authors of this work. It does NOT apply to the `generate_synthetic_data.py` script, which instead is licensed under GNU GPLv3.

The second license, which applies to the complete repository, is the more restrictive [GNU GENERAL PUBLIC LICENSE 3 (GNU GPLv3)](./LICENSE-2.md).

**Please note that this licensing information only refers to the code, annotations and generated metadata. Individual datasets which are loaded and exported by this package may have different licenses. Please refer to individual datasets and their sources for dataset-level information.**