Skip to content

[Relax] Make ShapeType ndim parameter mandatory#18814

Merged
mshr-h merged 1 commit intoapache:mainfrom
guan404ming:refactor/remove-shapetype-ndim-default
Feb 24, 2026
Merged

[Relax] Make ShapeType ndim parameter mandatory#18814
mshr-h merged 1 commit intoapache:mainfrom
guan404ming:refactor/remove-shapetype-ndim-default

Conversation

@guan404ming
Copy link
Member

Why

Forces callers to be explicit about whether they want unknown ndim (-1) or a specific value. Prevents accidentally creating an unknown-ndim ShapeType when the caller intended to pass a concrete dimension, catching bugs at the call site rather than silently propagating unknown shapes.

How

  • Remove default ndim from C++ and Python ShapeType constructors
  • Update tests

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @guan404ming, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enforces explicit ndim parameter passing for ShapeType constructors in both C++ and Python. This change aims to prevent unintended creation of ShapeType instances with unknown dimensions by requiring callers to specify ndim, thereby improving type safety and catching potential bugs earlier in the development cycle.

Highlights

  • C++ ShapeType Constructor Update: The ndim parameter in the ShapeType constructor in include/tvm/relax/type.h no longer has a default value, making it a mandatory argument.
  • Python ShapeType Constructor Update: The ndim parameter in the ShapeType constructor in python/tvm/relax/ty.py no longer has a default value, making it a mandatory argument.
  • Test Case Adjustments: Existing test cases in test_ast_printer.py and test_struct_info.py were updated to explicitly pass the ndim argument when creating ShapeType instances, aligning with the new mandatory parameter.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • include/tvm/relax/type.h
    • Removed the default value for the ndim parameter in the ShapeType constructor.
  • python/tvm/relax/ty.py
    • Removed the default value for the ndim parameter in the ShapeType constructor.
  • tests/python/relax/test_ast_printer.py
    • Updated ShapeType instantiations to explicitly provide the ndim argument.
    • Modified TupleType creation to explicitly pass ndim=-1 to ShapeType.
  • tests/python/relax/test_struct_info.py
    • Adjusted ShapeType instantiations to explicitly pass ndim=-1.
Activity
  • No specific activity (comments, reviews, or progress updates) was provided in the context for this pull request.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

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

The pull request successfully makes the ndim parameter mandatory for the ShapeType constructor in both C++ and Python. This is a positive change that prevents accidental creation of unknown-rank shapes and improves code clarity. All relevant tests have been updated to reflect this change. I have one minor suggestion regarding the Python docstring to ensure it remains consistent with the updated signature.


# TODO(relax-team): consider make ndim mandatory
def __init__(self, ndim: int = -1, span: Span = None) -> None:
def __init__(self, ndim: int, span: Span = None) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The ndim parameter is now mandatory in the constructor. However, the class docstring (at line 34, just above this hunk) still describes ndim as Optional[int]. Please update the docstring to int to maintain consistency with the implementation.

Signed-off-by: Guan-Ming Chiu <guanmingchiu@gmail.com>
@guan404ming guan404ming force-pushed the refactor/remove-shapetype-ndim-default branch from 8db40bc to ce46de7 Compare February 23, 2026 18:32
@guan404ming guan404ming changed the title [RELAX] Make ShapeType ndim parameter mandatory [Relax] Make ShapeType ndim parameter mandatory Feb 23, 2026
@guan404ming guan404ming marked this pull request as ready for review February 24, 2026 04:15
@guan404ming
Copy link
Member Author

cc @tlopex @mshr-h

@mshr-h mshr-h merged commit 4fad6fc into apache:main Feb 24, 2026
12 checks passed
@guan404ming guan404ming deleted the refactor/remove-shapetype-ndim-default branch February 24, 2026 16:02
@guan404ming
Copy link
Member Author

Thanks.

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.

2 participants