sensitivity module

Full Documentation for hippynn.layers.hiplayers.sensitivity module. Click here for a summary page.

Layers for HIP-NN

class CosCutoff(hard_max_dist)

Bases: Module

forward(dist_tensor)

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 GaussianSensitivityModule(n_dist, min_dist_soft, max_dist_soft, hard_max_dist, cutoff_type=<class 'hippynn.layers.hiplayers.sensitivity.CosCutoff'>)

Bases: SensitivityModule

forward(distflat, warn_low_distances=None)

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 InverseSensitivityModule(n_dist, min_dist_soft, max_dist_soft, hard_max_dist, cutoff_type=<class 'hippynn.layers.hiplayers.sensitivity.CosCutoff'>)

Bases: SensitivityModule

forward(distflat, warn_low_distances=None)

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 SensitivityBottleneck(n_dist, min_soft_dist, max_dist_soft, hard_max_dist, n_dist_bare, cutoff_type=<class 'hippynn.layers.hiplayers.sensitivity.CosCutoff'>, base_sense=<class 'hippynn.layers.hiplayers.sensitivity.InverseSensitivityModule'>)

Bases: Module

forward(distflat)

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 SensitivityModule(hard_max_dist, cutoff_type)

Bases: Module

warn_if_under(distance, threshold)