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

Relaxed pyproject.toml specifications and improved dependency resolution #306

Merged
merged 15 commits into from
Oct 11, 2024

Conversation

laserkelvin
Copy link
Collaborator

@laserkelvin laserkelvin commented Oct 10, 2024

This PR is intended to significantly simplify the matsciml installation process.

  1. We provide the exact pip command to install all dependencies, which provide the necessary binary distribution links for both PyG and DGL.
  2. Included refreshed conda.yml specification, which should now give the equivalent process as pip but also wrapping it in a managed environment.
  3. We relax the dgl requirement, which AFAIK does not have a strict requirement anymore, and by unpinning it makes it less likely to run into issues to missing GraphBolt, etc.
  4. Updated matsciml.common.package to be a little more specific about the package dependencies that fail most frequently, i.e. DGL and PyG. We will actually try and load in these packages and report back any exceptions, rather than just enabling them in the package registry if they're installed. This helps with debugging because rather than failing when trying to run a model, it will fail much earlier as it will indicate a botched installation/environment.
  5. Related to the above, introduced loguru logging which will just make things look more tidy.

The main effect of this update is to really streamline the installation process: the README now includes copy-pasteable commands that should just work out of the box. In order to do so, I've had to take the executive decision to bump PyTorch to 2.4 or 2.3, primarily because we need those determined and hardcoded for the URLs to work.

@laserkelvin laserkelvin added ux User experience, quality of life changes code maintenance Issue/PR for refactors, code clean up, etc. labels Oct 10, 2024
Copy link
Collaborator

@melo-gonzo melo-gonzo left a comment

Choose a reason for hiding this comment

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

looks great!

@laserkelvin laserkelvin merged commit a475867 into IntelLabs:main Oct 11, 2024
2 checks passed
@laserkelvin laserkelvin deleted the pyproject-package-relaxation branch October 11, 2024 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code maintenance Issue/PR for refactors, code clean up, etc. ux User experience, quality of life changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants