Metadata-Version: 2.1
Name: flwr-lowcarb
Version: 0.1.7
Summary: Carbon-aware client selection strategy for Flower
Home-page: https://github.com/birnbaum/lowcarb
Author: Philipp Wiesner, Martin Schellenberger, Dennis Grinwald
Author-email: wiesner@tu-berlin.de
License: MIT
Keywords: carbon awareness,federated learning,client selection,flower
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE


# Lowcarb

[![PyPI version](https://img.shields.io/pypi/v/flwr-lowcarb.svg?color=52c72b)](https://pypi.org/project/flwr-lowcarb/) [![Supported versions](https://img.shields.io/pypi/pyversions/flwr-lowcarb.svg)](https://pypi.org/project/flwr-lowcarb/) [![License](https://img.shields.io/pypi/l/flwr-lowcarb.svg)](https://pypi.org/project/flwr-lowcarb/)

A carbon-aware client selection strategy for Flower powered by the [Carbon-Aware-SDK](https://github.com/Green-Software-Foundation/carbon-aware-sdk).

Enabling **privacy-aware** and **carbon-aware** machine learning.


## Installation ⚙️

To install lowcarb, simply run

```
pip install flwr-lowcarb
```


## Tutorial 🌼

To try out our tutorial, clone the repository and run

```
python -m venv venv              # create venv
. venv/bin/activate               # activate venv on Linux/Mac
.\venv\Scripts\activate           # activate venv on Windows
pip install -r requirements.txt  # install dependencies
```

You can then open the tutorial by running `jupyter lab` and starting `flow_lowcarb_tutorial.ipynb`.
