Skip to content

[docstring] Fix docstrings for UniSpeechConfig, UniSpeechForCTC, UniSpeechSatConfig, UniSpeechSatForCTC and Wav2Vec2ForCTC#26664

Merged
ydshieh merged 11 commits intohuggingface:mainfrom
gizemt:unispeech-docstring
Oct 12, 2023
Merged

[docstring] Fix docstrings for UniSpeechConfig, UniSpeechForCTC, UniSpeechSatConfig, UniSpeechSatForCTC and Wav2Vec2ForCTC#26664
ydshieh merged 11 commits intohuggingface:mainfrom
gizemt:unispeech-docstring

Conversation

@gizemt
Copy link
Contributor

@gizemt gizemt commented Oct 8, 2023 •
edited
Loading

Fixes #26638

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. Feel free to tag
members/contributors who may be interested in your PR.

@ydshieh

@gizemt gizemt force-pushed the unispeech-docstring branch 3 times, most recently from 318562d to 1b8b5f7 Compare October 8, 2023 04:01
@gizemt gizemt changed the title Update docstrings for Unispeech and UnispeechSat Update docstrings for Wav2Vec2ForCTC, Unispeech and UnispeechSat models Oct 8, 2023
@gizemt gizemt marked this pull request as ready for review October 8, 2023 04:33
ydshieh
ydshieh reviewed Oct 9, 2023
View reviewed changes
src/transformers/models/unispeech/configuration_unispeech.py Outdated
Copy link
Collaborator

@ydshieh ydshieh Oct 9, 2023

Choose a reason for hiding this comment

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

very nice!

ydshieh
ydshieh reviewed Oct 9, 2023
View reviewed changes
src/transformers/models/unispeech/modeling_unispeech.py Outdated
Copy link
Collaborator

@ydshieh ydshieh Oct 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

There should be period . after adapter.<lang>.bin.

ydshieh
ydshieh reviewed Oct 9, 2023
View reviewed changes
src/transformers/models/unispeech_sat/modeling_unispeech_sat.py Outdated
Copy link
Collaborator

@ydshieh ydshieh Oct 9, 2023

Choose a reason for hiding this comment

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

same

ydshieh
ydshieh reviewed Oct 9, 2023
View reviewed changes
src/transformers/models/wav2vec2/modeling_wav2vec2.py Outdated
Copy link
Collaborator

@ydshieh ydshieh Oct 9, 2023

Choose a reason for hiding this comment

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

may I know why there is no Only relevant when using an instance ... part here?

Copy link
Contributor Author

@gizemt gizemt Oct 9, 2023

Choose a reason for hiding this comment

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

not intentional. thanks for the catch!

@ydshieh ydshieh mentioned this pull request Oct 9, 2023
Closed
3 tasks
@gizemt gizemt requested a review from ydshieh October 10, 2023 02:09
@ydshieh
Copy link
Collaborator

ydshieh commented Oct 10, 2023

Hi @gizemt I think the commit history is messed up when you merged the branch into this PR. You can see irrelevant changes to this PR shown up in Files changed.

Could you resolve this please?

@gizemt gizemt marked this pull request as draft October 10, 2023 19:48
@gizemt gizemt force-pushed the unispeech-docstring branch from f294515 to ef3cd60 Compare October 11, 2023 02:59
@gizemt gizemt marked this pull request as ready for review October 11, 2023 03:14
@gizemt
Copy link
Contributor Author

gizemt commented Oct 11, 2023

oops sorry, messed up rebase. fixed it now. @ydshieh

ydshieh
ydshieh reviewed Oct 11, 2023
View reviewed changes
ydshieh
ydshieh reviewed Oct 11, 2023
View reviewed changes
Copy link
Collaborator

@ydshieh ydshieh left a comment

Choose a reason for hiding this comment

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

A final tiny change to make and we are ready go go 🚀 .

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Oct 11, 2023

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

gizemt and others added 2 commits October 11, 2023 22:15
@gizemt @ydshieh
Update Wav2Vec2ForCTC docstring
e24d88f 
Co-authored-by: Yih-Dar <2521628+ydshieh@users.noreply.github.com>
@gizemt
fix style
42dedda
@gizemt gizemt requested a review from ydshieh October 12, 2023 05:56
@gizemt
Copy link
Contributor Author

gizemt commented Oct 12, 2023

good to go @ydshieh thank you!

@gizemt gizemt changed the title Update docstrings for Wav2Vec2ForCTC, Unispeech and UnispeechSat models [docstring] Fix docstrings for UniSpeechConfig, UniSpeechForCTC, UniSpeechSatConfig, UniSpeechSatForCTC and Wav2Vec2ForCTC Oct 12, 2023
ydshieh
ydshieh approved these changes Oct 12, 2023
View reviewed changes
Copy link
Collaborator

@ydshieh ydshieh 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 @gizemt for this contribution 🚀 !

@ydshieh ydshieh merged commit eb734e5 into huggingface:main Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ydshieh ydshieh ydshieh approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Community Event] Docstring Sprint

3 participants

@gizemt @ydshieh @HuggingFaceDocBuilderDev