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

Add devices/properties badges #2321

Closed
wants to merge 5 commits into from
Closed

Add devices/properties badges #2321

wants to merge 5 commits into from

Conversation

mthrok
Copy link
Collaborator

@mthrok mthrok commented Apr 5, 2022

Add badges of supported properties and devices to functionals and transforms.

This commit adds .. devices:: and .. properties:: directives to sphinx.

APIs with these directives will have badges (based off of shields.io) which link to the
page with description of these features.

Screen Shot 2022-04-11 at 8 39 56 AM

Continuation of #2316
Excluded dtypes for further improvement, and actually added badges to most of functional/transforms.

@mthrok mthrok force-pushed the badges-2 branch 2 times, most recently from fb5a293 to 55d2c61 Compare April 5, 2022 21:14
@mthrok mthrok marked this pull request as ready for review April 5, 2022 22:15
@@ -0,0 +1,97 @@
Supported Features
Copy link
Contributor

Choose a reason for hiding this comment

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

thoughts on renaming this "Supported Properties" or something of that nature? could be slightly confusing to use feature as both the overall feature set and as a subset (autograd/torchscript)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes! I was also feeling that "feature" is overloaded here. Thanks for the suggestion. Will do.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated. It still uses the ambiguous feature term. Let me know what you think.

Copy link
Contributor

Choose a reason for hiding this comment

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

maybe "Supported PyTorch Features" to reflect that they're native to pytorch?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I am thinking to mention numerical compatibility with other libraries such as librosa and Kaldi, so let me follow-up on this one.

mthrok and others added 2 commits April 5, 2022 22:22
Co-authored-by: Caroline Chen <carolinechen@fb.com>
Copy link
Contributor

@hwangjeff hwangjeff left a comment

Choose a reason for hiding this comment

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

just cosmetic things — looks good overall

@@ -0,0 +1,97 @@
Supported Features
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe "Supported PyTorch Features" to reflect that they're native to pytorch?

Co-authored-by: hwangjeff <hwangjeff@users.noreply.github.com>
@facebook-github-bot
Copy link
Contributor

@mthrok has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@mthrok mthrok changed the title Adding feature/device badges Add devices/properties badges Apr 8, 2022
@github-actions
Copy link

github-actions bot commented Apr 8, 2022

Hey @mthrok.
You merged this PR, but labels were not properly added. Please add a primary and secondary label (See https://github.com/pytorch/audio/blob/main/.github/process_commit.py)

@mthrok mthrok deleted the badges-2 branch April 8, 2022 14:00
xiaohui-zhang pushed a commit to xiaohui-zhang/audio that referenced this pull request May 4, 2022
Summary:
Add badges of supported properties and devices to functionals and transforms.

This commit adds `.. devices::` and `.. properties::` directives to sphinx.

APIs with these directives will have badges (based off of shields.io) which link to the
page with description of these features.

Continuation of pytorch#2316
Excluded dtypes for further improvement, and actually added badges to most of functional/transforms.

Pull Request resolved: pytorch#2321

Reviewed By: hwangjeff

Differential Revision: D35489063

Pulled By: mthrok

fbshipit-source-id: f68a70ebb22df29d5e9bd171273bd19007a81762
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants