Merge branch 'develop' into noopur/xgb_higgs_automation

securefederatedai · Jan 20, 2025 · d5834ce · d5834ce
2 parents af42404 + a19f869
commit d5834ce
Show file tree

Hide file tree

Showing 23 changed files with 5 additions and 4,071 deletions.
diff --git a/.github/workflows/pki.yml b/.github/workflows/pki.yml
@@ -33,20 +33,3 @@ jobs:
     - name: Test PKI
       run: |
         python tests/github/pki_insecure_client.py
-  test_wrong_common_name:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3
-      uses: actions/setup-python@v3
-      with:
-        python-version: "3.10"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install .
-    - name: Test PKI
-      run: |
-        python tests/github/pki_wrong_cn.py
diff --git a/docs/developer_guide/advanced_topics/overriding_agg_fn.rst b/docs/developer_guide/advanced_topics/overriding_agg_fn.rst
@@ -7,20 +7,9 @@
 Override Aggregation Function
 *****************************
 
-With the aggregator-based workflow, you can use custom aggregation functions for each task via Python\*\  API or command line interface.
+With the aggregator-based workflow, you can use custom aggregation functions for each task via command line interface.
 
 
-Python API (Deprecated)
-==========
-
-1. Create an implementation of :class:`openfl.interface.aggregation_functions.core.AggregationFunction`.
-
-2. In the ``override_config`` keyword argument of the :func:`openfl.native.run_experiment` native function, pass the implementation as a ``tasks.{task_name}.aggregation_type`` parameter.
-
-.. note::
-    See `Federated PyTorch MNIST Tutorial <https://github.com/intel/openfl/blob/develop/openfl-tutorials/Federated_Pytorch_MNIST_custom_aggregation_Tutorial.ipynb>`_ for an example of the custom aggregation function.
-
-
 Command Line Interface
 ======================
 

diff --git a/docs/developer_guide/advanced_topics/overriding_plan_settings.rst b/docs/developer_guide/advanced_topics/overriding_plan_settings.rst
diff --git a/docs/developer_guide/running_the_federation.notebook.rst b/docs/developer_guide/running_the_federation.notebook.rst
diff --git a/docs/get_started/examples.rst b/docs/get_started/examples.rst
@@ -7,12 +7,7 @@
 Examples for Running a Federation
 =================================
 
-OpenFL currently offers four ways to set up and run experiments with a federation: 
-the Task Runner API, Python Native API, the Interactive API (Deprecated), and the Workflow API. 
-the Task Runner API is advised for production scenarios where the workload needs to be verified prior to execution, whereas the python native API provides a clean python interface on top of it intended for simulation purposes.
-The Interactive API (Deprecated) introduces a convenient way to set up a federation and brings “long-lived” components in a federation (“Director” and “Envoy”), 
-while the Task Runner API workflow is advised for scenarios where the workload needs to be verified prior to execution. In contrast, the currently experimental Workflow API
-is introduced to provide significant flexility to researchers and developers in the construction of federated learning experiments.
+OpenFL currently offers two ways to set up and run experiments with a federation: the Task Runner API and the Workflow API. The Task Runner API is advised for production scenarios where the workload needs to be verified prior to execution. The experimental Workflow API is introduced to provide significant flexility to researchers and developers in the construction of federated learning experiments.
 
 As OpenFL nears it's 2.0 release, we expect to consolidate these APIs and make the Workflow API the primary interface going forward. See our `roadmap <https://github.com/securefederatedai/openfl/blob/develop/ROADMAP.md>`_ for more details.