🌐 FedModelKit (fmk)

FedModelKit is a Python library designed to streamline the execution of federated learning tasks within a network of collaborating partners.
It provides a guided workflow that helps users quickly set up experiments, manage dependencies, and follow step-by-step instructions through generated resources.

📑 Table of Contents

• Overview
• Features
• Dependencies
• Installation
• Quick Start
• Next Steps
• License & Commercial Use

🔎 Overview

Federated learning enables multiple partners to train machine learning models collaboratively without sharing raw data.
The FedModelKit library simplifies this process by:

• Automating project initialization
• Creating a reproducible experiment directory with all required dependencies
• Offering a clear, step-by-step workflow to run experiments in a federated network

🧩 Dependencies

These are the dependencies of the packages, including the required Python version:

⚙️ Installation

It is recommended to install FedModelKit inside a virtual environment.
We suggest using uv for fast and reproducible setups:

1. Create and activate a virtual environment

   uv venv
   source .venv/bin/activate
   

   or in case of Windows OS

   uv venv
   .venv\Scripts\activate
   

2. Install FedModelKit

   uv pip install FedModelKit
   

🚀 Quick Start

Initialize a new federated learning experiment with:

fmk init -n my_experiment

This will generate in the present directory the project for a new FL experiment.

📖 Next Steps

👉 Once the experiment directory has been created, open the file README.md that has been generated in your directory and follow the guided workflow to set up and run your federated learning tasks.

⚖️ License & Commercial Use

This software is Source Available and distributed under a Dual Licensing model.

🎓 Non-Commercial Use (Community)

This project is free for personal use, education, non-profit organizations, and academic research under the PolyForm Noncommercial License 1.0.0.

• ✅ You can read, modify, and execute the code.
• ✅ You can use it for personal and research projects.
• ❌ You may NOT use it for commercial purposes or in business environments without a commercial license.

Check the LICENSE file for full terms.

💼 Commercial Use (Businesses)

If you wish to use this software in a commercial product, a business, or any revenue-generating environment, you must purchase a Commercial License.

The Commercial License grants you:

• The right to use the software in commercial production environments.
• Exemption from the PolyForm license restrictions.
• Priority support (optional).

📩 To purchase a license, please contact us at: federico.alvarez@upm.es