From 5f7eb4facec5cfb2768c0bbe04484bde032e653d Mon Sep 17 00:00:00 2001 From: Teodor Parvanov Date: Wed, 8 Jan 2025 14:51:23 +0100 Subject: [PATCH] Adding OpenFL 1.7 release notes Signed-off-by: Teodor Parvanov --- docs/releases.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/releases.md b/docs/releases.md index 7bc328b7b9..9c7f33164f 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -1,5 +1,26 @@ # Releases +## 1.7 +[Full Release Notes](https://github.com/securefederatedai/openfl/releases/tag/v1.7) + +### New Features +- [**FederatedRuntime**](https://openfl.readthedocs.io/en/latest/about/features_index/workflowinterface.html#runtimes-future-plans) for Workflow API: enables a seamless transition from a local simulation (via LocalRuntime) to a distributed Federated Learning deployment. Check out the [FederatedRuntime 101 Tutorial](https://github.com/securefederatedai/openfl/tree/develop/openfl-tutorials/experimental/workflow/FederatedRuntime/101_MNIST) to try it yourself. + +- [**Federated XGBoost**](https://github.com/securefederatedai/openfl/tree/develop/openfl-workspace/xgb_higgs): Adding support for XGBoost in OpenFL via TaskRunner API, illustrated with the Higgs dataset. + +- [**Callbacks**](https://openfl.readthedocs.io/en/latest/openfl.callbacks.html): An abstraction for running user-defined actions in TaskRunner API or Workflow API. Callbacks can be used to perform custom actions at different stages of the Federated Learning process. + +### Enhanced Developer Experience +- **Streamlining OpenFL APIs**: As of this release, the OpenFL Team will focus on TaskRunner API and Workflow API. As such, the Python Native API and Interactive API have been deprecated, slated for removal in upcoming releases. + +- **Updated Tutorials**: This includes fixes to existing tutorial and example code, and migrating a selection of key OpenFL tutorials from deprecated APIs to Workflow API. Check out the updated [Tutorials](https://github.com/securefederatedai/openfl/tree/develop/openfl-tutorials/experimental/workflow) folder. + +- **FL Workspace Dockerization**: Revised Task Runner API workspace dockerization process, with TEE-ready containers (using Gramine and IntelĀ® Software Guard Extensions). Follow the [updated instructions](https://github.com/securefederatedai/openfl/blob/develop/openfl-docker/README.md) to enhance the privacy and security of your FL experiments. + +- **Federated Evaluation via TaskRunner API**: OpenFL 1.7 simplifies the creation of Federated Evaluation experiments via the TaskRunner API (see the [example workspace](https://github.com/securefederatedai/openfl/tree/develop/openfl-workspace/torch_cnn_mnist_fed_eval)). + +- **Keras 3**: Upgrading the base TaskRunner classes and example workspaces to Keras 3 for building state-of-the-art TensorFlow-based FL experiments + ## 1.6 [Full Release Notes](https://github.com/securefederatedai/openfl/releases/tag/v1.6)