🎉 Official STGraph Documentation started #83
Merged
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
Just added the docs page for Cora Dataset
Added a table summarizing the graph stats. And added single line documentation for private methods.
Now the installation guide is similar to the one present in the GitHub repository
Made a Changelogs page for STGraph. Added an intro paragraph and banner in the home page. And added a note for creating a virtual environment in the installation page
Created a tutorial sections with currently a tutorial for GCN training on Cora in progress.
Merge v1.1.0 to official-docs
This was added back to fix the previous merge conflicts
Added reference links in the docstrings which shows up in the documentation. So far it's the links to the dataset loader provided by PyG-T from where we got the datasets. Also removed all the private attributes from the attributes list in the docstrings. Added gdata to the attributes list. Provided the return type for the getter methods in the dataset loaders
Added new gdata attributes such as max_num_nodes and max_num_edges for Dynamic datasets. These values for EnglandCOVID dataset was set accordingly. Also created the doc module page for stgraph.graph. Content yet to be added.
Added the paragraph on how to build the STGraph graph .so file in the docs module page for stgraph.graph
This was done to accommodate for the merge conflicts arising from updating the official-docs branch with the latest changes in the v1.1.0 branch
For the static, temporal and dynamic modules inside stgraph.dataset
🔁 Update official-docs branch with v1.1.0 branch
🔁 Update official-docs branch from v1.1.0 branch
🔁 Update official-docs branch from v1.1.0 branch
🔁 Update official-docs with develop branch
However, there are few methods yet to be documented. Kept them as TODO.
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.
Need to work on the following pages first
Package References shall be added in a later pull request