Fix stale retail/healthcare recipe references and placeholder package metadata - #15
Anilreddy2309 wants to merge 2 commits into
Conversation
… metadata
Two doc/metadata drift issues found while reviewing the codebase:
1. nvflow/cli/main.py's --recipe help text and nvflow/core/stage_registry.py's
register()/class docstrings referenced "retail" and "healthcare" as
example recipes. Only finance, example, and multimodal recipes exist
anywhere in the codebase -- retail/healthcare appear to be leftover
placeholder names from before the repo's public release. Updated the
examples to reference real recipes.
2. pyproject.toml shipped an unfilled template placeholder
(authors = [{name = "Your Team", email = "team@example.com"}]) in the
public release. Replaced with "NVIDIA Corporation" -- happy to adjust
to a specific team alias/email if maintainers prefer one.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: Anil Balireddy <anilbalireddi@gmail.com>
sgharghabi
left a comment
There was a problem hiding this comment.
Thanks for the fix, it looks good to me.
Would you please also add the fix of sdg_basic to sdg_simple?
Per review feedback: sdg_basic isn't a real workflow (same class of issue as the retail/healthcare recipe names this PR already fixes). Replaced with sdg_simple, the example recipe's actual registered workflow. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Signed-off-by: Anil Balireddy <anilbalireddi@gmail.com>
|
Fixed — pushed a commit changing Separately, while looking at that line I noticed |
There was a problem hiding this comment.
Let's keep that as a separate PR.
The current code changed sounds good!
cc @psgundecha-nv for the final approval
Summary
Two small doc/metadata drift issues found while reviewing the codebase:
Non-existent example recipes in docs/help text.
nvflow/cli/main.py's--recipeoption help text andnvflow/core/stage_registry.py'sregister()/class docstrings referenceretailandhealthcareas example recipes. Onlyfinance,example, andmultimodalrecipes exist anywhere in the codebase (confirmed via@StageRegistry.registercall sites) —retail/healthcarelook like leftover placeholder names from before the repo's public release. Updated the examples to real recipe names.Placeholder package metadata.
pyproject.tomlshippedauthors = [{name = "Your Team", email = "team@example.com"}]— an unfilled template placeholder in the public release. Replaced with"NVIDIA Corporation". Happy to adjust to a specific team alias/email if maintainers prefer one — I didn't want to guess at an internal contact.Test plan
ruff check/ruff format --checkpasspyproject.tomlstill parses as valid TOML after the editpytest tests/suite passes (339 passed, 3 pre-existing skips) — no code behavior changed🤖 Generated with Claude Code