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

📦 STGraph v1.1.0 #142

Merged
merged 160 commits into from
Sep 9, 2024
Merged

📦 STGraph v1.1.0 #142

merged 160 commits into from
Sep 9, 2024

Conversation

JoelMathewC
Copy link
Contributor

@JoelMathewC JoelMathewC commented Sep 7, 2024

This is the v1.1.0 version of STGraph that @nithinmanoj10 has been working on. The changelog is present at #143

Just added the docs page for Cora Dataset
Added a table summarizing the graph stats. And added single line documentation for private methods.
STGraphDataset is the base class for all other dataset classes. So far created the private method `_has_dataset_cache()`
Added STGraphStaticDataset as an abstract class for static graph datasets. It inherits from STGraphDataset.
Added _download_dataset(), _save_dataset() and _load_dataset() methods which are used to handle cached graph datasets. These 3 functions will be common for all datasets present in STGraph and hence is implemented within the STGraphDataset base class.
Added more private attributes such as train/test masks/splits. Implemented the logic for _process_dataset() method.
Also added information about how the dataset handling is done inside the docstrings of STGraphDataset class
Just started writing pytests for the CoraDataLoader. So far written the code to test the init method.
HungaryCPDataLoader is part of the temporal graph dataset group.
Added the __init__() functions for HungaryCPDataLoader. Also added lags variable initialization inside STGraphTemporalDataset
Added descriptive docstrings for HungaryCPDataLoader. Made couple of additions to the docstrings of CoraDataLoader.

Made assert checks for the parameters passed to the above two dataloaders. Also made an issue related to HungaryCPDataLoader #86 reagarding the node features array.
Initialised the EnglandCovidDataLoader class
Added the various dataset pre-processing methods for EnglandCovidDataLoader.
Added descriptive documentation for EnglandCovidDataLoader along with code to calculate and set the graph attributes gdata field. Made better name choices by changing _get_total_timestamps() to _set_total_timestamps() and so on.

Added tests for EnglandCovidDataLoader. It is however incomplete.

Added few more documentation and necessary name changes for CoraDataLoader and HungaryCPDataLoader.
Added the METRLADataLoader constructor and method to find the total timestamps of the dataset
The METRLADataLoader has been added with necessary documentation
The MontevideoBusDataLoader has been added. Instead of using assert checks, we will be using if conditions and raising Exceptions if the user is passing any incorrect parameters.

Also added the logic for _set_edge_weights() along with documentation for the __init__ method
@JoelMathewC JoelMathewC changed the title v1.1.1 Additions STGraph v1.1.1 Sep 7, 2024
@JoelMathewC
Copy link
Contributor Author

@nithinmanoj10 I took a quick pass and everything seems good. Feel free to merge if you have tested everything. I just had one question, do we need the example directory if we have a tutorial directory too?

@nithinmanoj10 nithinmanoj10 changed the title STGraph v1.1.1 STGraph v1.1.0 Sep 7, 2024
@nithinmanoj10
Copy link
Contributor

@JoelMathewC Thanks for the review and suggestion. Removed the example/ directory since users will be using tutorial/ directory from now on.

Tested all the changes locally by running the unit and script tests. Looks like everything is going through properly. Even built the latest docs and everything seems in order.

Have published the stgraph v1.1.0 package in Test-PyPI refer here

Will test install from Test PyPI locally and run couple of scripts to see if everything is working as required. Once that is complete will publish it officially in PyPI as well

@nithinmanoj10 nithinmanoj10 changed the title STGraph v1.1.0 📦 STGraph v1.1.0 Sep 9, 2024
@nithinmanoj10 nithinmanoj10 merged commit ae0410a into main Sep 9, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants