pyrosetta.distributed.cluster.base.TaskBase Class Reference

Inheritance diagram for pyrosetta.distributed.cluster.base.TaskBase:

Private Member Functions
Optional[str]	_get_seed (self, Sized protocols)
Tuple[List[Callable[..., Any]], Callable[..., Any], Optional[str]]	_get_task_state (self, List[Callable[..., Any]] protocols)
Tuple[bytes, Dict[str, Any]]	_setup_initial_kwargs (self, List[Callable[..., Any]] protocols, Optional[str] seed, Dict[Any, Any] task)
Dict[str, Any]	_setup_pyrosetta_init_kwargs (self, Dict[Any, Any] kwargs)
int	_get_clients_index (self, List[int] clients_indices, List[Callable[..., Any]] protocols)
Optional[Dict[Any, Any]]	_get_resource (self, List[Dict[Any, Any]] resources, List[Callable[..., Any]] protocols)
Tuple[bytes, Dict[str, Any], Callable[..., Any], int, Optional[Dict[Any, Any]]]	_setup_kwargs (self, Dict[Any, Any] kwargs, List[int] clients_indices, Optional[Dict[Any, Any]] resources)
Dict[Any, Any]	_setup_seed (self, Dict[Any, Any] kwargs, Optional[str] seed)
Tuple[List[Callable[..., Any]], Callable[..., Any], Optional[str], int, Optional[Dict[Any, Any]]]	_setup_protocols_protocol_seed (self, Tuple[Any,...] args, Any protocols, Any clients_indices, Any resources)

Detailed Description

Task objects underpinning PyRosettaCluster.

Member Function Documentation

_get_clients_index()

int pyrosetta.distributed.cluster.base.TaskBase._get_clients_index (   self, List[int]  clients_indices, List[Callable[..., Any]]   protocols  )

private

Return the clients index for the current protocol.

References ObjexxFCL.len().

Referenced by pyrosetta.distributed.cluster.base.TaskBase._setup_kwargs(), and pyrosetta.distributed.cluster.base.TaskBase._setup_protocols_protocol_seed().

_get_resource()

Optional[Dict[Any, Any]] pyrosetta.distributed.cluster.base.TaskBase._get_resource (   self, List[Dict[Any, Any]]  resources, List[Callable[..., Any]]   protocols  )

private

Return the resource for the current protocol.

References ObjexxFCL.len().

Referenced by pyrosetta.distributed.cluster.base.TaskBase._setup_kwargs(), and pyrosetta.distributed.cluster.base.TaskBase._setup_protocols_protocol_seed().

_get_seed()

Optional[str] pyrosetta.distributed.cluster.base.TaskBase._get_seed (   self, Sized  protocols  )

private

Get the seed for the input user-provided PyRosetta protocol.

References ObjexxFCL.len(), and pyrosetta.distributed.cluster.core.PyRosettaCluster.seeds.

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

_get_task_state()

Tuple[List[Callable[..., Any]], Callable[..., Any], Optional[str]] pyrosetta.distributed.cluster.base.TaskBase._get_task_state (   self, List[Callable[..., Any]]   protocols  )

private

Given the current state of protocols, returns a tuple of the updated
state of protocols and current protocol and seed.

References pyrosetta.distributed.cluster.base.TaskBase._get_seed().

Referenced by pyrosetta.distributed.cluster.base.TaskBase._setup_kwargs(), and pyrosetta.distributed.cluster.base.TaskBase._setup_protocols_protocol_seed().

_setup_initial_kwargs()

Tuple[bytes, Dict[str, Any]] pyrosetta.distributed.cluster.base.TaskBase._setup_initial_kwargs (   self, List[Callable[..., Any]]  protocols, Optional[str]  seed, Dict[Any, Any]  task  )

private

Setup the kwargs for the initial task.

