Skip to content

Conversation

@tardis-key
Copy link
Contributor

What does this PR do?

Add concise overview of what this PR aims to achieve or accomplish. Reference related GitHub issues and PRs that help with the review.

image

Sample
image

Checklist Before Starting

  • Search for similar PRs. Paste at least one query link here: ...
  • Format the PR title as [{modules}] {type}: {description} (This will be checked by the CI)
    • {modules} include fsdp, megatron, sglang, vllm, rollout, trainer, ci, training_utils, recipe, hardware, deployment, ray, worker, single_controller, misc, perf, model, algo, env, tool, ckpt, doc, data, cfg, reward
    • If this PR involves multiple modules, separate them with , like [megatron, fsdp, doc]
    • {type} is in feat, fix, refactor, chore, test
    • If this PR breaks any API (CLI arguments, config, function signature, etc.), add [BREAKING] to the beginning of the title.
    • Example: [BREAKING][fsdp, megatron] feat: dynamic batching

Test

For changes that can not be tested by CI (e.g., algorithm implementation, new model support), validate by experiment(s) and show results like training curve plots, evaluation results, etc.

API and Usage Example

Demonstrate how the API changes if any, and provide usage example(s) if possible.

# Add code snippet or script demonstrating how to use this

Design & Code Changes

Demonstrate the high-level design if this PR is complex, and list the specific changes.

Checklist Before Submitting

Important

Please check all the following items before requesting a review, otherwise the reviewer might deprioritize this PR for review.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new tool for scheduling analysis based on profiling data, setting up a flexible framework with registries for different data parsers and visualizers. I've identified a few critical and high-severity issues that would prevent the tool from running correctly, including a bug in a class constructor and incorrect function implementations/registrations. Addressing these will make the tool functional as a baseline for further development.

Comment on lines +5 to +6
def __init__():
pass
Copy link
Contributor

Choose a reason for hiding this comment

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

critical

The __init__ method in ClusterProfilerData is missing the self parameter. This will cause a TypeError when an instance of the class is created.

Suggested change
def __init__():
pass
def __init__(self):
pass

Comment on lines +38 to +45
def cluster_parser_mstx(input_path: str, output_path: str, config: DictConfig) -> ClusterProfilerData:
print("in mstx")
pass

@register_cluster_parser("nvtx")
def cluster_parser_nvtx(input_path: str, output_path: str, config: DictConfig) -> ClusterProfilerData:
print("in nvtx")
pass No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

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

high

The placeholder functions cluster_parser_mstx and cluster_parser_nvtx are type-hinted to return ClusterProfilerData, but they implicitly return None. This will lead to a runtime error in cluster_analysis.py when the None value is passed to the visualizer. These functions should return an instance of ClusterProfilerData.

Suggested change
def cluster_parser_mstx(input_path: str, output_path: str, config: DictConfig) -> ClusterProfilerData:
print("in mstx")
pass
@register_cluster_parser("nvtx")
def cluster_parser_nvtx(input_path: str, output_path: str, config: DictConfig) -> ClusterProfilerData:
print("in nvtx")
pass
def cluster_parser_mstx(input_path: str, output_path: str, config: DictConfig) -> ClusterProfilerData:
print("in mstx")
return ClusterProfilerData()
@register_cluster_parser("nvtx")
def cluster_parser_nvtx(input_path: str, output_path: str, config: DictConfig) -> ClusterProfilerData:
print("in nvtx")
return ClusterProfilerData()

)
return CLUSTER_VISUALIZER_REGISTRY[fn_name]

@register_cluster_visualizer("mstx")
Copy link
Contributor

Choose a reason for hiding this comment

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

high

The cluster_visualizer_html function is incorrectly registered with the name "mstx". It should be registered as "html" to match its purpose and the default --vis-type argument in cluster_analysis.py. This mismatch will cause a ValueError at runtime.

Suggested change
@register_cluster_visualizer("mstx")
@register_cluster_visualizer("html")

@tardis-key tardis-key marked this pull request as draft December 31, 2025 02:44
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.

1 participant