deprecate interactive API #1125
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vrancurel
commented
Nov 6, 2024
vrancurel
commented
- Point interactive_api examples to openfl-contrib (where they have been moved)
- Mark interactive_api as deprecated in the doc
- Remove interactive_api from CI/CD
teoparvanov
reviewed
Nov 7, 2024
teoparvanov
reviewed
Nov 7, 2024
vrancurel
force-pushed
the
deprecate_interactive_api
branch
from
544e360
to
ef01dad
Compare
kta-intel
reviewed
Nov 7, 2024
docs/about/releases.md
Outdated
| @@ -11,7 +11,7 @@ | |||
| - **Workflow API enhancements**: Introducing an experimental [Workspace Export](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/1001_Workspace_Creation_from_JupyterNotebook.ipynb) feature that can be used to transform a Workflow API-based FL experiment into the TaskRunner API format for running in a distributed deployment. There is also groundwork laid for a future FederatedRuntime implementation for Workflow API, in addition to the currently supported LocalRuntime. | |||
| - **Federated Evaluation**: Federated evaluation allows for the assessment of ML models in a federated learning system by validating the model's performance locally on decentralized collaborator nodes, and then aggregating these metrics to gauge overall effectiveness, without compromising data privacy and security. FE is now officially supported by OpenFL, including [example tutorials](https://openfl.readthedocs.io/en/latest/about/features_index/fed_eval.html) on how to use this new feature (via TaskRunner API). | |||
|
|
|||
| - **Expanded AI Accelerator Support**: Intel® Data Center GPU Max Series support via the Intel® Extension for PyTorch, including examples for training on datasets such as [MNIST](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/104_MNIST_XPU.ipynb) (via Workflow API) and [TinyImageNet](https://github.com/securefederatedai/openfl/tree/develop/openfl-tutorials/interactive_api/PyTorch_TinyImageNet_XPU) (via Interactive API) | |||
| - **Expanded AI Accelerator Support**: Intel® Data Center GPU Max Series support via the Intel® Extension for PyTorch, including examples for training on datasets such as [MNIST](https://github.com/securefederatedai/openfl/blob/develop/openfl-tutorials/experimental/104_MNIST_XPU.ipynb) (via Workflow API) and [TinyImageNet](https://github.com/securefederatedai/openfl-contrib/tree/main/openfl_contrib_tutorials/interactive_api/PyTorch_TinyImageNet_XPU) (via Interactive API) | |||
There was a problem hiding this comment.
From my comment on the openfl-contrib PR
Would it be better to move these to a subfolder openfl-tutorials/deprecated/ for v1.7 then remove outright in v1.6 instead of to the contrib repo?
There was a problem hiding this comment.
This is the suggestion indeed, based on our offline discussion.
|
Thanks @vrancurel, this is definitely a much needed PR! However, I'd just like some clarity on the plan |
MasterSkepticista
approved these changes
Nov 8, 2024
vrancurel
force-pushed
the
deprecate_interactive_api
branch
from
ef01dad
to
8b06d64
Compare
- Point interactive_api examples to openfl-contrib (where they have been moved) - Mark interactive_api as deprecated in the doc - Remove interactive_api from CI/CD Signed-off-by: Rancurel, Vianney <[email protected]>
vrancurel
force-pushed
the
deprecate_interactive_api
branch
from
8b06d64
to
76e224a
Compare
tanwarsh
approved these changes
Nov 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.