transformers icon indicating copy to clipboard operation
transformers copied to clipboard

MaskFormerSwin shows as unsupported the index

Open joaocmd opened this issue 1 year ago • 4 comments

Hello, is there any reason why the MaskFormerSwin shows as unsupported on the index page?

https://github.com/huggingface/transformers/blob/main/docs/source/en/index.mdx?plain=1#L357

|          MaskFormer           |       ❌       |       ❌       |       ✅        |         ❌         |      ❌      |
|        MaskFormerSwin         |       ❌       |       ❌       |       ❌        |         ❌         |      ❌      |
|             mBART             |       ✅       |       ✅       |       ✅        |         ✅         |      ✅      |

I think it is implemented in this file.

I also found this PR https://github.com/huggingface/transformers/pull/20344 which seemed like it added the model. The model is also missing from the "Supported models" subsection, but I didn't find its paper so is that part of the reason?

joaocmd avatar Apr 23 '23 09:04 joaocmd

@joaocmd Huh, that's odd. Thanks for reporting. Following the shared link, on main I see that MaskFormer is shown as a supported model. Perhaps you caught it in a weird moment before a patch was applied?

image

amyeroberts avatar Apr 24 '23 09:04 amyeroberts

^sorry, I just realised that the link went to maskformer but it's MaskFormerSwin you're referring to.

amyeroberts avatar Apr 24 '23 09:04 amyeroberts

MaskFormersSwin is listed as a "private model" here.

I suspect this is because MaskFormerSwin was added in order to be used as a backbone. @NielsRogge - is this correct?

amyeroberts avatar Apr 24 '23 09:04 amyeroberts

Yes ideally it shouldn't be in that public list, it's just there to be used for MaskFormer for backwards compatibility purposes.

Users can just use our regular Swin in case they want to use it as backbone for MaskFormer.

NielsRogge avatar Apr 24 '23 10:04 NielsRogge

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

github-actions[bot] avatar May 23 '23 15:05 github-actions[bot]

Hi @amyeroberts and @NielsRogge, should anything be changed so that the model doesn't appear on that public list or should we close this issue?

joaocmd avatar May 23 '23 18:05 joaocmd

@joaocmd If you want to open a PR to fix, I'd be very happy to review :) I don't think it's critical to address however.

amyeroberts avatar Jun 09 '23 16:06 amyeroberts

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

github-actions[bot] avatar Jul 05 '23 15:07 github-actions[bot]