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

Update Docstrings api for documentation (issue #893) #900

Closed
wants to merge 173 commits into from

Conversation

manuelhsantana
Copy link
Collaborator

@manuelhsantana manuelhsantana commented Nov 30, 2023

This PR introduces a comprehensive update to our documentation with the addition of an OpenFL API section. This section provides detailed information about the various components of the OpenFL, enhancing the overall understanding and usability of the platform.

Key updates in this PR include:

  1. OpenFL API Section Addition: A dedicated section for OpenFL API has been added to the documentation. This section provides a valuable resource for both new and existing users.
  2. Updated Docstrings: We have revised and updated the docstrings throughout the documentation to ensure clarity and consistency. These docstrings now provide more accurate and detailed descriptions of the functions and methods, facilitating better understanding and usage.
  3. The docstrings for the following modules have been updated:
  • Component
  • Cryptography
  • Databases (TensorDB)
  • Experimental
  • Federated
  • Interface
  • Native
  • Pipelines
  • Plugins
  • Protocols
  • Transport
  • Utilities

The updated docstrings provide a more detailed explanation of these components, enhancing the user's understanding of their functions and roles within the OpenFL.

  1. Addition of Indexes and Tables: To improve the navigability and accessibility of the documentation, we have added indexes and tables where necessary. These additions will make it easier for users to find the information they need.

This PR is a significant step towards improving the quality and comprehensibility of our documentation. We believe that these updates will greatly enhance the user experience and make it easier for users to understand and utilize OpenFL.

@manuelhsantana manuelhsantana changed the title Update Docstrings api for documentation (issue #893) [WIP] Update Docstrings api for documentation (issue #893) Jan 3, 2024
ishant162 and others added 29 commits July 9, 2024 18:33
* Updated private_attrs initialization & Added testcases to test the same

Signed-off-by: ishant162 <[email protected]>

* Fixed typo

Signed-off-by: ishant162 <[email protected]>

* Updated Workflow_Interface_101_MNIST.ipynb & workflowinterface.rst

Signed-off-by: ishant162 <[email protected]>

* Incorporated Internal review comments

Signed-off-by: ishant162 <[email protected]>

* Incorporated Internal review comments

Signed-off-by: Ishant Thakare <[email protected]>

* Experimental Aggregator based workflow: Updated private_attrs initialization and added testcases to test the same

Signed-off-by: Ishant Thakare <[email protected]>

* Fixed lint errors

Signed-off-by: Ishant Thakare <[email protected]>

* Bug fix: fx workspace create

Signed-off-by: Ishant Thakare <[email protected]>

* Workspace Export: Supports initialization of private attributes directly

Signed-off-by: Ishant Thakare <[email protected]>

* Fixed lint errors

Signed-off-by: Ishant Thakare <[email protected]>

* Incorporated Internal review comments

Signed-off-by: Ishant Thakare <[email protected]>

* Updated 101_torch_cnn_mnist private_attrs

Signed-off-by: Ishant Thakare <[email protected]>

* Updated workflow_interface tutorials 1001, 104_keras, 401_MNIST

Signed-off-by: Ishant Thakare <[email protected]>

* Incorporated Internal review comments

Signed-off-by: Ishant Thakare <[email protected]>

* Resolving merge conflicts

Signed-off-by: Ishant Thakare <[email protected]>

* Updated import

Signed-off-by: Ishant Thakare <[email protected]>

* Fixed typo & updated federated plan

Signed-off-by: Ishant Thakare <[email protected]>

* Updated aggregator import

Signed-off-by: Ishant Thakare <[email protected]>

* Update docs/about/features_index/workflowinterface.rst

Review comments incorporated.

Co-authored-by: Patrick Foley <[email protected]>
Signed-off-by: Parth Mandaliya <[email protected]>

* Update docs/about/features_index/workflowinterface.rst

Review comments incorporated.

Co-authored-by: Patrick Foley <[email protected]>
Signed-off-by: Parth Mandaliya <[email protected]>

* Update docs/about/features_index/workflowinterface.rst

Review comments incorporated.

Co-authored-by: Patrick Foley <[email protected]>
Signed-off-by: Parth Mandaliya <[email protected]>

---------

Signed-off-by: ishant162 <[email protected]>
Signed-off-by: Ishant Thakare <[email protected]>
Signed-off-by: Parth Mandaliya <[email protected]>
Co-authored-by: ParthMandaliya <[email protected]>
Co-authored-by: Patrick Foley <[email protected]>
…on_1 & Workflow_Interface_Vertical_FL (#991)

* updated participant names & added testcase to validate participant names

Signed-off-by: Ishant Thakare <[email protected]>

* Updated aggregator import

Signed-off-by: Ishant Thakare <[email protected]>

---------

Signed-off-by: Ishant Thakare <[email protected]>
* Remove need for aggregator to have dataset for model weight initialization

Signed-off-by: Patrick Foley <[email protected]>

* Remove extra print arguments

Signed-off-by: Patrick Foley <[email protected]>

* Address review comments

Signed-off-by: Patrick Foley <[email protected]>

* Remove extraneous print statement

Signed-off-by: Patrick Foley <[email protected]>

---------

Signed-off-by: Patrick Foley <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
* Use proper metric tree (WIP)

Signed-off-by: Shah, Karan <[email protected]>

* Change in a diff func

Signed-off-by: Shah, Karan <[email protected]>

* Reorder fields

Signed-off-by: Shah, Karan <[email protected]>

* Add collaborator_name at top level

* Cleanup

* Direct assignment

* More greppable messages

* Include round number within task metric

* Fix deprecation warning for non-writable arrays

* Revert metric structure for now, needs wider refactor instead

* [lint] Strip whitespace

---------

Signed-off-by: Shah, Karan <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
* Remove unused experimental protobuf utils

Signed-off-by: Patrick Foley <[email protected]>

* Remove lower name conversation from subset collaborators testcase

Signed-off-by: Patrick Foley <[email protected]>

---------

Signed-off-by: Patrick Foley <[email protected]>
Signed-off-by: Shah, Karan <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.