Merge pull request #423 from VectorInstitute/dbe/some_cleanup_docs_spelling_dependencies

Some Docs Cleanup, Spelling Corrections, Dependency simplification.

Author: emersodb

CONTRIBUTING.MD

@@ -23,7 +23,7 @@ The easiest way to create and activate a virtual environment is by using the [vi
 python -m venv <ENV_PATH>
 source "ENV_PATH/bin/activate"
 pip install --upgrade pip poetry
-poetry install --with "dev, dev-local, test, codestyle"
+poetry install --with "dev, test, codestyle"
 ```
 
 Note that the with command is installing all libraries required for the full development workflow. See the `pyproject.toml` file for additional details as to what is installed with each of these options.

README.md

@@ -198,16 +198,16 @@ FENDA+Ditto
 This is a combination of two state-of-the-art approaches above: FENDA-FL and Ditto. The idea is to merge the two approaches to yield a "best of both" set of modeling with the flexibility of FENDA-FL for local adaptation and the global-model constrained optimization of Ditto.
 </td>
 </tr>
-</table>
+<tr>
+<td>
 
 [GPFL](https://arxiv.org/pdf/2308.10279)
 </td>
 <td>
 GPFL trains a global feature extractor and a local classifier head. A global mapping model transforms the feature extractor’s output into both global and personalized feature representations. Global feature representations are trained to be close to their respective class embeddings stored in a global lookup table, whereas personalized feature embeddings are learned for prediction.
 </td>
 </tr>
-<tr>
-<td>
+</table>
 
 More approaches are being implemented as they are prioritized. However, the library also provides significant flexibility to implement strategies of your own.
 
@@ -308,7 +308,7 @@ We hope that the library will be useful to both FL practitioners and researchers
 As examples (the version may be out of date)
 
 ```
-# APA Sytle
+# APA Style
 Emerson, D.B., Jewell, J., Ayromlou, S., Carere, S., Tavakoli, F., Zhang, Y., Lotif, M., Fajardo, V. A., & Krishnan, A. FL4Health (Version 0.3.0) [Computer software]. https://doi.org/10.5281/zenodo.1234
 ```
 

docs/source/contributing.md

@@ -23,7 +23,7 @@ The easiest way to create and activate a virtual environment is by using the [vi
 python -m venv <ENV_PATH>
 source "ENV_PATH/bin/activate"
 pip install --upgrade pip poetry
-poetry install --with "dev, dev-local, test, codestyle"
+poetry install --with "dev, test, codestyle"
 ```
 
 Note that the with command is installing all libraries required for the full development workflow. See the `pyproject.toml` file for additional details as to what is installed with each of these options.

docs/source/reference/api/fl4health.checkpointing.rst

@@ -16,3 +16,4 @@ Submodules
    fl4health.checkpointing.client_module
    fl4health.checkpointing.opacus_checkpointer
    fl4health.checkpointing.server_module
+   fl4health.checkpointing.state_checkpointer

docs/source/reference/api/fl4health.checkpointing.state_checkpointer.rst

@@ -0,0 +1,7 @@
+fl4health.checkpointing.state\_checkpointer module
+==================================================
+
+.. automodule:: fl4health.checkpointing.state_checkpointer
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/api/fl4health.clients.fedbn_client.rst

@@ -0,0 +1,7 @@
+fl4health.clients.fedbn\_client module
+======================================
+
+.. automodule:: fl4health.clients.fedbn_client
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/api/fl4health.clients.flexible.base.rst

@@ -0,0 +1,7 @@
+fl4health.clients.flexible.base module
+======================================
+
+.. automodule:: fl4health.clients.flexible.base
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reference/api/fl4health.clients.flexible.rst

@@ -0,0 +1,15 @@
+fl4health.clients.flexible package
+==================================
+
+.. automodule:: fl4health.clients.flexible
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fl4health.clients.flexible.base

docs/source/reference/api/fl4health.clients.rst

@@ -13,6 +13,7 @@ Subpackages
    :maxdepth: 4
 
    fl4health.clients.deep_mmd_clients
+   fl4health.clients.flexible
    fl4health.clients.mkmmd_clients
 
 Submodules
@@ -31,6 +32,7 @@ Submodules
    fl4health.clients.evaluate_client
    fl4health.clients.fed_pca_client
    fl4health.clients.fed_prox_client
+   fl4health.clients.fedbn_client
    fl4health.clients.fedper_client
    fl4health.clients.fedpm_client
    fl4health.clients.fedrep_client

docs/source/reference/api/fl4health.metrics.base_metrics.rst

@@ -0,0 +1,7 @@
+fl4health.metrics.base\_metrics module
+======================================
+
+.. automodule:: fl4health.metrics.base_metrics
+   :members:
+   :undoc-members:
+   :show-inheritance: