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

Allow bonds etc to be additively guessed when present #4761

Merged
merged 32 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
6ee7c17
add tests
lilyminium Oct 25, 2024
ada6967
special case connections
lilyminium Oct 25, 2024
5ce43e0
pep8 tests
lilyminium Oct 25, 2024
7db0f6a
add failing force_guess bond test
lilyminium Oct 25, 2024
f22a9a6
add force guessing removal
lilyminium Oct 25, 2024
e21059c
fix pep8
lilyminium Oct 25, 2024
aed3d31
cleanup
lilyminium Oct 25, 2024
e88af7a
add more tests
lilyminium Oct 25, 2024
11a14c1
update changelog
lilyminium Oct 25, 2024
523f06d
Merge branch 'develop' into order-bond-guessing
lilyminium Oct 26, 2024
a27bebf
Merge branch 'develop' into order-bond-guessing
IAlibay Oct 26, 2024
219ee09
add tests
lilyminium Oct 25, 2024
1e6d9ab
add force guessing removal
lilyminium Oct 25, 2024
2918ae7
add more tests
lilyminium Oct 25, 2024
3e17007
update tests after deletion fix
lilyminium Oct 26, 2024
892bc42
fix problematic merge
lilyminium Oct 26, 2024
451d6a8
fix other merge problem
lilyminium Oct 26, 2024
f044fa1
how did this rebase go so wrong
lilyminium Oct 26, 2024
e17c57e
repep8
lilyminium Oct 26, 2024
1fc4514
more merge fixes
lilyminium Oct 26, 2024
7305e60
change guessing bonds with force to additive
lilyminium Oct 26, 2024
970371f
change valueerror to nodataerror
lilyminium Oct 26, 2024
909ec37
add tests for errors
lilyminium Oct 27, 2024
c190ca8
Update package/MDAnalysis/core/universe.py
lilyminium Oct 28, 2024
f03a394
Update package/MDAnalysis/core/universe.py
lilyminium Oct 28, 2024
80c68a6
Update package/MDAnalysis/core/universe.py
lilyminium Oct 28, 2024
5ab97d4
Update package/MDAnalysis/core/universe.py
lilyminium Oct 28, 2024
38077d6
add new test
lilyminium Oct 28, 2024
ab6418e
add guessing check
lilyminium Oct 28, 2024
26f91b5
oopsie
lilyminium Oct 28, 2024
36b62e6
update test
lilyminium Oct 29, 2024
839e7f3
Update testsuite/MDAnalysisTests/guesser/test_base.py
IAlibay Nov 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions package/CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ The rules for this file:
* 2.8.0

