vision icon indicating copy to clipboard operation
vision copied to clipboard

`interpolation` parameter of `AugMix()` wrongly explains `Default is InterpolationMode.NEAREST` instead of `InterpolationMode.BILINEAR`

Open hyperkai opened this issue 8 months ago • 2 comments

📚 The doc issue

According to the source code of AugMix(), the default type of interpolation parameter is BILINEAR as shown below:

def __init__(
        self,
        severity: int = 3,
        mixture_width: int = 3,
        chain_depth: int = -1,
        alpha: float = 1.0,
        all_ops: bool = True,
        interpolation: Union[InterpolationMode, int] = InterpolationMode.BILINEAR,
        fill: Union[_FillType, dict[Union[type, str], _FillType]] = None,
    ) -> None:
    ...

But interpolation parameter wrongly explains Default is InterpolationMode.NEAREST instead of InterpolationMode.BILINEAR as shown below:

Parameters: ...

  • interpolation (InterpolationMode, optional) – ... Default is InterpolationMode.NEAREST. ...

Suggest a potential alternative/fix

So it should be as shown below:

Parameters: ...

  • interpolation (InterpolationMode, optional) – ... Default is InterpolationMode.BILINEAR. ...

hyperkai avatar May 16 '25 14:05 hyperkai

Hey @hyperkai, thank you for opening this issue. After reviewing the details, I suggest we consolidate the discussion with #9065, as it appears to be closely related.

AntoineSimoulin avatar May 21 '25 13:05 AntoineSimoulin

Happy to consider a PR to fix the docs @hyperkai

NicolasHug avatar May 29 '25 11:05 NicolasHug