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

graphgym: A correction in documentation and added information on how to install requirements #8842

Merged
merged 5 commits into from
Jan 31, 2024

Conversation

rraadd88
Copy link
Contributor

  1. In the documentation of graphgym, configs/example_node.yaml should be configs/pyg/example_node.yaml, based on the current location of that file in the repository.
  2. The documentation lacked information on how to install the requirements for graphgym. So I added a graphgym/configure.py file which extracts graphgym's requirements from the pyproject.toml. Accordingly, following line is added in the documentation:
python configure.py;pip install -r requirements.txt

I hope this helps.

Copy link
Contributor Author

@rraadd88 rraadd88 left a comment

Choose a reason for hiding this comment

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

example_node.yaml is located in pyg folder.

@github-actions github-actions bot removed the graphgym label Jan 31, 2024
Copy link
Member

@rusty1s rusty1s left a comment

Choose a reason for hiding this comment

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

Thanks!

@rusty1s rusty1s enabled auto-merge (squash) January 31, 2024 19:07
@rusty1s rusty1s merged commit c2e2a25 into pyg-team:master Jan 31, 2024
11 of 12 checks passed
Copy link
Contributor Author

@rraadd88 rraadd88 left a comment

Choose a reason for hiding this comment

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

About pip install torch-geometric[graphgym], I wonder if running this command could replace the installed version of the package. I suppose one should have the same version of the package installed and the (git-)cloned to use graphgym. But if this is not the case, users could lose their installed version of pyg.

I had suggested separating the requirements from toml and installing them, for this reason. By installing only the requirements, users would not lose their installed version of pyg.

@rusty1s
Copy link
Member

rusty1s commented Feb 1, 2024

IMO, it will not override the existing version of the package. This is definitely the recommended way to install the missing dependencies. I personally would like to avoid adding a script that parses the toml and creates a requirement file from it.

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.

None yet

2 participants