[Enhance] Complement type hint of get_model_complexity_info()

[sjiang95]

The type of inputs should be one of torch.Tensor, tuple[torch.Tensor, ...] and None.

Motivation

The type hint of arg inputs in get_model_complexity_info() should match class FlopAnalyzer

mmengine/mmengine/analysis/complexity_analysis.py

Line 121 in 5e1ed7a

inputs: Union[Tensor, Tuple[Tensor, ...]],

and class ActivationAnalyzer,

mmengine/mmengine/analysis/complexity_analysis.py

Line 192 in 5e1ed7a

inputs: Union[Tensor, Tuple[Tensor, ...]],

since the argument inputs is finally fed into these two classes.

Otherwise, a user may be confused about what if a custom model requires more than one tensors as inputs.

Modification

Change current type hint of inputs in get_model_complexity_info() from

Optional[torch.Tensor]

to

Union[torch.Tensor, Tuple[torch.Tensor, ...], None]

BC-breaking (Optional)

Not applicable.

Use cases (Optional)

Not applicable.

Checklist

• Pre-commit or other linting tools are used to fix the potential lint issues.
• The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
• If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
• The documentation has been modified accordingly, like docstring or example tutorials.

[zhouzaida]

Hi @sjiang95 , thanks for your contribution. Please resolve the conflicting files and fix the lint.

[sjiang95]

Hi @zhouzaida, thanks for your quick response.
It is ready to be reviewed now.

[zhouzaida]

Hi @zhouzaida, thanks for your quick response. It is ready to be reviewed now.

Hi @sjiang95, hanks for your contribution. I have approved and it can be merged after passing the CI.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@f76218a). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1064   +/-   ##
=======================================
  Coverage        ?   76.41%           
=======================================
  Files           ?      139           
  Lines           ?    11203           
  Branches        ?     2253           
=======================================
  Hits            ?     8561           
  Misses          ?     2280           
  Partials        ?      362           

Flag	Coverage Δ
unittests	76.41% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.