Wav2Vec2 meets phonemes
Author: patrickvonplaten
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 -->

This PR adds Wav2Vec2 with Phoneme support and adds the checkpoints of https://arxiv.org/abs/2109.11680 (See last table: https://github.com/pytorch/fairseq/tree/main/examples/wav2vec#pre-trained-models)

The speech recognition script is adapted and tested to be sure phoneme recognition works as expected. See:
https://huggingface.co/patrickvonplaten/wav2vec2-xls-r-phoneme-300m-tr
and 
https://huggingface.co/patrickvonplaten/wav2vec2-xls-r-phoneme-300m-sv


## 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?

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:
Failing tests are unrelated.

Model can be advertised  next week with author

> Thanks for adding this. I'm not following why there is a new entry for XLS-R which doesn't get its model folder or its model type in the config mapping.

Yeah I'm adding XLS-R to give it a bit more visibility (similar to how we have [DialoGPT](https://huggingface.co/docs/transformers/model_doc/dialogpt) and XLSR-Wav2Vec2 in the docs even though they have 0 added code). Think a lot of people do decide on which checkpoints to use depending on the docs so I think it's good to add more information to the docs. 

Happy to revert it though if you guys prefer

I'm getting an error when running the tests locally:
```
ɛ l o h aʊ a ʁ j u != ɛ l o h a w a ʁ j u

Expected :ɛ l o h a w a ʁ j u
Actual   :ɛ l o h aʊ a ʁ j u
<Click to see difference>

Traceback (most recent call last):
  File "/home/lysandre/transformers/tests/test_tokenization_wav2vec2_phoneme.py", line 214, in test_change_phonemizer_lang
    self.assertEqual(text_fr, "ɛ l o h aʊ a ʁ j u")
AssertionError: 'ɛ l o h a w a ʁ j u' != 'ɛ l o h aʊ a ʁ j u'
- ɛ l o h a w a ʁ j u
?          ^^
+ ɛ l o h aʊ a ʁ j u
?          ^


```

> I'm getting an error when running the tests locally:
> 
> ```
> ɛ l o h aʊ a ʁ j u != ɛ l o h a w a ʁ j u
> 
> Expected :ɛ l o h a w a ʁ j u
> Actual   :ɛ l o h aʊ a ʁ j u
> <Click to see difference>
> 
> Traceback (most recent call last):
>   File "/home/lysandre/transformers/tests/test_tokenization_wav2vec2_phoneme.py", line 214, in test_change_phonemizer_lang
>     self.assertEqual(text_fr, "ɛ l o h aʊ a ʁ j u")
> AssertionError: 'ɛ l o h a w a ʁ j u' != 'ɛ l o h aʊ a ʁ j u'
> - ɛ l o h a w a ʁ j u
> ?          ^^
> + ɛ l o h aʊ a ʁ j u
> ?          ^
> ```

Hmm interesting - what does:

```bash
python -c "import phonemizer; print(phonemizer.__version__)"
```
give you? 

and is it on Windows ? Or Ubuntu?

On an arch-based distro, returns `3.0`!

And `espeak --version` returns
```
eSpeak text-to-speech: 1.48.03  04.Mar.14  Data at: /usr/share/espeak-data
```

> espeak --version

Hmm, interesting. I think the library to be installed should be `espeak-ng` however as stated here: https://github.com/bootphon/phonemizer#dependencies

Could you try one last thing:

```bash
sudo apt-get install espeak-ng
```

which should give version:

```
eSpeak NG text-to-speech: 1.50
```

and try the test again.

Thank you for showing me the way, installing with `espeak-ng` passes all test!