Add generate kwargs to `AutomaticSpeechRecognitionPipeline`
Author: bofenghuang
Pull request: yes

# What does this PR do?

<!--
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 -->

Hi @Narsil 👋,

In this PR, I tried to add generate arguments to `AutomaticSpeechRecognitionPipeline` in order to run pipeline with seq2seq models using beam search, contrastive search, etc. I followed the style in [`TextGenerationPipeline`](https://github.com/huggingface/transformers/blob/8637316e5e94ba0a2493e5df7846f2f23f46eaef/src/transformers/pipelines/text2text_generation.py#L73).

```python
import torch
from transformers import pipeline

pipe = pipeline(model="openai/whisper-base", device=0, torch_dtype=torch.float16)

pipe("https://huggingface.co/datasets/Narsil/asr_dummy/resolve/main/1.flac", max_new_tokens=5)
# {'text': ' He hoped'}
```


## Before submitting
- [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
- [x] Did you read the [contributor guideline](https://github.com/huggingface/transformers/blob/main/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/main/docs), and
      [here are tips on formatting docstrings](https://github.com/huggingface/transformers/tree/main/docs#writing-source-documentation).
- [ ] Did you write any new necessary tests?


## Who can review?

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:

- text models: @ArthurZucker and @younesbelkada
- vision models: @amyeroberts and @NielsRogge
- speech models: @sanchit-gandhi

Library:

- flax: @sanchit-gandhi
- generate: @gante
- pipelines: @Narsil
- tensorflow: @gante and @Rocketknight1
- tokenizers: @ArthurZucker
- trainer: @sgugger

Integrations:

- deepspeed: @stas00
- ray/raytune: @richardliaw, @amogkam

Documentation: @sgugger and @stevhliu

HF projects:

- accelerate: [different repo](https://github.com/huggingface/accelerate)
- datasets: [different repo](https://github.com/huggingface/datasets)
- diffusers: [different repo](https://github.com/huggingface/diffusers)
- rust tokenizers: [different repo](https://github.com/huggingface/tokenizers)

Maintained examples (not research project or legacy):

- Flax: @sanchit-gandhi
- PyTorch: @sgugger
- TensorFlow: @Rocketknight1

 -->


Comments:
_The documentation is not available anymore as the PR was closed or merged._

@Narsil it's indeed better this way. Thanks for the explanation!

Hi @Narsil,

Some tests of `ctc_with_lm` models failed. I think we could

1. Lift `decoder` in `__init__` as an individual argument
2. Add `**kwargs` into `_sanitize_parameters`

Personally I prefer the 1st one since the other one may introduce some silent errors. What's your opinion? 

> Personally I prefer the 1st one since the other one may introduce some silent errors. What's your opinion?

In general I would agree with you. Pipelines accepting so many parameters I would tend to keep it simple, and maybe just change line 183 

```diff
- self.decoder = kwargs["decoder"]
+ self.decoder = kwargs.pop("decoder")
```

This would be just so the signature is kept at a minimum (the docstring should be good) and avoiding accepting `decoder` as a positioned arguments instead of a keyword one. (I know we can do that within the signature, but it does complexify the docs, notably this part: https://huggingface.co/docs/transformers/v4.25.1/en/main_classes/pipelines#transformers.AutomaticSpeechRecognitionPipeline


This is the sort of function complexity that I think is more detrimental than helping unfortunately: https://huggingface.co/docs/transformers/v4.25.1/en/main_classes/text_generation#transformers.GenerationMixin.generate


> In general I would agree with you. Pipelines accepting so many parameters I would tend to keep it simple, and maybe just change line 183
> 
> ```diff
> - self.decoder = kwargs["decoder"]
> + self.decoder = kwargs.pop("decoder")
> ```

The error occurs in the line 173 where `_sanitize_parameters` is called in parent :(

> The error occurs in the line 173 where `_sanitize_parameters` is called in parent :(

Ah so it happens before then, let's do it you way then

does
```
__init__(self, ....,, *args, *, decoder, **kwargs)
```
work ?
(Try and force to disable positional argument for `decoder` ?


> does
> 
> ```
> __init__(self, ....,, *args, *, decoder, **kwargs)
> ```
> 
> work ? (Try and force to disable positional argument for `decoder` ?

No it's a syntax error :(

Can we do this ?

```diff
- def __init__(self, feature_extractor: Union["SequenceFeatureExtractor", str], *args, **kwargs):
+ def __init__(self, feature_extractor: Union["SequenceFeatureExtractor", str], decoder: Optional[Union["BeamSearchDecoderCTC", str]] = None, *args, **kwargs):
```

This will interpret `AutomaticSpeecRecognitionPipeline(feature_extractor, model)`  and interpret `model`  as `decoder` which will lead to confusing errors.

Can you try :

```python
+ def __init__(self, feature_extractor: Union["SequenceFeatureExtractor", str], *, decoder: Optional[Union["BeamSearchDecoderCTC", str]] = None, **kwargs):
```
Maybe ?

> Can you try :
> 
> ```python
> + def __init__(self, feature_extractor: Union["SequenceFeatureExtractor", str], *, decoder: Optional[Union["BeamSearchDecoderCTC", str]] = None, **kwargs):
> ```
> 
> Maybe ?

No we need `*args` for the line 173

> > Can you try :
> > ```python
> > + def __init__(self, feature_extractor: Union["SequenceFeatureExtractor", str], *, decoder: Optional[Union["BeamSearchDecoderCTC", str]] = None, **kwargs):
> > ```
> > 
> > 
> >     
> >       
> >     
> > 
> >       
> >     
> > 
> >     
> >   
> > Maybe ?
> 
> No we need `*args` for the line 173

Remove it there too. 

@Narsil Oups, the commit history seems to be messed up. Let me create a new one!

Closed as the other one is cleaner https://github.com/huggingface/transformers/pull/20952