-
Notifications
You must be signed in to change notification settings - Fork 228
Comprehensively remove mention of SAG #3924
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
Conversation
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.
Pull request overview
This PR removes all references to "SAG" (Scatter and Gather) from the codebase, updating example names, paths, and documentation to reflect that the hello-numpy-sag example has been consolidated into the hello-numpy example.
Key Changes:
- Updated all references from
hello-numpy-sagtohello-numpyacross documentation and examples - Cleaned up trailing whitespace in documentation files
- Updated command examples, file paths, and configuration references
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| nvflare/apis/job_def.py | Updated deployment map example in docstring to use hello-numpy naming |
| examples/tutorials/logging.ipynb | Updated simulator commands and workspace paths from hello-numpy-sag to hello-numpy |
| examples/tutorials/flare_simulator.ipynb | Updated job folder paths and workspace references in tutorial |
| examples/tutorials/flare_api.ipynb | Updated job submission paths and example job references |
| examples/advanced/keycloak-site-authentication/README.md | Updated job references and removed trailing spaces in commands |
| examples/advanced/job-level-authorization/setup.sh | Updated source path for copying hello-numpy example |
| examples/advanced/job-level-authorization/jobs/job1/meta.json | Updated job name from hello-numpy-sag to hello-numpy |
| examples/advanced/job-level-authorization/README.md | Updated job description and removed trailing blank lines |
| examples/advanced/federated-policies/setup.sh | Updated source path for copying hello-numpy example |
| docs/user_guide/nvflare_cli/poc_command.rst | Updated submit_job examples and removed trailing spaces |
| docs/user_guide/nvflare_cli/fl_simulator.rst | Updated simulator command examples and removed trailing spaces throughout |
| docs/user_guide/data_scientist_guide/poc.rst | Updated job submit command example |
| docs/user_guide/core_concepts/job.rst | Updated deploy_map example in job documentation and removed trailing spaces |
| docs/user_guide/admin_guide/configurations/logging_configuration.rst | Updated simulator and job API examples |
| docs/programming_guide/migrating_to_flare_api.rst | Updated job paths and app_name references, removed trailing spaces |
| docs/programming_guide/controllers/scatter_and_gather_workflow.rst | Updated example reference link and description |
| docs/examples/hello_scatter_and_gather.rst | Comprehensive updates to hello-numpy references and note about Recipe API |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Greptile SummaryThis PR comprehensively removes all mentions of the deprecated "SAG" (Scatter and Gather) example and updates documentation to reference the current Key Changes:
The changes are purely documentation and configuration updates with no functional code changes (except minor whitespace cleanup in Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User as Documentation User
participant Docs as Documentation Files
participant Examples as Example Scripts
participant Tutorials as Tutorial Notebooks
Note over User,Tutorials: PR Updates: SAG → hello-numpy Migration
User->>Docs: Read documentation
Docs-->>User: References to hello-numpy (was hello-numpy-sag)
User->>Examples: Run setup scripts
Examples->>Examples: Copy from hello-world/hello-numpy
Note over Examples: Updated paths in:<br/>federated-policies/setup.sh<br/>job-level-authorization/setup.sh
Examples-->>User: Jobs configured with hello-numpy
User->>Tutorials: Follow tutorials
Tutorials->>Examples: Reference hello-numpy paths
Note over Tutorials: Updated notebooks:<br/>flare_api.ipynb<br/>flare_simulator.ipynb<br/>logging.ipynb
Tutorials-->>User: Consistent example references
User->>Docs: Check version history
Docs-->>User: Links to previous versions:<br/>- SAG (2.0-2.4)<br/>- FedAvg NumPy (2.5-2.6)<br/>- NumPy (current)
Note over User,Tutorials: All references now point to unified hello-numpy example
|
|
/build |
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.
Additional Comments (2)
-
examples/advanced/federated-policies/README.rst, line 101 (link)logic: Reference to
numpy-sagshould be updated tonumpyorhello-numpyfor consistency with the PR's goal.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
-
.github/DISCUSSION_TEMPLATE/q-a.yml, line 38-40 (link)logic:
hello-numpy-sagreferences should be updated tohello-numpyto match the current example name.
17 files reviewed, 2 comments
|
/build |
|
@nvkevlu please address the comments |
|
/build |
Comprehensively remove mention of SAG and update instructions for running jobs.
Description
Comprehensively remove mention of SAG since the example no longer exists, and update instructions for running jobs.
Types of changes
./runtest.sh.