Fixes
* Allows bond/angle/dihedral connectivity to be guessed additively with
`to_guess`, and as a replacement of existing values with `force_guess`.
Also updates cached bond attributes when updating bonds. (Issue #4759, PR #4761)
* Fixes bug where deleting connections by index would only delete
one of multiple, if multiple are present (Issue #4762, PR #4763)
* Changes error to warning on Universe creation if guessing fails
Expand Down
1 change: 0 additions & 1 deletion package/MDAnalysis/core/topologyattrs.py
Original file line number Diff line number Diff line change
Expand Up @@ -3117,7 +3117,6 @@ def _add_bonds(self, values, types=None, guessed=True, order=None):
guessed = itertools.cycle((guessed,))
if order is None:
order = itertools.cycle((None,))

existing = set(self.values)
for v, t, g, o in zip(values, types, guessed, order):
if v not in existing:
Expand Down
60 changes: 39 additions & 21 deletions package/MDAnalysis/core/universe.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,10 @@
Atom, Residue, Segment,
AtomGroup, ResidueGroup, SegmentGroup)
from .topology import Topology
from .topologyattrs import AtomAttr, ResidueAttr, SegmentAttr, BFACTOR_WARNING
from .topologyattrs import (
AtomAttr, ResidueAttr, SegmentAttr,
BFACTOR_WARNING, _Connection
)
from .topologyobjects import TopologyObject
from ..guesser.base import get_guesser

Expand Down Expand Up @@ -454,7 +457,7 @@ def __init__(self, topology=None, *coordinates, all_coordinates=False,
"the previous Context values.",
DeprecationWarning
)
force_guess = list(force_guess) + ['bonds', 'angles', 'dihedrals']
to_guess = list(to_guess) + ['bonds', 'angles', 'dihedrals']
lilyminium marked this conversation as resolved.
Show resolved Hide resolved

self.guess_TopologyAttrs(
context, to_guess, force_guess, error_if_missing=False
Expand Down Expand Up @@ -1180,7 +1183,6 @@ def _add_topology_objects(self, object_type, values, types=None, guessed=False,
self.add_TopologyAttr(object_type, [])
attr = getattr(self._topology, object_type)


attr._add_bonds(indices, types=types, guessed=guessed, order=order)

def add_bonds(self, values, types=None, guessed=False, order=None):
Expand Down Expand Up @@ -1231,6 +1233,14 @@ def add_bonds(self, values, types=None, guessed=False, order=None):
"""
self._add_topology_objects('bonds', values, types=types,
guessed=guessed, order=order)
self._invalidate_bond_related_caches()

def _invalidate_bond_related_caches(self):
"""
Invalidate caches related to bonds and fragments.
lilyminium marked this conversation as resolved.
Show resolved Hide resolved

.. versionadded: 2.8.0
"""
# Invalidate bond-related caches
self._cache.pop('fragments', None)
self._cache['_valid'].pop('fragments', None)
Expand Down Expand Up @@ -1307,7 +1317,7 @@ def _delete_topology_objects(self, object_type, values):
Parameters
----------
object_type : {'bonds', 'angles', 'dihedrals', 'impropers'}
The type of TopologyObject to add.
The type of TopologyObject to delete.
values : iterable of tuples, AtomGroups, or TopologyObjects; or TopologyGroup
An iterable of: tuples of atom indices, or AtomGroups,
or TopologyObjects.
Expand All @@ -1330,7 +1340,6 @@ def _delete_topology_objects(self, object_type, values):
attr = getattr(self._topology, object_type)
except AttributeError:
raise ValueError('There are no {} to delete'.format(object_type))

attr._delete_bonds(indices)

def delete_bonds(self, values):
Expand Down Expand Up @@ -1371,10 +1380,7 @@ def delete_bonds(self, values):
.. versionadded:: 1.0.0
"""
self._delete_topology_objects('bonds', values)
# Invalidate bond-related caches
self._cache.pop('fragments', None)
self._cache['_valid'].pop('fragments', None)
self._cache['_valid'].pop('fragindices', None)
self._invalidate_bond_related_caches()

def delete_angles(self, values):
"""Delete Angles from this Universe.
Expand Down Expand Up @@ -1613,7 +1619,10 @@ def guess_TopologyAttrs(
# in the same order that the user provided
total_guess = list(dict.fromkeys(total_guess))

objects = ['bonds', 'angles', 'dihedrals', 'impropers']
objects = set(
lilyminium marked this conversation as resolved.
Show resolved Hide resolved
topattr.attrname for topattr in _TOPOLOGY_ATTRS.values()
if issubclass(topattr, _Connection)
)

# Checking if the universe is empty to avoid errors
# from guesser methods
Expand All @@ -1640,23 +1649,32 @@ def guess_TopologyAttrs(
fg = attr in force_guess
try:
values = guesser.guess_attr(attr, fg)
except ValueError as e:
except NoDataError as e:
Copy link
Member

Choose a reason for hiding this comment

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

Do we really want to do this? There are a couple of cases in guess_bonds where we can encounter a ValueError instead of a NoDataError.

e.g. https://github.com/MDAnalysis/mdanalysis/blob/develop/package/MDAnalysis/guesser/default_guesser.py#L430

Copy link
Member

Choose a reason for hiding this comment

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

Also what should happen when you encounter a KeyError? (i.e. the unrecognised topologyattr check you added)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yup for this exact case -- I didn't want to change existing behaviour too much in case downstream packages were relying on it, and this is an existing test for vdwradii that wasn't introduced with guessers. The NoDataError is meant to catch cases where (e.g.) masses can't be guessed since there aren't types, not if the vdwradii is incomplete, so you can turn it off with error_if_missing. Same with the KeyError.

Copy link
Member

Choose a reason for hiding this comment

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

I'm sorry, I just don't follow what you mean here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops. I hallucinated that you linked a test instead of a spot in the code, sorry about that. Basically IIRC there's two tests that test for this ValueError. One is definitely

def test_universe_guess_bonds_no_vdwradii(self):
"""Make a Universe that has atoms with unknown vdwradii."""
with pytest.raises(ValueError):
mda.Universe(two_water_gro_nonames, guess_bonds=True)
and the other one I can't immediately recall. To preserve existing pre-guesser behaviour, we want the ValueError to pass through this check and get caught by those tests.

These passed in the initial guesser PR because that was pre #4754.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, keeping the original behavior makes sense to me (and I confirm it is the original behavior).

Copy link
Member

Choose a reason for hiding this comment

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

The NoDataError is meant to catch cases where (e.g.) masses can't be guessed since there aren't types, not if the vdwradii is incomplete, so you can turn it off with error_if_missing. Same with the KeyError.

I'm not sure I understand what you mean by "same with the KeyError" - i.e. there is nothing here that catches the KeyError as far as I can tell.

Copy link
Member

Choose a reason for hiding this comment

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

For the sake of not stalling things more I'm going to go with it (i.e. the KeyError shouldn't happen under normal circumstances), but I would like to know what you meant here @lilyminium - it's unclear if you meant that the KeyError should behave like the NoDataError, in which case this except should include the KeyError too?

if error_if_missing or fg:
raise e
else:
warnings.warn(str(e))
continue

if values is not None:
if attr in objects:
self._add_topology_objects(
attr, values, guessed=True)
else:
guessed_attr = _TOPOLOGY_ATTRS[attr](values, True)
self.add_TopologyAttr(guessed_attr)
logger.info(
f'attribute {attr} has been guessed'
' successfully.')
# None indicates no additional guessing was done
if values is None:
continue
if attr in objects:
# delete existing connections if they exist
if fg and hasattr(self.atoms, attr):
group = getattr(self.atoms, attr)
self._delete_topology_objects(attr, group)
# this method appends to existing bonds
lilyminium marked this conversation as resolved.
Show resolved Hide resolved
self._add_topology_objects(
attr, values, guessed=True)
if attr == "bonds":
self._invalidate_bond_related_caches()
else:
guessed_attr = _TOPOLOGY_ATTRS[attr](values, True)
self.add_TopologyAttr(guessed_attr)
logger.info(
f'attribute {attr} has been guessed'
' successfully.')

else:
raise ValueError(f'{context} guesser can not guess the'
Expand Down
34 changes: 27 additions & 7 deletions package/MDAnalysis/guesser/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@
.. autofunction:: get_guesser

"""
from .. import _GUESSERS
from .. import _GUESSERS, _TOPOLOGY_ATTRS
from ..core.topologyattrs import _Connection
import numpy as np
from .. import _TOPOLOGY_ATTRS
import logging
from typing import Dict
import copy
Expand Down Expand Up @@ -136,21 +136,41 @@ def guess_attr(self, attr_to_guess, force_guess=False):
NDArray of guessed values

"""
try:
top_attr = _TOPOLOGY_ATTRS[attr_to_guess]
except KeyError:
raise KeyError(
f"{attr_to_guess} is not a recognized MDAnalysis "
"topology attribute"
)
# make attribute to guess plural
attr_to_guess = top_attr.attrname

try:
guesser_method = self._guesser_methods[attr_to_guess]
except KeyError:
raise ValueError(f'{type(self).__name__} cannot guess this '
f'attribute: {attr_to_guess}')

# Connection attributes should be just returned as they are always
# appended to the Universe. ``force_guess`` handling should happen
# at Universe level.
if issubclass(top_attr, _Connection):
return guesser_method()

# check if the topology already has the attribute to partially guess it
if hasattr(self._universe.atoms, attr_to_guess) and not force_guess:
attr_values = np.array(
getattr(self._universe.atoms, attr_to_guess, None))

top_attr = _TOPOLOGY_ATTRS[attr_to_guess]

empty_values = top_attr.are_values_missing(attr_values)

if True in empty_values:
# pass to the guesser_method boolean mask to only guess the
# empty values
attr_values[empty_values] = self._guesser_methods[attr_to_guess](
indices_to_guess=empty_values)
attr_values[empty_values] = guesser_method(
indices_to_guess=empty_values
)
return attr_values

else:
Expand All @@ -159,7 +179,7 @@ def guess_attr(self, attr_to_guess, force_guess=False):
f'not guess any new values for {attr_to_guess} attribute')
return None
else:
return np.array(self._guesser_methods[attr_to_guess]())
return np.array(guesser_method())


def get_guesser(context, u=None, **kwargs):
Expand Down
128 changes: 128 additions & 0 deletions testsuite/MDAnalysisTests/guesser/test_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,11 @@
from MDAnalysis.core.topology import Topology
from MDAnalysis.core.topologyattrs import Masses, Atomnames, Atomtypes
import MDAnalysis.tests.datafiles as datafiles
from MDAnalysis.exceptions import NoDataError
from numpy.testing import assert_allclose, assert_equal

from MDAnalysis import _TOPOLOGY_ATTRS, _GUESSERS


class TestBaseGuesser():

Expand Down Expand Up @@ -101,6 +104,131 @@ def test_partial_guess_attr_with_unknown_no_value_label(self):
u = mda.Universe(top, to_guess=['types'])
assert_equal(u.atoms.types, ['', '', '', ''])

def test_guess_topology_objects_existing_read(self):
u = mda.Universe(datafiles.CONECT)
assert len(u.atoms.bonds) == 72
assert list(u.bonds[0].indices) == [623, 630]

# delete some bonds
u.delete_bonds(u.atoms.bonds[:10])
assert len(u.atoms.bonds) == 62
# first bond has changed
assert list(u.bonds[0].indices) == [1545, 1552]

all_indices = [tuple(x.indices) for x in u.bonds]
assert (623, 630) not in all_indices

# test guessing new bonds doesn't remove old ones
IAlibay marked this conversation as resolved.
Show resolved Hide resolved
u.guess_TopologyAttrs("default", to_guess=["bonds"])
assert len(u.atoms.bonds) == 1922
all_indices = [tuple(x.indices) for x in u.bonds]
assert (1545, 1552) in all_indices

def test_guess_topology_objects_existing_in_universe(self):
u = mda.Universe(datafiles.CONECT, to_guess=["bonds"])
assert len(u.atoms.bonds) == 1922
assert list(u.bonds[0].indices) == [0, 1]

# delete some bonds
u.delete_bonds(u.atoms.bonds[:100])
assert len(u.atoms.bonds) == 1822
assert list(u.bonds[0].indices) == [94, 99]

all_indices = [tuple(x.indices) for x in u.bonds]
assert (0, 1) not in all_indices

# guess old bonds back
u.guess_TopologyAttrs("default", to_guess=["bonds"])
assert len(u.atoms.bonds) == 1922
# check TopologyGroup contains new (old) bonds
assert list(u.bonds[0].indices) == [0, 1]

def test_guess_topology_objects_force(self):
u = mda.Universe(datafiles.CONECT, force_guess=["bonds"])
assert len(u.atoms.bonds) == 1922

with pytest.raises(NoDataError):
u.atoms.angles

def test_guess_topology_objects_out_of_order_init(self):
u = mda.Universe(
datafiles.PDB_small,
to_guess=["dihedrals", "angles", "bonds"],
guess_bonds=False
)
assert len(u.atoms.angles) == 6123
assert len(u.atoms.dihedrals) == 8921

def test_guess_topology_objects_out_of_order_guess(self):
u = mda.Universe(datafiles.PDB_small)
with pytest.raises(NoDataError):
u.atoms.angles

u.guess_TopologyAttrs(
"default",
to_guess=["dihedrals", "angles", "bonds"]
)
assert len(u.atoms.angles) == 6123
assert len(u.atoms.dihedrals) == 8921

def test_force_guess_overwrites_existing_bonds(self):
u = mda.Universe(datafiles.CONECT)
assert len(u.atoms.bonds) == 72

# This low radius should find no bonds
vdw = dict.fromkeys(set(u.atoms.types), 0.1)
u.guess_TopologyAttrs("default", to_guess=["bonds"], vdwradii=vdw)
assert len(u.atoms.bonds) == 72

# Now force guess bonds
u.guess_TopologyAttrs("default", force_guess=["bonds"], vdwradii=vdw)
assert len(u.atoms.bonds) == 0

def test_guessing_angles_respects_bond_kwargs(self):
u = mda.Universe(datafiles.PDB)
assert not hasattr(u.atoms, "angles")

# This low radius should find no angles
vdw = dict.fromkeys(set(u.atoms.types), 0.01)

u.guess_TopologyAttrs("default", to_guess=["angles"], vdwradii=vdw)
assert len(u.atoms.angles) == 0

# set higher radii for lots of angles!
vdw = dict.fromkeys(set(u.atoms.types), 1)
u.guess_TopologyAttrs("default", force_guess=["angles"], vdwradii=vdw)
assert len(u.atoms.angles) == 89466

def test_guessing_dihedrals_respects_bond_kwargs(self):
u = mda.Universe(datafiles.CONECT)
assert len(u.atoms.bonds) == 72

u.guess_TopologyAttrs("default", to_guess=["dihedrals"])
assert len(u.atoms.dihedrals) == 3548
assert not hasattr(u.atoms, "angles")

def test_guess_invalid_attribute(self):
default_guesser = get_guesser("default")
err = "not a recognized MDAnalysis topology attribute"
with pytest.raises(KeyError, match=err):
default_guesser.guess_attr('not_an_attribute')

def test_guess_unsupported_attribute(self):
default_guesser = get_guesser("default")
err = "cannot guess this attribute"
with pytest.raises(ValueError, match=err):
default_guesser.guess_attr('tempfactors')

def test_guess_singular(self):
default_guesser = get_guesser("default")
u = mda.Universe(datafiles.PDB, to_guess=[])
assert not hasattr(u.atoms, "masses")

default_guesser._universe = u
masses = default_guesser.guess_attr('mass')


IAlibay marked this conversation as resolved.
Show resolved Hide resolved


def test_Universe_guess_bonds_deprecated():
with pytest.warns(
Expand Down
Loading