Skip to content

Conversation

@nvkevlu
Copy link
Collaborator

@nvkevlu nvkevlu commented Dec 31, 2025

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

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Quick tests passed locally by running ./runtest.sh.
  • In-line docstrings updated.
  • Documentation updated.

Copilot AI review requested due to automatic review settings December 31, 2025 18:08
Copy link
Contributor

Copilot AI left a 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-sag to hello-numpy across 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-apps
Copy link
Contributor

greptile-apps bot commented Dec 31, 2025

Greptile Summary

This PR comprehensively removes all mentions of the deprecated "SAG" (Scatter and Gather) example and updates documentation to reference the current hello-numpy example. The changes span 23 files including documentation, example configurations, and tutorial notebooks.

Key Changes:

  • Deleted obsolete documentation files (hello_scatter_and_gather.rst, hello_fedavg_numpy.rst)
  • Enhanced hello_numpy.rst with detailed Client API workflow explanation and comprehensive version history
  • Updated all references from hello-numpy-sag to hello-numpy across documentation, examples, and scripts
  • Modified setup scripts in advanced examples (federated-policies, job-level-authorization) to reference the correct example directory
  • Updated tutorial notebooks and job metadata files with consistent naming

The changes are purely documentation and configuration updates with no functional code changes (except minor whitespace cleanup in job_def.py). All references are internally consistent and link correctly to existing examples.

Confidence Score: 5/5

  • This PR is safe to merge with no risk - it contains only documentation and configuration updates.
  • The changes are purely documentation updates with no functional code modifications. All references have been systematically updated, deleted files are no longer needed, and the new documentation is comprehensive and well-structured. The scope is well-defined and the changes are internally consistent.
  • No files require special attention - all changes are straightforward documentation updates

Important Files Changed

Filename Overview
docs/examples/hello_numpy.rst Enhanced documentation with detailed Client API workflow explanation and added version history section linking to previous SAG and FedAvg versions. Comprehensive and well-structured.
docs/examples/hello_scatter_and_gather.rst File deleted as part of SAG removal - appropriate since this example no longer exists.
docs/examples/hello_fedavg_numpy.rst File deleted as part of consolidation - content merged into hello_numpy.rst.
docs/programming_guide/migrating_to_flare_api.rst Updated all code examples and output samples to reference hello-numpy instead of hello-numpy-sag. Whitespace cleanup included.
examples/README.md Updated main examples README with new table entry for Hello NumPy. Link and description correctly reference the updated example.
examples/advanced/federated-policies/setup.sh Updated setup script to copy from hello-numpy directory. Path change is correct and consistent.
examples/advanced/job-level-authorization/setup.sh Updated setup script to copy from hello-numpy directory. Path correctly changed from hello-numpy-sag.

Sequence Diagram

sequenceDiagram
    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
Loading

@nvkevlu nvkevlu marked this pull request as draft December 31, 2025 18:47
@nvkevlu nvkevlu marked this pull request as ready for review December 31, 2025 20:08
@nvkevlu
Copy link
Collaborator Author

nvkevlu commented Dec 31, 2025

/build

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additional Comments (2)

  1. examples/advanced/federated-policies/README.rst, line 101 (link)

    logic: Reference to numpy-sag should be updated to numpy or hello-numpy for 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!

  2. .github/DISCUSSION_TEMPLATE/q-a.yml, line 38-40 (link)

    logic: hello-numpy-sag references should be updated to hello-numpy to match the current example name.

17 files reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

@nvkevlu
Copy link
Collaborator Author

nvkevlu commented Dec 31, 2025

/build

@chesterxgchen
Copy link
Collaborator

@nvkevlu please address the comments

@nvkevlu
Copy link
Collaborator Author

nvkevlu commented Jan 5, 2026

/build

@nvkevlu nvkevlu merged commit 06fb048 into NVIDIA:main Jan 6, 2026
21 checks passed
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.

3 participants