Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

replace Speech2TextTokenizer by Speech2TextFeatureExtractor in some docstrings #16835

Merged
merged 2 commits into from
Apr 19, 2022

Conversation

SaulLu
Copy link
Contributor

@SaulLu SaulLu commented Apr 19, 2022

What does this PR do?

It seems to me that fbank features can be returned by an FeatureExtractor and not by a Tokenizer. This PR proposes to make some changes in the docstrings that mention that Speech2TextTokenizer should be used to return fbank features.

It seems to me that among the 3 models - Speech2Text, Speech2Text2 and SpeechEncoderDecoder - only Speech2Text implements a feature extractor and I therefore deduce that the same feature extractor class that is used for the 3 models.

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,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? 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, and
    here are tips on formatting docstrings.
  • 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. As it concerns audio related model, I would love to have your feedback @patrickvonplaten , @anton-l or @patil-suraj

Copy link
Contributor

@patrickvonplaten patrickvonplaten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Apr 19, 2022

The documentation is not available anymore as the PR was closed or merged.

Copy link
Contributor

@patil-suraj patil-suraj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thank you for fixing this!

@SaulLu SaulLu merged commit 1efca4e into huggingface:main Apr 19, 2022
elusenji pushed a commit to elusenji/transformers that referenced this pull request Jun 12, 2022
…me docstrings (huggingface#16835)

* replace `Speech2TextTokenizer` by `Speech2TextFeatureExtractor` in docstring

* quality
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants