Add a glossary #1570
Merged
Add a glossary #1570
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Code Climate has analyzed commit b75e517 and detected 1 issue on this pull request. Here's the issue category breakdown:
View more on Code Climate. |
timpitman
approved these changes
May 18, 2020
docs/glossary.rst
Outdated
|
|
||
| iloc | ||
| integer location | ||
| Similar to Pandas, ilocs are sequential integers that allow for efficient storage and indexing. The :class:`stellargraph.StellarGraph` class typically stores external IDs as ilocs internally. |
There was a problem hiding this comment.
If we're going to mention Pandas here, we could also link to them? Eg this link: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.iloc.html (though it's not as good as I'd hoped)
| and from ilocs as required internally. Many of these methods also have a ``use_ilocs`` parameter | ||
| that allows for explicitly switching the methods to consume and return ilocs directly, cutting out | ||
| the conversion overhead. | ||
| This type stores the external IDs for nodes and edges as :term:`ilocs <iloc>`. For convenience, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This starts a glossary with a few terms. It's easy to append to it.
Rendered: https://stellargraph--1570.org.readthedocs.build/en/1570/glossary.html
See: #1268