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

bump monty to use the monty.json import speedup patch, add import time regression test, lazy load some rarely used but costly modules #4128

Open
wants to merge 48 commits into
base: master
Choose a base branch
from

Conversation

DanielYang59
Copy link
Contributor

@DanielYang59 DanielYang59 commented Oct 22, 2024

Summary


  • bump monty to use the latest json import speedup patch, partially fix import monty.json slowing down core import #3793

  • Have a quick look at other important modules (on cover those import other 3rd-party/non-core-pmg modules in this PR) and add import time test (profile: python -X importtime -c "from pymatgen.core.structure import Structure" 2> pmg.log && tuna pmg.log):

    • core.bonds: image
    • core.composition: image
    • core.interface (need attention)
    • core.ion: image
    • core.lattice: image
    • core.operations: image
    • core.periodic_table: image
    • core.sites: image
    • core.spectrum: image
    • core.structure
    • core.surface: image
    • core.tensors: image
    • core.trajectory (AseAtomsAdaptor lazy imported)
    • io.vasp.inputs image
    • io.vasp.outputs: image
  • [For a follow up PR] looks like scipy across core need special attention

@DanielYang59 DanielYang59 changed the title bump monty to use the latest json import speedup patch bump monty to use the latest monty.json import speedup patch Oct 22, 2024
@DanielYang59

This comment was marked as resolved.

@DanielYang59 DanielYang59 force-pushed the bump-monty-json branch 4 times, most recently from 5489dff to 8d9d9a6 Compare October 22, 2024 06:54
@DanielYang59
Copy link
Contributor Author

DanielYang59 commented Oct 22, 2024

@mkhorton Can I lazy import sympy (it's used by only one method symmetry.settings.JonesFaithfulTransformation.parse_transformation_string and would give us a ~15% speed up on import core.Structure)?

@DanielYang59 DanielYang59 mentioned this pull request Oct 22, 2024
4 tasks
@@ -580,9 +579,12 @@ def from_file(cls, filename: str | Path, constant_lattice: bool = True, **kwargs
try:
from ase.io.trajectory import Trajectory as AseTrajectory

from pymatgen.io.ase import AseAtomsAdaptor
Copy link
Contributor Author

@DanielYang59 DanielYang59 Oct 26, 2024

Choose a reason for hiding this comment

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

AseAtomsAdaptor is only used in one of the many try-except branches (other branches also lazy import the corresponding modules), ~10% speed up.

if fnmatch(filename, "*XDATCAR*"):
from pymatgen.io.vasp.outputs import Xdatcar
structures = Xdatcar(filename).structures
elif fnmatch(filename, "vasprun*.xml*"):
from pymatgen.io.vasp.outputs import Vasprun
structures = Vasprun(filename).structures
elif fnmatch(filename, "*.traj"):
try:
from ase.io.trajectory import Trajectory as AseTrajectory
ase_traj = AseTrajectory(filename)
# Periodic boundary conditions should be the same for all frames so just check the first
pbc = ase_traj[0].pbc
if any(pbc):
structures = [AseAtomsAdaptor.get_structure(atoms) for atoms in ase_traj]
else:
molecules = [AseAtomsAdaptor.get_molecule(atoms) for atoms in ase_traj]
is_mol = True
except ImportError as exc:
raise ImportError("ASE is required to read .traj files. pip install ase") from exc

image

@@ -664,6 +662,10 @@ def plot_slab(
decay (float): how the alpha-value decays along the z-axis
inverse (bool): invert z axis to plot opposite surface
"""
# Expensive import (PR4128)
from matplotlib import patches
Copy link
Contributor Author

@DanielYang59 DanielYang59 Oct 26, 2024

Choose a reason for hiding this comment

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

matplotlib is likely not a core module for pymatgen, and incurred noticeable overhead to core.interface:
image

After:
image

@DanielYang59 DanielYang59 changed the title bump monty to use the latest monty.json import speedup patch bump monty to use the latest monty.json import speedup patch, add import test regression test, lazy load some rarely used but costly modules Oct 26, 2024
@DanielYang59 DanielYang59 marked this pull request as ready for review October 26, 2024 10:27
@DanielYang59
Copy link
Contributor Author

DanielYang59 commented Oct 26, 2024

@mkhorton I believe this PR is already for view, let me know if you have any comment, thank you!

Credit to @janosh for the motivation and helpful discussion!

@janosh
Copy link
Member

janosh commented Oct 30, 2024

thanks a lot for your extensive profiling work @DanielYang59! i expected there would be a some low-hanging fruit but not nearly as much as you found. you went above and beyond here. 👍
will be big help in resolving janosh/pymatviz#209

@DanielYang59 DanielYang59 changed the title bump monty to use the latest monty.json import speedup patch, add import test regression test, lazy load some rarely used but costly modules bump monty to use the monty.json import speedup patch, add import time regression test, lazy load some rarely used but costly modules Oct 30, 2024
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.

import monty.json slowing down core import
4 participants