Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix sphinx build warnings #962

Merged
merged 3 commits into from
Apr 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/about/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <features_index/taskrunner.html>`_
For more info see :doc:`features_index/taskrunner`

.. toctree::
:hidden:
Expand All @@ -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 <features_index/interactive.html>`_
For more info see :doc:`features_index/interactive`

.. toctree::
:hidden:
Expand All @@ -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 <features_index/workflowinterface.html>`_
For more info see :doc:`features_index/workflowinterface`

.. toctree::
:hidden:
Expand Down Expand Up @@ -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 <features_index/fed_eval.html>`_
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:
Expand All @@ -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 <features_index/privacy_meter.html>`_
Quantitatively audit data privacy in statistical and machine learning algorithms. For more info see :doc:`features_index/privacy_meter`

.. toctree::
:hidden:
Expand Down
5 changes: 5 additions & 0 deletions docs/about/features_index/pynative.rst
Original file line number Diff line number Diff line change
@@ -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
=================
Expand Down
Original file line number Diff line number Diff line change
@@ -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?
*****************************************
Expand Down
5 changes: 5 additions & 0 deletions docs/about/overview.what_is_intel_federated_learning.rst
Original file line number Diff line number Diff line change
@@ -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?
*********************************************
Expand Down
9 changes: 4 additions & 5 deletions docs/about/releases.md
Original file line number Diff line number Diff line change
@@ -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**:
Expand All @@ -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)**
Expand Down Expand Up @@ -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`
\* Singularity supported via DockerHub integration: `singularity shell docker://openfl:latest`
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion docs/developer_guide/experimental_features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Experimental features are *not* ready for production. These features are under a
:maxdepth: 4
:hidden:

workflow_interface
../about/features_index/workflowinterface
5 changes: 5 additions & 0 deletions docs/developer_guide/running_the_federation.singularity.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/get_started/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
5 changes: 5 additions & 0 deletions docs/get_started/install.singularity.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading