pytorch
[WIP] Add badge directives for supported features
This commit adds custom directives, dtypes.
https://output.circle-artifacts.com/output/job/095ac03b-9795-45ba-af79-916526915df0/artifacts/0/docs/transforms.html#feature-extractions
Clicking these badges will bring users to the features page (WIP).
https://output.circle-artifacts.com/output/job/095ac03b-9795-45ba-af79-916526915df0/artifacts/0/docs/supported_features.html
The motivation is to provide an easy way for users to know which of torchaudio's implementations are tested on what features. For example pitch-shift does not support autograd, due to angles in complex plane not being differentiable around the origin. Similarly none of the functions/classes are tested on fp16. We do not have an easy way to tell users. Using badge, I think, is simple and using custom directives make it easy for us to maintain the communication.
Hi @mthrok!
Thank you for your pull request.
We require contributors to sign our Contributor License Agreement, and yours needs attention.
You currently have a record in our system, but the CLA is no longer valid, and will need to be resubmitted.
Process
In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.
Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.
If you have received this in error or have any questions, please contact us at [email protected]. Thanks!
