From 139891787b81d182e17a629e6b548d6ef81e596f Mon Sep 17 00:00:00 2001 From: Phillip Boushy Date: Wed, 24 Apr 2024 15:55:35 -0600 Subject: [PATCH 1/3] Fix all warnings related to broken links Signed-off-by: Phillip Boushy --- docs/about/features.rst | 10 +++++----- docs/about/releases.md | 9 ++++----- docs/conf.py | 2 +- docs/developer_guide/experimental_features.rst | 2 +- 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/about/features.rst b/docs/about/features.rst index 622fff24a6..4bb5b5f9d3 100644 --- a/docs/about/features.rst +++ b/docs/about/features.rst @@ -16,7 +16,7 @@ Running a Federation Task Runner Define an experiment and distribute it manually. All participants can verify model code and FL plan prior to execution. The federation is terminated when the experiment is finished. Formerly known as the aggregator-based workflow. - `For more info `_ + For more info see :doc:`features_index/taskrunner` .. toctree:: :hidden: @@ -26,7 +26,7 @@ Task Runner Interactive Setup long-lived components to run many experiments in series. Recommended for FL research when many changes to model, dataloader, or hyperparameters are expected. Formerly known as the director-based workflow. - `For more info `_ + For more info see :doc:`features_index/interactive` .. toctree:: :hidden: @@ -36,7 +36,7 @@ Interactive Workflow Interface (Experimental) Formulate the experiment as a series of tasks, or a flow. Every flow begins with the start task and concludes with end. Heavily influenced by the interface and design of Netflix's Metaflow, the popular framework for data scientists. - `For more info `_ + For more info see :doc:`features_index/workflowinterface` .. toctree:: :hidden: @@ -91,7 +91,7 @@ FedCurv Federated Evaluation --------------------- -Evaluate the accuracy and performance of your model on data distributed across decentralized nodes without comprimising data privacy and security. `For more info `_ +Evaluate the accuracy and performance of your model on data distributed across decentralized nodes without comprimising data privacy and security. For more info see :doc:`features_index/fed_eval` .. toctree:: :hidden: @@ -104,7 +104,7 @@ Evaluate the accuracy and performance of your model on data distributed across d Privacy Meter --------------------- -Quantitatively audit data privacy in statistical and machine learning algorithms. `For more info `_ +Quantitatively audit data privacy in statistical and machine learning algorithms. For more info see :doc:`features_index/privacy_meter` .. toctree:: :hidden: diff --git a/docs/about/releases.md b/docs/about/releases.md index 1f6772c6d8..40ffb4048a 100644 --- a/docs/about/releases.md +++ b/docs/about/releases.md @@ -1,12 +1,11 @@ -Releases -========== +# Releases ## 1.5.1 [Full Release Notes](https://github.com/securefederatedai/openfl/releases/tag/v1.5.1) We are excited to announce the release of OpenFL 1.5.1 - our first since moving to LF AI & Data! This release brings the following changes. -### Highlights +### 1.5.1 Highlights - **Documentation accessibility improvements**: As part of our [Global Accessibility Awareness Day](https://www.intel.com/content/www/us/en/developer/articles/community/open-fl-project-improve-accessibility-for-devs.html) (GAAD) Pledge, the OpenFL project is making strides towards more accessible documentation. This release includes the integration of [Intel® One Mono](https://www.intel.com/content/www/us/en/company-overview/one-monospace-font.html) font, contrast color improvements, formatting improvements, and [new accessibility focused issues](https://github.com/securefederatedai/openfl/issues?q=is%3Aissue+is%3Aopen+accessibility) to take up in the future. - **[Documentation to federate a Generally Nuanced Deep Learning Framework (GaNDLF) model with OpenFL](https://openfl.readthedocs.io/en/latest/running_the_federation_with_gandlf.html)** - **New OpenFL Interactive API Tutorials**: @@ -21,7 +20,7 @@ We are excited to announce the release of OpenFL 1.5.1 - our first since moving ## 1.5 [Full Release Notes](https://github.com/securefederatedai/openfl/releases/tag/v1.5) -### Highlights +### 1.5 Highlights * **New Workflows Interface (Experimental)** - a new way of composing federated learning experiments inspired by [Metaflow](https://github.com/Netflix/metaflow). Enables the creation of custom aggregator and collaborators tasks. This initial release is intended for simulation on a single node (using the LocalRuntime); distributed execution (FederatedRuntime) to be enabled in a future release. * **New use cases enabled by the workflow interface**: * **[End-of-round validation with aggregator dataset](https://github.com/intel/openfl/blob/develop/openfl-tutorials/experimental/Workflow_Interface_102_Aggregator_Validation.ipynb)** @@ -114,4 +113,4 @@ This release includes: - `fx` CLI for multi-node production deployments - Additional test coverage for OpenFL components -\* Singularity supported via DockerHub integration: `singularity shell docker://openfl:latest` \ No newline at end of file +\* Singularity supported via DockerHub integration: `singularity shell docker://openfl:latest` diff --git a/docs/conf.py b/docs/conf.py index 16ccfbb2b1..5fd63f6114 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -73,7 +73,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', +exclude_patterns = ['_build', 'Thumbs.db', 'README.md', 'structurizer_dsl/README.md', '.DS_Store', 'tutorials/*', 'graveyard/*'] # add temporary unused files exclude_patterns.extend(['modules.rst', diff --git a/docs/developer_guide/experimental_features.rst b/docs/developer_guide/experimental_features.rst index 8ed19f95a6..b95c882e8a 100644 --- a/docs/developer_guide/experimental_features.rst +++ b/docs/developer_guide/experimental_features.rst @@ -26,4 +26,4 @@ Experimental features are *not* ready for production. These features are under a :maxdepth: 4 :hidden: - workflow_interface \ No newline at end of file + ../about/features_index/workflowinterface From ce1ae5149ef52ce877b5e796b2d8f7d88cd49298 Mon Sep 17 00:00:00 2001 From: Phillip Boushy Date: Wed, 24 Apr 2024 15:57:26 -0600 Subject: [PATCH 2/3] Suppress "not included in any toctree warnings" for TODO pages. Signed-off-by: Phillip Boushy --- docs/about/features_index/pynative.rst | 5 +++++ .../overview.how_can_intel_protect_federated_learning.rst | 5 +++++ docs/about/overview.what_is_intel_federated_learning.rst | 5 +++++ docs/developer_guide/running_the_federation.singularity.rst | 5 +++++ docs/get_started/install.singularity.rst | 5 +++++ 5 files changed, 25 insertions(+) diff --git a/docs/about/features_index/pynative.rst b/docs/about/features_index/pynative.rst index 7106af305d..83d4143cf8 100644 --- a/docs/about/features_index/pynative.rst +++ b/docs/about/features_index/pynative.rst @@ -1,6 +1,11 @@ .. # Copyright (C) 2020-2023 Intel Corporation .. # SPDX-License-Identifier: Apache-2.0 +.. this page is not be included yet, so it's marked as an orphan. +.. Remove the below line when you're ready to publish this page. + +:orphan: + ================= Python Native API ================= diff --git a/docs/about/overview.how_can_intel_protect_federated_learning.rst b/docs/about/overview.how_can_intel_protect_federated_learning.rst index 40afe5f75e..a74ac539f6 100644 --- a/docs/about/overview.how_can_intel_protect_federated_learning.rst +++ b/docs/about/overview.how_can_intel_protect_federated_learning.rst @@ -1,6 +1,11 @@ .. # Copyright (C) 2020-2023 Intel Corporation .. # SPDX-License-Identifier: Apache-2.0 +.. this page is not be included yet, so it's marked as an orphan. +.. Remove the below line when you're ready to publish this page. + +:orphan: + ***************************************** How Can Intel Protect Federated Learning? ***************************************** diff --git a/docs/about/overview.what_is_intel_federated_learning.rst b/docs/about/overview.what_is_intel_federated_learning.rst index 45932a71fc..d6b20d56cf 100644 --- a/docs/about/overview.what_is_intel_federated_learning.rst +++ b/docs/about/overview.what_is_intel_federated_learning.rst @@ -1,6 +1,11 @@ .. # Copyright (C) 2020-2023 Intel Corporation .. # SPDX-License-Identifier: Apache-2.0 +.. this page is not be included yet, so it's marked as an orphan. +.. Remove the below line when you're ready to publish this page. + +:orphan: + ********************************************* What is Intel\ :sup:`®` \ Federated Learning? ********************************************* diff --git a/docs/developer_guide/running_the_federation.singularity.rst b/docs/developer_guide/running_the_federation.singularity.rst index 9bda64548a..8034ef2eb2 100644 --- a/docs/developer_guide/running_the_federation.singularity.rst +++ b/docs/developer_guide/running_the_federation.singularity.rst @@ -1,6 +1,11 @@ .. # Copyright (C) 2020-2023 Intel Corporation .. # SPDX-License-Identifier: Apache-2.0 +.. this page is not be included yet, so it's marked as an orphan. +.. Remove the below line when you're ready to publish this page. + +:orphan: + .. _running_the_federation_singularity: Running on Singularity diff --git a/docs/get_started/install.singularity.rst b/docs/get_started/install.singularity.rst index 402dec789b..a90d56b6d0 100644 --- a/docs/get_started/install.singularity.rst +++ b/docs/get_started/install.singularity.rst @@ -1,6 +1,11 @@ .. # Copyright (C) 2020-2023 Intel Corporation .. # SPDX-License-Identifier: Apache-2.0 +.. this page is not be included yet, so it's marked as an orphan. +.. Remove the below line when you're ready to publish this page. + +:orphan: + .. _install_singularity: Singularity Installation From 7f31a17831e944e8837738428d5a41cf113f7f28 Mon Sep 17 00:00:00 2001 From: Phillip Boushy Date: Wed, 24 Apr 2024 15:57:51 -0600 Subject: [PATCH 3/3] Header lines must be as long as the header text Signed-off-by: Phillip Boushy --- docs/get_started/examples.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/get_started/examples.rst b/docs/get_started/examples.rst index f0672f3a38..b083455a75 100644 --- a/docs/get_started/examples.rst +++ b/docs/get_started/examples.rst @@ -39,9 +39,9 @@ See :ref:`interactive_tensorflow_mnist` examples/interactive_tensorflow_mnist -------------------------- +--------------------------------- Workflow Interface (Experimental) -------------------------- +--------------------------------- Formulate the experiment as a series of tasks, or a flow. See :ref:`workflowinterface_pytorch_mnist`