Doc and config changes from 2.7 branch

[chesterxgchen]

Cherry picks

689315c - simplify the tests and doc string
2f4f2ae - fix a few mistakes
32d4880 - Expand recipe spec to add_server_config() and add_client_config() functions...
3abd08a - [2.7] Update product feature docs [skip ci] (#4018)

A few sentences describing the changes proposed in this pull request.

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.

[greptile-apps]

Greptile Overview

Greptile Summary

This PR cherry-picks changes from the 2.7 branch, primarily enhancing the Recipe API with configuration methods and script validation capabilities.

Key Changes:

• Added add_server_config() and add_client_config() methods to Recipe class for top-level configuration management with proper type validation
• Introduced _collect_non_local_scripts() utility function to identify absolute script paths that don't exist locally (for production environments)
• Enhanced FedApp._add_resource() to accept absolute paths for pre-installed production scripts
• Implemented environment-specific script validation: SimEnv/PocEnv raise errors for non-local scripts, while ProdEnv logs warnings
• Added comprehensive test coverage for new functionality
• Updated documentation including new release notes for v2.7.2

Review Findings:

• The previous review thread correctly identified that the import was initially missing, but this has been resolved - _collect_non_local_scripts now exists in nvflare/recipe/utils.py:377
• All code changes follow good practices with proper error handling and type validation
• Tests are thorough and cover edge cases including the production scenario of pre-installed scripts

Confidence Score: 5/5

• This PR is safe to merge with no significant risks
• This is a clean cherry-pick from the 2.7 branch containing well-tested enhancements. The code includes proper type validation, comprehensive test coverage, and follows existing patterns. The previously reported import issue has been resolved. All changes are backward-compatible additions to the Recipe API
• No files require special attention

Important Files Changed

Filename	Overview
nvflare/recipe/spec.py	Added add_server_config() and add_client_config() methods with proper type validation, plus enhanced docstring for process_env()
nvflare/recipe/utils.py	Added _collect_non_local_scripts() utility function for script validation, fixed recipe name handling in error message
tests/unit_test/recipe/spec_test.py	New comprehensive test file covering _collect_non_local_scripts(), environment validation, and new config methods
nvflare/job_config/api.py	Enhanced _add_resource() to accept absolute paths that don't exist locally (for pre-installed production scripts)
nvflare/recipe/sim_env.py	Added script validation in deploy() using _collect_non_local_scripts() - raises error for non-local scripts
nvflare/recipe/prod_env.py	Added warning logs for non-local scripts in deploy() (assumes pre-installed on production systems)
nvflare/recipe/poc_env.py	Added script validation in deploy() using _collect_non_local_scripts() - raises error for non-local scripts
tests/unit_test/job_config/fed_job_test.py	Added tests for FedApp._add_resource() covering various scenarios including absolute paths that don't exist locally

Sequence Diagram

sequenceDiagram
    participant User
    participant Recipe
    participant FedJob
    participant ExecEnv
    participant Utils
    
    User->>Recipe: add_server_config(config)
    Recipe->>Recipe: validate isinstance(config, dict)
    alt Invalid type
        Recipe-->>User: raise TypeError
    end
    Recipe->>FedJob: to_server(config)
    
    User->>Recipe: add_client_config(config, clients)
    Recipe->>Recipe: validate isinstance(config, dict)
    alt Invalid type
        Recipe-->>User: raise TypeError
    end
    alt clients is None
        Recipe->>FedJob: to_clients(config)
    else specific clients
        loop for each client
            Recipe->>FedJob: to(config, client)
        end
    end
    
    User->>Recipe: execute(env)
    Recipe->>ExecEnv: deploy(job)
    ExecEnv->>Utils: _collect_non_local_scripts(job)
    Utils->>Utils: check job._deploy_map for absolute paths
    Utils-->>ExecEnv: return non_local_scripts[]
    
    alt SimEnv/PocEnv
        alt non_local_scripts not empty
            ExecEnv-->>User: raise ValueError("scripts must exist locally")
        end
    else ProdEnv
        loop for each non_local_script
            ExecEnv->>ExecEnv: logger.warning("assuming pre-installed")
        end
    end
    
    ExecEnv->>ExecEnv: proceed with deployment
    ExecEnv-->>User: return job_id

Loading

[greptile-apps]

_{1 file reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

_{No files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[chesterxgchen]

/build

[greptile-apps]

_{No files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[chesterxgchen]

/Build

[nvkevlu]

/build

[greptile-apps]

_{No files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}

[holgerroth]

LGTM