Skip to content

Conversation

@gmagogsfm
Copy link
Contributor

No description provided.

@gmagogsfm gmagogsfm requested review from SplitInfinity and suo June 26, 2020 20:13
@gmagogsfm gmagogsfm linked an issue Jun 26, 2020 that may be closed by this pull request
Copy link

@SplitInfinity SplitInfinity left a comment

Choose a reason for hiding this comment

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

It seems to me that these terms pertain to a specific part of PyTorch (that I personally haven't had to touch). Maybe we should break this down into sections? E.g. core, distributed, JIT, etc.

In addition, I wonder if there are better tools or formats to use for this. I guess people can Ctrl + F but I think everyone expects glossaries to be sorted alphabetically, and that is something that will be tedious to do by hand.

GLOSSARY.md Outdated

Choose a reason for hiding this comment

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

Suggested change
An Operations that is defined by users and are usually Compound Operations.
An Operation that is defined by users and is usually a Compound Operation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

GLOSSARY.md Outdated

Choose a reason for hiding this comment

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

Suggested change
used.
uses.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@gmagogsfm
Copy link
Contributor Author

It seems to me that these terms pertain to a specific part of PyTorch (that I personally haven't had to touch). Maybe we should break this down into sections? E.g. core, distributed, JIT, etc.

In addition, I wonder if there are better tools or formats to use for this. I guess people can Ctrl + F but I think everyone expects glossaries to be sorted alphabetically, and that is something that will be tedious to do by hand.

Good point. I am not aware of better tools to use for this, maybe github wiki? But then it would not be very visible for fb internal.

Anyway, I added a table of content, vscode actually has an extension that can automatically update table of content upon file save, so that should help with indexing and alleviate the burden of maintenance.

@gmagogsfm gmagogsfm requested a review from SplitInfinity July 2, 2020 20:51
@gmagogsfm
Copy link
Contributor Author

Gentle ping.

Copy link
Member

@suo suo left a comment

Choose a reason for hiding this comment

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

lgtm!

@suo
Copy link
Member

suo commented Jul 7, 2020

on the "should this be a wiki" issue—I think we can just commit in the repo for now and see what happens

Copy link
Contributor

@facebook-github-bot facebook-github-bot left a comment

Choose a reason for hiding this comment

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

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

@facebook-github-bot
Copy link
Contributor

@gmagogsfm merged this pull request in 445128d.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Need glossary documentation

6 participants