-
Notifications
You must be signed in to change notification settings - Fork 36
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
Docs/SK-901 | MonAI README #644
Conversation
…so update the README file.
fix incorrect instruction regarding scaling up to 3 clients.
batch_size = client_settings["batch_size"] | ||
max_epochs = client_settings["local_epochs"] | ||
num_workers = client_settings["num_workers"] | ||
split_index = client_settings["split_index"] | ||
split_index = os.environ.get("FEDN_DATA_SPLIT_INDEX") #client_settings["split_index"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
@@ -45,7 +45,7 @@ def validate(in_model_path, out_json_path, data_path=None, client_settings_path= | |||
|
|||
num_workers = client_settings["num_workers"] | |||
batch_size = client_settings["batch_size"] | |||
split_index = client_settings["split_index"] | |||
split_index = os.environ.get("FEDN_DATA_SPLIT_INDEX") # client_settings["split_index"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done.
examples/monai-2D-mednist/README.md
Outdated
# Getting Started | ||
|
||
|
||
For a step-by-step example guide, click [here](https://github.com/scaleoutsystems/fedn/tree/master/examples/monai-2D-mednist>). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this link will get you to the same README (this one)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In FEDn MonAI example directory, we have "README.rst," which stays the same. The MonAI tutorials repository will contain "README_MonAI_Tutorial.md" in the tutorials/federated_learning/FEDn/ directory as "README.md." This file (README.md) will point to README.rst in the MonAI example directory.
examples/monai-2D-mednist/README.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are there 1 .md and 2 .rst files?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will remove .rst from the branch as in MonAI tutorials repo, they have all .md files.
…ials repository. In their repo, README files are in .md format.
…ials repository. In their repo, README files are in .md format.
Description
This branch mainly introduces a new README file to integrate this example into the MonAI tutorial repository. To enhance user understanding, we simplified the get and load data functions. This involved code modifications and more extensive updates to the README document. Now, I have fixed the code checks as well.