pytorch / pytorch/audio

Compliance should be named compatibility (or similar)

Open
#281 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.9k
Forks
798
Avg merge
58m
Merged PRs (30d)
3

Description

This bug is purely about naming. Currently, there is a layer with features equivalent to Kaldi implementations named compliance. I would argue that this is an error in diction. The definition of the word compliance I looked up is, "the state or fact of according with or meeting rules or standards." Kaldi is not a rule or standard; it's a specific technology. I believe the more accepted diction would likely be compatibility. The word compatibility has the definition, "the ability of one computer, piece of software, etc. to work with another." This is also the term that was used in the numpy compatibility project that @umanwizard and @gchanan ran.

Whether we address this issue in torchaudio specifically, I think we are likely to continue to define future compatibility layer-type features, and we should attempt to use consistent language for such features, to help users understood what is the contract of any such component.

Cc @vincentqb @cpuhrsch for discussion

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the torchaudio layer currently named compliance and review how its Kaldi-equivalent features are exposed. Resolve whether compatibility or another term is preferred before tracing all related references. Done means the agreed terminology is applied consistently across the affected component.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
audio-video-rtc
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.