pyrosetta.distributed.cluster.validators Namespace Reference

Functions
Optional[NoReturn]	_validate_clients_indices (Any clients_indices, List[Callable[..., Any]] _protocols, List[int] _clients_dict_keys)
Optional[NoReturn]	_validate_resources (Any resources, List[Callable[..., Any]] _protocols)
Optional[NoReturn]	_validate_dirs (self, str attribute, Any value)
Optional[NoReturn]	_validate_dir (self, str attribute, str value)
Optional[NoReturn]	_validate_int (self, str attribute, int value)
Optional[NoReturn]	_validate_min_len (self, str attribute, Optional[List[Any]] value)
Optional[NoReturn]	_validate_float (self, str attribute, Union[float, int] value)
Union[List[Union[Callable[..., Any], Iterable[Any]]], NoReturn]	_validate_protocols_seeds_decoy_ids (List[Union[Callable[..., Any], Iterable[Any]]] protocols, List[str] seeds, List[int] decoy_ids)
Optional[NoReturn]	_validate_residue_type_sets (Optional[AbstractSet[str]] _target_residue_type_set=None, Optional[AbstractSet[str]] _client_residue_type_set=None)

Variables
string	__author__ = "Jason C. Klima"

Function Documentation

_validate_clients_indices()

Optional[NoReturn] pyrosetta.distributed.cluster.validators._validate_clients_indices ( Any  clients_indices, List[Callable[..., Any]]  _protocols, List[int]  _clients_dict_keys  )

private

Validate the `clients_indices` keyword argument parameter.

References all, ObjexxFCL.len(), and set().

Referenced by pyrosetta.distributed.cluster.base.TaskBase._setup_protocols_protocol_seed().

_validate_dir()

Optional[NoReturn] pyrosetta.distributed.cluster.validators._validate_dir (   self, str  attribute, str  value  )

private

Validate the scratch directory.

_validate_dirs()

Optional[NoReturn] pyrosetta.distributed.cluster.validators._validate_dirs (   self, str  attribute, Any  value  )

private

Validate the output, logging, and decoy directories.

_validate_float()

Optional[NoReturn] pyrosetta.distributed.cluster.validators._validate_float (   self, str  attribute, Union[float, int]   value  )

private

Validate that floats are greater than or equal to 0.0

References run_backbone.float.

_validate_int()

Optional[NoReturn] pyrosetta.distributed.cluster.validators._validate_int (   self, str  attribute, int  value  )

private

Validate that integers are greater than or equal to 1.

_validate_min_len()

Optional[NoReturn] pyrosetta.distributed.cluster.validators._validate_min_len (   self, str  attribute, Optional[List[Any]]  value  )

private

Optionally validate that iterables have at least one object.

References ObjexxFCL.len().

_validate_protocols_seeds_decoy_ids()

Union[List[Union[Callable[..., Any], Iterable[Any]]], NoReturn] pyrosetta.distributed.cluster.validators._validate_protocols_seeds_decoy_ids ( List[Union[Callable[..., Any], Iterable[Any]]]  protocols, List[str]  seeds, List[int]  decoy_ids  )

private

Validate that the user-provided PyRosetta protocols and PyRosettaCluster
`seeds` and `decoy_ids` attributes have the same size.

References ObjexxFCL.len().

Referenced by pyrosetta.distributed.cluster.base.TaskBase._setup_protocols_protocol_seed().

_validate_residue_type_sets()

Optional[NoReturn] pyrosetta.distributed.cluster.validators._validate_residue_type_sets ( Optional[AbstractSet[str]]   _target_residue_type_set = None, Optional[AbstractSet[str]]   _client_residue_type_set = None  )

private

Validate that the compute instance (distributed worker) ResidueType set equals
client instance (local host) ResidueType set.

Referenced by pyrosetta.distributed.cluster.multiprocessing.target().

_validate_resources()

Optional[NoReturn] pyrosetta.distributed.cluster.validators._validate_resources ( Any  resources, List[Callable[..., Any]]  _protocols  )

private

Validate the `resources` keyword argument parameter.

References ObjexxFCL.len().

Referenced by pyrosetta.distributed.cluster.base.TaskBase._setup_protocols_protocol_seed().

Variable Documentation

__author__

string pyrosetta.distributed.cluster.validators.__author__ = "Jason C. Klima"

private