-
Notifications
You must be signed in to change notification settings - Fork 212
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
manuelhsantana
changed the title
Update Docstrings api for documentation (issue #893)
[WIP] Update Docstrings api for documentation (issue #893)
Jan 3, 2024
* 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]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[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: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: manuelhsantana <[email protected]>
Signed-off-by: Shah, Karan <[email protected]> Signed-off-by: manuelhsantana <[email protected]>
…/openfl into docstrings_API
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
The updated docstrings provide a more detailed explanation of these components, enhancing the user's understanding of their functions and roles within the OpenFL.
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.