Skip to main content

A fair loss function

Project description

A fair PyTorch loss function

REUSE status PyPI version

The goal of this loss function is to take fairness into account during the training of a PyTorch model. It works by adding a fairness measure to a regular loss value, following this equation:

Installation

pip install fair-loss

Example

import torch
import torch.nn.functional as F
import numpy as np
from fair_loss import FairLoss, accuracy

model = torch.nn.Sequential(torch.nn.Linear(5, 1), torch.nn.ReLU())
data = np.random.randint(5, size=(100, 5)).astype("float")
data = torch.tensor(data, requires_grad=True, dtype=torch.float)
y_true = np.random.randint(5, size=(100, 1)).astype("float")
y_true = torch.tensor(y_true, requires_grad=True)
y_pred = model(data)
# Let's say the sensitive attribute is in the second dimension
dim = 1
loss = F.mse_loss(y_pred, y_true)
loss = FairLoss(data[:, dim], loss, y_pred, y_true, accuracy)
loss.backward()

Documentation

See the documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fair_loss-0.3-py2.py3-none-any.whl (15.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file fair_loss-0.3-py2.py3-none-any.whl.

File metadata

  • Download URL: fair_loss-0.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.3

File hashes

Hashes for fair_loss-0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c407ce321c0b4fb1768ce1ea594a3c676fcbb6bae29652f3cc44c497bd4bb347
MD5 67a01ebf1445534244fa85d91cd200a4
BLAKE2b-256 bd1a7472ed64c41a6232b91109adf6c8764efd74d8902ba19a9e286759b35290

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page