Skip to main content

A cutting-edge unlearning framework that enables AI models to selectively forget learned data, ensuring compliance, privacy, and adaptability.

Project description

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

Project details


Download files

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

Source Distribution

forgetful_ml-0.0.1.tar.gz (40.6 kB view details)

Uploaded Source

Built Distribution

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

forgetful_ml-0.0.1-py3-none-any.whl (27.2 kB view details)

Uploaded Python 3

File details

Details for the file forgetful_ml-0.0.1.tar.gz.

File metadata

  • Download URL: forgetful_ml-0.0.1.tar.gz
  • Upload date:
  • Size: 40.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for forgetful_ml-0.0.1.tar.gz
Algorithm Hash digest
SHA256 a620b7020bd7b81ec79f0d7a612d482b6ed9090c9975700e2a7bc22672c788ce
MD5 4d922ca6f84598beb51a0e840b6d375b
BLAKE2b-256 36f821f12e5210f8af556c6ea7c7e8b7435347c944b2f03b68d2a1465477d57a

See more details on using hashes here.

File details

Details for the file forgetful_ml-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: forgetful_ml-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 27.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for forgetful_ml-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d2a2da3d5772e705b253f5753bb51920a10e9d4e7fffaaa5c5f0c62e4b06366f
MD5 b9965f1b5891ed7d47c5e69836e12a74
BLAKE2b-256 23edc1a9300835171507f4d23ab2155284b303386f6b204eb4fd32f882c348ef

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