docs(cts): correct sink_clustering_size auto-selection description#10603
Open
Avi71 wants to merge 3 commits into
Open
docs(cts): correct sink_clustering_size auto-selection description#10603Avi71 wants to merge 3 commits into
Avi71 wants to merge 3 commits into
Conversation
When -sink_clustering_size is not set, clustering is based on buffer max cap, not a fixed choice from {10, 20, 30}. The cluster size is PDK-dependent and may be less than 10.
Fixes The-OpenROAD-Project#10602
Signed-off-by: Avi71 <33029441+Avi71@users.noreply.github.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in src/cts/README.md to clarify the default behavior of the -sink_clustering_size parameter when it is not specified. The reviewer noted that the implementation actually uses the sink buffer's maximum fanout rather than its maximum capacitance to determine the default clustering size, and suggested correcting the documentation to reflect this.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Welcome to OpenROAD! Thanks for opening your first PR.
Before we review:
- Contribution Guide: https://openroad.readthedocs.io/en/latest/contrib/contributing.html
- Build Instructions: https://openroad.readthedocs.io/en/latest/contrib/BuildWithCMake.html
Please ensure:
- CI passes
- Code is properly formatted
- Tests are included where applicable
A maintainer will review shortly!
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Avi71 <33029441+Avi71@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Avi71 <33029441+Avi71@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated the src/cts/README.md. When -sink_clustering_size is not set, clustering is based on buffer max cap, not a fixed choice from {10, 20, 30}. The cluster size is PDK-dependent and may be less than 10.
Fixes #10602
Type of Change
Impact
The impact of this documentation inaccuracy is that users designing CTS parameter sweeps will miss the actual operating range of the auto-selection algorithm. For example, we initially designed our sweep around {10, 20, 30} based on the README, only to discover the auto-selected value was 8, outside the documented range entirely. A correct description of the formula would allow users to make more informed decisions about which cluster sizes to explore relative to the auto-selected value for their specific design.