References pyrosetta.distributed.cluster.base.TaskBase._setup_pyrosetta_init_kwargs(), pyrosetta.distributed.cluster.base.TaskBase._setup_seed(), pyrosetta.distributed.cluster.core.PyRosettaCluster.logging_file, pyrosetta.distributed.cluster.core.PyRosettaCluster.output_path, pyrosetta.distributed.cluster.core.PyRosettaCluster.protocols_key, and pyrosetta.distributed.cluster.core.PyRosettaCluster.serializer.

Referenced by pyrosetta.distributed.cluster.core.PyRosettaCluster._run().

_setup_kwargs()

Tuple[bytes, Dict[str, Any], Callable[..., Any], int, Optional[Dict[Any, Any]]] pyrosetta.distributed.cluster.base.TaskBase._setup_kwargs (   self, Dict[Any, Any]  kwargs, List[int]  clients_indices, Optional[Dict[Any, Any]]  resources  )

private

Setup the kwargs for the subsequent tasks.

References pyrosetta.distributed.cluster.base.TaskBase._get_clients_index(), pyrosetta.distributed.cluster.base.TaskBase._get_resource(), pyrosetta.distributed.cluster.base.TaskBase._get_task_state(), pyrosetta.distributed.cluster.base.TaskBase._setup_pyrosetta_init_kwargs(), pyrosetta.distributed.cluster.base.TaskBase._setup_seed(), pyrosetta.distributed.cluster.core.PyRosettaCluster.protocols_key, and pyrosetta.distributed.cluster.core.PyRosettaCluster.serializer.

Referenced by pyrosetta.distributed.cluster.core.PyRosettaCluster._run().

_setup_protocols_protocol_seed()

Tuple[List[Callable[..., Any]], Callable[..., Any], Optional[str], int, Optional[Dict[Any, Any]]] pyrosetta.distributed.cluster.base.TaskBase._setup_protocols_protocol_seed (   self, Tuple[Any, ...]  args, Any  protocols, Any  clients_indices, Any  resources  )

private

Parse, validate, and setup the user-provided PyRosetta protocol(s).

References pyrosetta.distributed.cluster.base.TaskBase._get_clients_index(), pyrosetta.distributed.cluster.base.TaskBase._get_resource(), pyrosetta.distributed.cluster.base.TaskBase._get_task_state(), pyrosetta.distributed.cluster.converters._parse_protocols(), pyrosetta.distributed.cluster.validators._validate_clients_indices(), pyrosetta.distributed.cluster.validators._validate_protocols_seeds_decoy_ids(), pyrosetta.distributed.cluster.validators._validate_resources(), pyrosetta.distributed.cluster.core.PyRosettaCluster.clients_dict, pyrosetta.distributed.cluster.core.PyRosettaCluster.decoy_ids, basic::options::OptionKeys::in::file.list, and pyrosetta.distributed.cluster.core.PyRosettaCluster.seeds.

Referenced by pyrosetta.distributed.cluster.core.PyRosettaCluster._run().

_setup_pyrosetta_init_kwargs()

Dict[str, Any] pyrosetta.distributed.cluster.base.TaskBase._setup_pyrosetta_init_kwargs (   self, Dict[Any, Any]  kwargs  )

private

References pyrosetta.distributed.cluster.core.PyRosettaCluster.pyrosetta_init_args.

Referenced by pyrosetta.distributed.cluster.base.TaskBase._setup_initial_kwargs(), and pyrosetta.distributed.cluster.base.TaskBase._setup_kwargs().

_setup_seed()

Dict[Any, Any] pyrosetta.distributed.cluster.base.TaskBase._setup_seed (   self, Dict[Any, Any]  kwargs, Optional[str]  seed  )

private

Setup the 'options' or 'extra_options' task kwargs with the `-run:jran`
PyRosetta command line flag.

References pyrosetta.distributed._normflags().

Referenced by pyrosetta.distributed.cluster.base.TaskBase._setup_initial_kwargs(), and pyrosetta.distributed.cluster.base.TaskBase._setup_kwargs().

---

The documentation for this class was generated from the following file:

• src/python/PyRosetta/src/pyrosetta/distributed/cluster/base.py