[Proposal] Image segmentation pipeline
Author: Narsil
Pull request: yes
Labels: name: Core: Pipeline

# What does this PR do?
- Currently very low-level results, simply classification masks + score
+ label for each detected class
- Could support panoptic, instance segmentation, bounding boxes and even
part of instance segmentation (might require adding the "parent" info in
addition but that's about it.)
- Happy to hear some thoughts about the design.
- Future could maybe add a "aggregation_strategy" like, which could maybe
output a single image with color filters on top of the classes and so on
(or leave this reduction outside the pipeline). Getting final images like
https://colab.research.google.com/drive/16jcaJoc6bCFAQ96jDe2HwtXj7BMD_-m5#scrollTo=8IRGo8d0qkgR 
is still a bit involved for users that simply want to "see" outputs.



<!--
Congratulations! You've made it this far! You're not quite done yet though.

Once merged, your PR is going to appear in the release notes with the title you set, so make sure it's a great title that fully reflects the extent of your awesome contribution.

Then, please replace this with a description of the change and which issue is fixed (if applicable). Please also include relevant motivation and context. List any dependencies (if any) that are required for this change.

Once you're done, someone will review your PR shortly (see the section "Who can review?" below to tag some potential reviewers). They may suggest changes to make the code even better. If no one reviewed your PR after a week has passed, don't hesitate to post a new comment @-mentioning the same persons---sometimes notifications get lost.
-->

<!-- Remove if not applicable -->

Fixes # (issue)


## Before submitting
- [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
- [ ] Did you read the [contributor guideline](https://github.com/huggingface/transformers/blob/master/CONTRIBUTING.md#start-contributing-pull-requests),
      Pull Request section?
- [ ] Was this discussed/approved via a Github issue or the [forum](https://discuss.huggingface.co/)? Please add a link
      to it if that's the case.
- [ ] Did you make sure to update the documentation with your changes? Here are the
      [documentation guidelines](https://github.com/huggingface/transformers/tree/master/docs), and
      [here are tips on formatting docstrings](https://github.com/huggingface/transformers/tree/master/docs#writing-source-documentation).
- [ ] Did you write any new necessary tests?


## Who can review?

@LysandreJik @NielsRogge

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

<!-- Your PR will be replied to more quickly if you can figure out the right person to tag with @

 If you know how to use git blame, that is the easiest way, otherwise, here is a rough guide of **who to tag**.
 Please tag fewer than 3 people.

Models:

- albert, bert, xlm: @LysandreJik
- blenderbot, bart, marian, pegasus, encoderdecoder,  t5: @patrickvonplaten, @patil-suraj
- longformer, reformer, transfoxl, xlnet: @patrickvonplaten
- fsmt: @stas00
- funnel: @sgugger
- gpt2: @patrickvonplaten, @LysandreJik
- rag: @patrickvonplaten, @lhoestq
- tensorflow: @LysandreJik

Library:

- benchmarks: @patrickvonplaten
- deepspeed: @stas00
- ray/raytune: @richardliaw, @amogkam
- text generation: @patrickvonplaten
- tokenizers: @n1t0, @LysandreJik
- trainer: @sgugger
- pipelines: @LysandreJik

Documentation: @sgugger

HF projects:

- datasets: [different repo](https://github.com/huggingface/datasets)
- rust tokenizers: [different repo](https://github.com/huggingface/tokenizers)

Examples:

- maintained examples (not research project or legacy): @sgugger, @patil-suraj
- research_projects/bert-loses-patience: @JetRunner
- research_projects/distillation: @VictorSanh

 -->

Comments:
@NielsRogge can you give this pipeline a look when you get a chance?

Thanks for this proposal! So the output of the API would be `[{mask, score, label}, ...]`, right? And the shape of `mask` is (height, width)?

I wonder whether this can support any image segmentation model. I'm currently working on implementing [SegFormer](https://arxiv.org/abs/2105.15203) (a new model by NVIDIA), which is a semantic segmentation model. It takes an image as input and produces a segmentation map as output (i.e. it assigns a class to each pixel). This model will only have `outputs.logits`, and they are of shape (batch_size, num_labels, height/4, width/4) - the logits are produced at 1/4th of the original image size. The SegFormer model does not have `outputs.pred_masks`, for example. 

This pipeline should support all forms of image segmentation, right? Panoptic, semantic, instance, etc? I think that if we want that, then we should first define what models for each of these forms of segmentation should produce in their `outputs`.

@NielsRogge 

I think pipelines should support as much different models as possible, regardless of the model output. (and clean error when model is not supported)
Proposed implem uses `pred_masks` because that's what currently available for DetR but if some other arch have different outputs, it should be the pipeline's role to be able to use `.logits` instead and still produce the same outputs.

Those are different kind of models, right ? (Like XXXXForSegmentation vs XXXXForPanopticSegmentation)
If yes, then I think it's kind of routine to have switches on those for the pipelines. Less desirable would be to switch on actual model outputs (.logits vs .pred_masks) , and something that we should really strive to avoid is actually looking at the model arch to decide.

Regardless, I think we can recover masks from raw logits, right ? If yes, then I think that proves that current output is good as it would enable pipeline to support SegFormer too.

Would you agree? 

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](https://github.com/huggingface/transformers/blob/master/CONTRIBUTING.md) are likely to be ignored.

Unstale

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](https://github.com/huggingface/transformers/blob/master/CONTRIBUTING.md) are likely to be ignored.