[Feature] Rename the confusing argument 'format_shape' in ActionDataPreprocessor
What is the problem this feature will solve?
The argument name format_shape in ActionDataPreprocessor can be misleading:
https://github.com/open-mmlab/mmaction2/blob/4d6c93474730cad2f25e51109adcf96824efc7a3/mmaction/models/data_preprocessors/data_preprocessor.py#L30-L37
This name is identical to Transforms.FormatShape:
https://github.com/open-mmlab/mmaction2/blob/4d6c93474730cad2f25e51109adcf96824efc7a3/mmaction/datasets/transforms/formatting.py#L200-L204
However, the context and function of these two are distinctly different. The Transforms.FormatShape is aptly named as it actively formats the shape of data. In contrast, ActionDataPreprocessor.format_shape is essentially a descriptor indicating the required shape format (i.e., 'NCHW') for the data to be correctly processed by the preprocessor.
What is the feature?
- (Option 1) A more descriptive name than
ActionDataPreprocessor.format_shape, such asexpected_shape_formatorshape_formatmight better convey its purpose and reduce potential confusion. - (Option 2) Deprecating the
Transform.FormatShapeand making theActionDataPreprocessordo the shape formatting job.
What alternatives have you considered?
No response