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

rename STOI #753

Merged
merged 4 commits into from
Jan 14, 2022
Merged

rename STOI #753

merged 4 commits into from
Jan 14, 2022

Conversation

Borda
Copy link
Member

@Borda Borda commented Jan 14, 2022

What does this PR do?

unify the STOI name, part of #729

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

@codecov
Copy link

codecov bot commented Jan 14, 2022

Codecov Report

Merging #753 (2dd038b) into master (06d820b) will increase coverage by 0%.
The diff coverage is 90%.

@@          Coverage Diff          @@
##           master   #753   +/-   ##
=====================================
  Coverage      74%    74%           
=====================================
  Files         170    170           
  Lines        6823   6831    +8     
=====================================
+ Hits         5020   5027    +7     
- Misses       1803   1804    +1     

@Borda Borda changed the title refactor: STOI rename STOI Jan 14, 2022
torchmetrics/audio/stoi.py Show resolved Hide resolved
@Borda Borda enabled auto-merge (squash) January 14, 2022 11:03
@Borda Borda self-assigned this Jan 14, 2022
@mergify mergify bot added the ready label Jan 14, 2022
@Borda Borda disabled auto-merge January 14, 2022 13:36
@Borda Borda merged commit d044d33 into master Jan 14, 2022
@Borda Borda deleted the refactor/STOI branch January 14, 2022 13:36
@stancld stancld mentioned this pull request Jan 14, 2022
4 tasks
@quancs
Copy link
Member

quancs commented Jan 17, 2022

@Borda I find STOI is more offen called Short-Time Objective Intelligibility than Short-Term Objective Intelligibility. Could we change the full name to Short-Time Objective Intelligibility?

@quancs
Copy link
Member

quancs commented Jan 17, 2022

Seems its name in papers is Short-Time Objective Intelligibility (a mistake in old doc :) ). So, I guess it's better to change it before a new release

@Borda
Copy link
Member Author

Borda commented Jan 17, 2022

Seems its name in papers is Short-Time Objective Intelligibility (a mistake in old doc :) ). So, I guess it's better to change it before a new release

that is fine, I was using the description in docstrings... 🐰

@Borda Borda mentioned this pull request Jan 17, 2022
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API / design ready refactoring refactoring and code health
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants