nvflare


Namenvflare JSON
Version 2.6.1 PyPI version JSON
download
home_pagehttps://github.com/NVIDIA/NVFlare
SummaryFederated Learning Application Runtime Environment
upload_time2025-07-11 22:18:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <img src="docs/resources/nvidia_eye.wwPt122j.png" alt="NVIDIA Logo" width="200">

# NVIDIA FLARE

[Website](https://nvidia.github.io/NVFlare) | [Paper](https://arxiv.org/abs/2210.13291) | [Blogs](https://developer.nvidia.com/blog/tag/federated-learning) | [Talks & Papers](https://nvflare.readthedocs.io/en/2.6/publications_and_talks.html) | [Research](./research/README.md) | [Documentation](https://nvflare.readthedocs.io/en/2.6)

[![Blossom-CI](https://github.com/NVIDIA/nvflare/workflows/Blossom-CI/badge.svg?branch=2.6)](https://github.com/NVIDIA/nvflare/actions)
[![documentation](https://readthedocs.org/projects/nvflare/badge/?version=2.6)](https://nvflare.readthedocs.io/en/2.6/?badge=2.6)
[![license](https://img.shields.io/badge/License-Apache%202.0-brightgreen.svg)](./LICENSE)
[![pypi](https://badge.fury.io/py/nvflare.svg)](https://badge.fury.io/py/nvflare)
[![pyversion](https://img.shields.io/pypi/pyversions/nvflare.svg)](https://badge.fury.io/py/nvflare)
[![downloads](https://static.pepy.tech/badge/nvflare)](https://pepy.tech/project/nvflare)

[NVIDIA FLARE](https://nvidia.github.io/NVFlare/) (**NV**IDIA **F**ederated **L**earning **A**pplication **R**untime **E**nvironment)
is a domain-agnostic, open-source, extensible Python SDK that allows researchers and data scientists to adapt existing ML/DL workflows to a federated paradigm.
It enables platform developers to build a secure, privacy-preserving offering for a distributed multi-party collaboration.

## Features
FLARE is built on a componentized architecture that allows you to take federated learning workloads
from research and simulation to real-world production deployment.

Application Features
* Support both deep learning and traditional machine learning algorithms (eg. PyTorch, TensorFlow, Scikit-learn, XGBoost etc.)
* Support horizontal and vertical federated learning
* Built-in Federated Learning algorithms (e.g., FedAvg, FedProx, FedOpt, Scaffold, Ditto, etc.)
* Support multiple server and client-controlled training workflows (e.g., scatter & gather, cyclic) and validation workflows (global model evaluation, cross-site validation)
* Support both data analytics (federated statistics) and machine learning lifecycle management
* Privacy preservation with differential privacy, homomorphic encryption, private set intersection (PSI)

From Simulation to Real-World
* FLARE Client API to transition seamlessly from ML/DL to FL with minimal code changes
* Simulator and POC mode for rapid development and prototyping
* Fully customizable and extensible components with modular design
* Deployment on cloud and on-premise
* Dashboard for project management and deployment
* Security enforcement through federated authorization and privacy policy
* Built-in support for system resiliency and fault tolerance

> _Take a look at [NVIDIA FLARE Overview](https://nvflare.readthedocs.io/en/2.6/flare_overview.html) for a complete overview, and [What's New](https://nvflare.readthedocs.io/en/2.6/whats_new.html) for the lastest changes._

## Installation
To install the [current release](https://pypi.org/project/nvflare/):
```
$ python3 -m pip install nvflare
```

For detailed installation please refer to [NVIDIA FLARE installation](https://nvflare.readthedocs.io/en/2.6/installation.html).

## Getting Started

* To get started, visit our NVFLARE [website](https://nvidia.github.io/NVFlare/), which includes:
  * Comprehensive documentation, technical blogs, tutorials, and videos
  * Slides and recordings of real-world federated learning use cases from past NVFLARE Day Events. 
  * Tools, API guides, CLI tutorials, training materials, and extensive examples
* For hands-on learning, try our [step-by-step walkthroughs](https://github.com/NVIDIA/NVFlare/tree/2.6/examples/hello-world/step-by-step) using consistent datasets.
* Learn how to adapt your centralized training code with our guide on [converting to federated learning](https://github.com/NVIDIA/NVFlare/tree/2.6/examples/hello-world/ml-to-fl).

* Structured, self-paced learning is available through curated tutorials and training paths on the website.
  * DLI courses:
    * https://learn.nvidia.com/courses/course-detail?course_id=course-v1:DLI+S-FX-28+V1
    * https://learn.nvidia.com/courses/course-detail?course_id=course-v1:DLI+S-FX-29+V1
  * follow the notebooks: https://github.com/NVIDIA/NVFlare/tree/2.6/examples/tutorials/self-paced-training
 
* If you'd like to write your own NVIDIA FLARE components, a detailed programming guide can be found [here](https://nvflare.readthedocs.io/en/2.6/programming_guide.html).
* visit developer portal https://developer.nvidia.com/flare

## Community

We welcome community contributions! Please refer to the [contributing guidelines](./CONTRIBUTING.md) for more details.

Ask and answer questions, share ideas, and engage with other community members at [NVFlare Discussions](https://github.com/NVIDIA/NVFlare/discussions).

## Related Talks and Publications

Take a look at our growing list of [talks and publications](https://nvflare.readthedocs.io/en/2.6/publications_and_talks.html), and [technical blogs](https://developer.nvidia.com/blog/tag/federated-learning) related to NVIDIA FLARE.


## License

NVIDIA FLARE is released under an [Apache 2.0 license](./LICENSE).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/NVIDIA/NVFlare",
    "name": "nvflare",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "<img src=\"docs/resources/nvidia_eye.wwPt122j.png\" alt=\"NVIDIA Logo\" width=\"200\">\n\n# NVIDIA FLARE\n\n[Website](https://nvidia.github.io/NVFlare) | [Paper](https://arxiv.org/abs/2210.13291) | [Blogs](https://developer.nvidia.com/blog/tag/federated-learning) | [Talks & Papers](https://nvflare.readthedocs.io/en/2.6/publications_and_talks.html) | [Research](./research/README.md) | [Documentation](https://nvflare.readthedocs.io/en/2.6)\n\n[![Blossom-CI](https://github.com/NVIDIA/nvflare/workflows/Blossom-CI/badge.svg?branch=2.6)](https://github.com/NVIDIA/nvflare/actions)\n[![documentation](https://readthedocs.org/projects/nvflare/badge/?version=2.6)](https://nvflare.readthedocs.io/en/2.6/?badge=2.6)\n[![license](https://img.shields.io/badge/License-Apache%202.0-brightgreen.svg)](./LICENSE)\n[![pypi](https://badge.fury.io/py/nvflare.svg)](https://badge.fury.io/py/nvflare)\n[![pyversion](https://img.shields.io/pypi/pyversions/nvflare.svg)](https://badge.fury.io/py/nvflare)\n[![downloads](https://static.pepy.tech/badge/nvflare)](https://pepy.tech/project/nvflare)\n\n[NVIDIA FLARE](https://nvidia.github.io/NVFlare/) (**NV**IDIA **F**ederated **L**earning **A**pplication **R**untime **E**nvironment)\nis a domain-agnostic, open-source, extensible Python SDK that allows researchers and data scientists to adapt existing ML/DL workflows to a federated paradigm.\nIt enables platform developers to build a secure, privacy-preserving offering for a distributed multi-party collaboration.\n\n## Features\nFLARE is built on a componentized architecture that allows you to take federated learning workloads\nfrom research and simulation to real-world production deployment.\n\nApplication Features\n* Support both deep learning and traditional machine learning algorithms (eg. PyTorch, TensorFlow, Scikit-learn, XGBoost etc.)\n* Support horizontal and vertical federated learning\n* Built-in Federated Learning algorithms (e.g., FedAvg, FedProx, FedOpt, Scaffold, Ditto, etc.)\n* Support multiple server and client-controlled training workflows (e.g., scatter & gather, cyclic) and validation workflows (global model evaluation, cross-site validation)\n* Support both data analytics (federated statistics) and machine learning lifecycle management\n* Privacy preservation with differential privacy, homomorphic encryption, private set intersection (PSI)\n\nFrom Simulation to Real-World\n* FLARE Client API to transition seamlessly from ML/DL to FL with minimal code changes\n* Simulator and POC mode for rapid development and prototyping\n* Fully customizable and extensible components with modular design\n* Deployment on cloud and on-premise\n* Dashboard for project management and deployment\n* Security enforcement through federated authorization and privacy policy\n* Built-in support for system resiliency and fault tolerance\n\n> _Take a look at [NVIDIA FLARE Overview](https://nvflare.readthedocs.io/en/2.6/flare_overview.html) for a complete overview, and [What's New](https://nvflare.readthedocs.io/en/2.6/whats_new.html) for the lastest changes._\n\n## Installation\nTo install the [current release](https://pypi.org/project/nvflare/):\n```\n$ python3 -m pip install nvflare\n```\n\nFor detailed installation please refer to [NVIDIA FLARE installation](https://nvflare.readthedocs.io/en/2.6/installation.html).\n\n## Getting Started\n\n* To get started, visit our NVFLARE [website](https://nvidia.github.io/NVFlare/), which includes:\n  * Comprehensive documentation, technical blogs, tutorials, and videos\n  * Slides and recordings of real-world federated learning use cases from past NVFLARE Day Events. \n  * Tools, API guides, CLI tutorials, training materials, and extensive examples\n* For hands-on learning, try our [step-by-step walkthroughs](https://github.com/NVIDIA/NVFlare/tree/2.6/examples/hello-world/step-by-step) using consistent datasets.\n* Learn how to adapt your centralized training code with our guide on [converting to federated learning](https://github.com/NVIDIA/NVFlare/tree/2.6/examples/hello-world/ml-to-fl).\n\n* Structured, self-paced learning is available through curated tutorials and training paths on the website.\n  * DLI courses:\n    * https://learn.nvidia.com/courses/course-detail?course_id=course-v1:DLI+S-FX-28+V1\n    * https://learn.nvidia.com/courses/course-detail?course_id=course-v1:DLI+S-FX-29+V1\n  * follow the notebooks: https://github.com/NVIDIA/NVFlare/tree/2.6/examples/tutorials/self-paced-training\n \n* If you'd like to write your own NVIDIA FLARE components, a detailed programming guide can be found [here](https://nvflare.readthedocs.io/en/2.6/programming_guide.html).\n* visit developer portal https://developer.nvidia.com/flare\n\n## Community\n\nWe welcome community contributions! Please refer to the [contributing guidelines](./CONTRIBUTING.md) for more details.\n\nAsk and answer questions, share ideas, and engage with other community members at [NVFlare Discussions](https://github.com/NVIDIA/NVFlare/discussions).\n\n## Related Talks and Publications\n\nTake a look at our growing list of [talks and publications](https://nvflare.readthedocs.io/en/2.6/publications_and_talks.html), and [technical blogs](https://developer.nvidia.com/blog/tag/federated-learning) related to NVIDIA FLARE.\n\n\n## License\n\nNVIDIA FLARE is released under an [Apache 2.0 license](./LICENSE).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Federated Learning Application Runtime Environment",
    "version": "2.6.1",
    "project_urls": {
        "Homepage": "https://github.com/NVIDIA/NVFlare"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d2dffe630a7d52bb0057b192c8ea1c26e0e247b314f21529dd234abe6d198d75",
                "md5": "26032c7e36a0667e10e4de2a38583428",
                "sha256": "d9f6f2248f7a1fd3e3f5fd598d73859d05f0beaa081efbc8288282a71a05c47f"
            },
            "downloads": -1,
            "filename": "nvflare-2.6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "26032c7e36a0667e10e4de2a38583428",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 2533631,
            "upload_time": "2025-07-11T22:18:10",
            "upload_time_iso_8601": "2025-07-11T22:18:10.944189Z",
            "url": "https://files.pythonhosted.org/packages/d2/df/fe630a7d52bb0057b192c8ea1c26e0e247b314f21529dd234abe6d198d75/nvflare-2.6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-11 22:18:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NVIDIA",
    "github_project": "NVFlare",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "nvflare"
}
        
Elapsed time: 0.54415s