Documentation changes

Signed-off-by: yes <[email protected]>
securefederatedai · Nov 13, 2024 · 7b90873 · 7b90873
1 parent f8845d8
commit 7b90873
Show file tree

Hide file tree

Showing 8 changed files with 7 additions and 24 deletions.
diff --git a/docs/about/features_index/pynative.rst b/docs/about/features_index/pynative.rst
diff --git a/docs/developer_guide/advanced_topics/overriding_agg_fn.rst b/docs/developer_guide/advanced_topics/overriding_agg_fn.rst
@@ -10,7 +10,7 @@ Override Aggregation Function
 With the aggregator-based workflow, you can use custom aggregation functions for each task via Python\*\  API or command line interface.
 
 
-Python API
+Python API (Deprecated)
 ==========
 
 1. Create an implementation of :class:`openfl.interface.aggregation_functions.core.AggregationFunction`.

diff --git a/docs/developer_guide/advanced_topics/overriding_plan_settings.rst b/docs/developer_guide/advanced_topics/overriding_plan_settings.rst
@@ -11,7 +11,7 @@ With the director-based workflow, you can use custom plan settings before starti
 When using Python API or Director Envoy based interactive API, **override_config** can be used to update plan settings. 
 
 
-Python API
+Python API (Deprecated)
 ==========
 
 Modify the plan settings:

diff --git a/docs/developer_guide/running_the_federation.notebook.rst b/docs/developer_guide/running_the_federation.notebook.rst
@@ -4,7 +4,7 @@
 .. _running_notebook:
 
 **********************************
-Aggregator-Based Workflow Tutorial
+Aggregator-Based Workflow Tutorial (Deprecated)
 **********************************
 
 You will start a Jupyter\* \  lab server and receive a URL you can use to access the tutorials. Jupyter notebooks are provided for PyTorch\* \  and TensorFlow\* \  that simulate a federation on a local machine.

diff --git a/docs/developer_guide/utilities/splitters_data.rst b/docs/developer_guide/utilities/splitters_data.rst
@@ -13,7 +13,7 @@ Dataset Splitters
 You may apply data splitters differently depending on the |productName| workflow that you follow. 
 
 
-OPTION 1: Use **Native Python API** (Aggregator-Based Workflow) Functions to Split the Data
+OPTION 1: Use **Native Python API** (Aggregator-Based Workflow) Functions to Split the Data (Deprecated)
 ===========================================================================================
 
 Predefined |productName| data splitters functions are as follows:

diff --git a/docs/get_started/examples.rst b/docs/get_started/examples.rst
@@ -30,7 +30,7 @@ See :ref:`running_the_task_runner`
     :ref:`running_the_task_runner`
 
 -------------------------
-Python Native API
+Python Native API (Deprecated)
 -------------------------
 Intended for quick simulation purposes
 

diff --git a/docs/get_started/examples/python_native_pytorch_mnist.rst b/docs/get_started/examples/python_native_pytorch_mnist.rst
@@ -4,7 +4,7 @@
 .. _python_native_pytorch_mnist:
 
 ==========================================
-Python Native API: Federated PyTorch MNIST
+Python Native API: Federated PyTorch MNIST (Deprecated)
 ==========================================
 
 In this tutorial, we will set up a federation and train a basic PyTorch model on the MNIST dataset using the Python Native API.

diff --git a/docs/source/api/openfl_native.rst b/docs/source/api/openfl_native.rst
@@ -2,7 +2,7 @@
 .. # SPDX-License-Identifier: Apache-2.0
 
 *************************************************
-Native Module
+Native Module (Deprecated)
 *************************************************
 
 Native modules reference: