Metadata-Version: 2.1
Name: openfl
Version: 1.3
Summary: Federated Learning for the Edge
Home-page: https://github.com/intel/openfl
Author: Intel Corporation
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/intel/openfl/issues
Project-URL: Documentation, https://openfl.readthedocs.io/en/stable/
Project-URL: Source Code, https://github.com/intel/openfl
Description: # OpenFL - An Open-Source Framework For Federated Learning
        
        [![PyPI - Python Version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue)](https://pypi.org/project/openfl/)
        [![Jenkins](https://img.shields.io/jenkins/build?jobUrl=http%3A%2F%2F213.221.44.203%2Fjob%2FFederated-Learning%2Fjob%2Fnightly%2F)](http://213.221.44.203/job/Federated-Learning/job/nightly/)
        [![Documentation Status](https://readthedocs.org/projects/openfl/badge/?version=latest)](https://openfl.readthedocs.io/en/latest/?badge=latest)
        [![Downloads](https://pepy.tech/badge/openfl)](https://pepy.tech/project/openfl)
        [![PyPI version](https://img.shields.io/pypi/v/openfl)](https://pypi.org/project/openfl/)
        [<img src="https://img.shields.io/badge/slack-@openfl-blue.svg?logo=slack">](https://join.slack.com/t/openfl/shared_invite/zt-ovzbohvn-T5fApk05~YS_iZhjJ5yaTw) 
        [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
        [![Citation](https://img.shields.io/badge/cite-citation-blue)](https://arxiv.org/abs/2105.06413)
        [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/intel/openfl/blob/develop/openfl-tutorials/interactive_api/numpy_linear_regression/workspace/SingleNotebook.ipynb)
        
        OpenFL is a Python 3 framework for Federated Learning. OpenFL is designed to be a _flexible_, _extensible_ and _easily learnable_ tool for data scientists. OpenFL is developed by Intel Internet of Things Group (IOTG) and Intel Labs. 
        
        ## Installation
        
        You can simply install OpenFL from PyPI:
        
        ```
        $ pip install openfl
        ```
        For more installation options check out the [online documentation](https://openfl.readthedocs.io/en/latest/install.html).
        
        ## Getting Started
        
        
        OpenFL enables data scientists to set up a federated learning experiment following one of the workflows:
        
        - [Director-based Workflow](https://openfl.readthedocs.io/en/latest/running_the_federation.html#director-based-workflow) [preferred]:
        a federation created with this workflow continues to be available to distribute more experiments in series.
        
        - [Aggregator-based Workflow](https://openfl.readthedocs.io/en/latest/running_the_federation.html#aggregator-based-workflow):
        with this workflow, the federation is terminated when the experiment is finished.
        
        The quickest way to test OpenFL is to follow our [tutorials](https://github.com/intel/openfl/tree/develop/openfl-tutorials). </br>
        Read the [blog post](https://towardsdatascience.com/go-federated-with-openfl-8bc145a5ead1) explaining steps to train a model with OpenFL. </br>
        Check out the [online documentation](https://openfl.readthedocs.io/en/latest/index.html) to launch your first federation.
        
        
        ## Requirements
        
        - Ubuntu Linux 16.04 or 18.04.
        - Python 3.6+ (recommended to use with [Virtualenv](https://virtualenv.pypa.io/en/latest/)).
        
        OpenFL supports training with TensorFlow 2+ or PyTorch 1.3+ which should be installed separately. User can extend the list of supported Deep Learning frameworks if needed.
        
        ## Project Overview
        ### What is Federated Learning
        
        [Federated learning](https://en.wikipedia.org/wiki/Federated_learning) is a distributed machine learning approach that enables collaboration on machine learning projects without having to share sensitive data, such as, patient records, financial data, or classified information. The minimum data movement needed across the federation is solely the model parameters and their updates.
        
        ![Federated Learning](https://raw.githubusercontent.com/intel/openfl/develop/docs/images/diagram_fl_new.png)
        
        
        ### Background
        OpenFL builds on the [OpenFederatedLearning](https://github.com/IntelLabs/OpenFederatedLearning) framework, which was a collaboration between Intel and the University of Pennsylvania (UPenn) to develop the [Federated Tumor Segmentation (FeTS, www.fets.ai)](https://www.fets.ai/) platform (grant award number: U01-CA242871). 
        
        The grant for FeTS was awarded to the [Center for Biomedical Image Computing and Analytics (CBICA)](https://www.cbica.upenn.edu/) at UPenn (PI: S. Bakas) from the [Informatics Technology for Cancer Research (ITCR)](https://itcr.cancer.gov/) program of the National Cancer Institute (NCI) of the National Institutes of Health (NIH). 
        
        FeTS is a real-world medical federated learning platform with international collaborators. The original OpenFederatedLearning project and OpenFL are designed to serve as the backend for the FeTS platform, 
        and OpenFL developers and researchers continue to work very closely with UPenn on the FeTS project. An example is the [FeTS-AI/Front-End](https://github.com/FETS-AI/Front-End), which integrates UPenn’s medical AI expertise with Intel’s framework to create a federated learning solution for medical imaging. 
        
        Although initially developed for use in medical imaging, OpenFL designed to be agnostic to the use-case, the industry, and the machine learning framework.
        
        You can find more details in the following articles:
        - [Sheller MJ,  et al., 2020](https://www.nature.com/articles/s41598-020-69250-1) 
        - [Sheller MJ, et al., 2019](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6589345)
        - [Yang Y, et al., 2019](https://arxiv.org/abs/1902.04885)
        - [McMahan HB, et al., 2016](https://arxiv.org/abs/1602.05629)
        
        
        
        ## Support
        We welcome questions, issue reports, and suggestions:
        
        * [GitHub Issues](https://github.com/intel/openfl/issues)
        * [Slack workspace](https://join.slack.com/t/openfl/shared_invite/zt-ovzbohvn-T5fApk05~YS_iZhjJ5yaTw)
        
        
        ## License
        This project is licensed under [Apache License Version 2.0](LICENSE). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
        
        
        ## Citation
        
        ```
        @misc{reina2021openfl,
              title={OpenFL: An open-source framework for Federated Learning}, 
              author={G Anthony Reina and Alexey Gruzdev and Patrick Foley and Olga Perepelkina and Mansi Sharma and Igor Davidyuk and Ilya Trushkin and Maksim Radionov and Aleksandr Mokrov and Dmitry Agapov and Jason Martin and Brandon Edwards and Micah J. Sheller and Sarthak Pati and Prakash Narayana Moorthy and Shih-han Wang and Prashant Shah and Spyridon Bakas},
              year={2021},
              eprint={2105.06413},
              archivePrefix={arXiv},
              primaryClass={cs.LG}
        }
        ```
        
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Topic :: System :: Distributed Computing
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6, <3.9
Description-Content-Type: text/markdown
