Skip to main content

ForgetfulML

ForgetfulML is a cutting-edge machine unlearning framework designed to enable AI models to selectively forget previously learned data. This functionality is crucial for ensuring compliance with privacy regulations, improving model adaptability, and maintaining ethical standards in machine learning. ForgetfulML simplifies the process of unlearning, offering a seamless integration with existing ML workflows.

Key Features

  • Selective Unlearning: Remove specific data or knowledge from AI models while maintainig the performance.
  • Compliance & Privacy: Comply with privacy regulations like GDPR by unlearning personal or sensitive information.
  • Easy Integration: Compatible with popular machine learning frameworks.
  • Adaptability: Helps AI models evolve by erasing outdated or irrelevant information.
  • Evaluation: Provides Tools to evaluate your unlearning methods.

Installation

Install ForgetfulML using pip:

pip install unlearning

Quick Start

⚠️ Warning This Library is under development.

Here's how you can quickly start using ForgetfulML in your project:

# Import the Unlearning module
from unlearning import ClassForgetter

# Initialize the Forgetter
forgetter = ClassForgetter()

# Load your pre-trained machine learning model
model = load_your_model()  # Replace with your model loading function

# Define the data you want the model to forget
data_to_forget = get_data_to_forget()  # Replace with your data extraction

# Unlearn the specified data
forgetter.unlearn(model, data_to_forget)

# Continue using your updated model
save_model(model)  # Replace with your model saving function

Use Cases

  • Data Privacy: Comply with privacy laws by unlearning user data upon request.
  • Model Updates: Keep your models up to date by removing outdated or irrelevant data.
  • Data Debugging: Correct model misbehavior by unlearning incorrect or mislabeled training data.

Documentation

⚠️ Under development

Contributing

We welcome contributions! If you'd like to help improve ForgetfulML, feel free to submit pull requests or open issues.

Support

For questions or issues, feel free to reach out by opening a GitHub issue or contact us at unlearning@faraji.info

Development

Build

Install build dependencies:

pip install build

Build the package:

python -m build

Test

Install test dependencies (tests/requirements.txt):

pip install -r tests/requirements.txt

Run the tests:

pytest

Metadata

Release files for forgetful-ml 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for forgetful-ml 0.0.1
File Size Uploaded
forgetful_ml-0.0.1.tar.gz 40.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for forgetful-ml 0.0.1
File Interpreter ABI Platform
forgetful_ml-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 67.8 kB

Release files / forgetful_ml-0.0.1.tar.gz

Download URL forgetful_ml-0.0.1.tar.gz
Size 40.6 kB
Tags Source
SHA-256 checksum
How to use checksums
a620b7020bd7b81ec79f0d7a612d482b6ed9090c9975700e2a7bc22672c788ce
BLAKE2b-256 checksum
How to use checksums
36f821f12e5210f8af556c6ea7c7e8b7435347c944b2f03b68d2a1465477d57a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Release files / forgetful_ml-0.0.1-py3-none-any.whl

Download URL forgetful_ml-0.0.1-py3-none-any.whl
Size 27.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d2a2da3d5772e705b253f5753bb51920a10e9d4e7fffaaa5c5f0c62e4b06366f
BLAKE2b-256 checksum
How to use checksums
23edc1a9300835171507f4d23ab2155284b303386f6b204eb4fd32f882c348ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page