analysis module

Full Documentation for hippynn.layers.pairs.analysis module. Click here for a summary page.

Modules for analyzing pair-valued data

class MinDistModule(*args, **kwargs)[source]

Bases: Module

forward(rmag_list, j_list, mol_index, atom_index, inv_real_atoms, n_atoms_max, n_molecules)[source]

Define the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

class RDFBins(bins, species_set)[source]

Bases: Module

bin_info()[source]
forward(pair_dist, pair_first, pair_second, one_hot, n_molecules)[source]

Define the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

min_dist_info(rij_list, j_list, mol_index, atom_index, inv_real_atoms, n_atoms_max, n_molecules)[source]