pyrosetta.distributed.cluster.multiprocessing Namespace Reference

Functions
Any	user_protocol (PackedPose packed_pose, Callable[..., Any] protocol, bool ignore_errors, **Dict[Any, Any] kwargs)
List[Tuple[bytes, bytes]]	run_protocol (Callable[..., Any] protocol, PackedPose packed_pose, str DATETIME_FORMAT, bool ignore_errors, str protocols_key, List[int] decoy_ids, S serializer, **Dict[Any, Any] kwargs)
List[Tuple[Optional[bytes], bytes]]	get_target_results_kwargs (Q q, P p, bytes compressed_kwargs, str protocol_name, Union[float, int] timeout, bool ignore_errors)
None	target (Callable[..., Any] protocol, bytes compressed_packed_pose, bytes compressed_kwargs, Q q, str logging_file, str logging_level, str DATETIME_FORMAT, bool ignore_errors, str protocols_key, List[int] decoy_ids, Optional[Union[str, bool]] compression, AbstractSet[str] client_residue_type_set, str client_repr, **Dict[str, Any] pyrosetta_init_kwargs)
List[Tuple[Optional[Union[PackedPose, bytes]], Union[Dict[Any, Any], bytes]]]	user_spawn_thread (Callable[..., Any] protocol, bytes compressed_packed_pose, bytes compressed_kwargs, Dict[str, Any] pyrosetta_init_kwargs, List[int] decoy_ids, str protocols_key, Union[float, int] timeout, bool ignore_errors, str logging_file, str logging_level, str DATETIME_FORMAT, Optional[Union[str, bool]] compression, AbstractSet[str] client_residue_type_set)

Variables
string	__author__ = "Jason C. Klima"
	Q = TypeVar("Q", bound=billiard.Queue)
	P = TypeVar("P", bound=billiard.context.Process)
	S = TypeVar("S", bound=Serialization)

Function Documentation

get_target_results_kwargs()

List[Tuple[Optional[bytes], bytes]] pyrosetta.distributed.cluster.multiprocessing.get_target_results_kwargs	(	Q	q,
		P	p,
		bytes	compressed_kwargs,
		str	protocol_name,
		Union[float, int]	timeout,
		bool	ignore_errors
	)

Get and parse the billiard subprocess results.

References pyrosetta.distributed.cluster.converters._parse_empty_queue(), and pyrosetta.distributed.cluster.converters._parse_target_results().

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

run_protocol()

List[Tuple[bytes, bytes]] pyrosetta.distributed.cluster.multiprocessing.run_protocol	(	Callable[..., Any]	protocol,
		PackedPose	packed_pose,
		str	DATETIME_FORMAT,
		bool	ignore_errors,
		str	protocols_key,
		List[int]	decoy_ids,
		S	serializer,
		**Dict[Any, Any]	kwargs
	)

Parse the user-provided PyRosetta protocol results.

References pyrosetta.distributed.cluster.converters._parse_protocol_results(), and pyrosetta.distributed.cluster.multiprocessing.user_protocol().

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

target()

None pyrosetta.distributed.cluster.multiprocessing.target	(	Callable[..., Any]	protocol,
		bytes	compressed_packed_pose,
		bytes	compressed_kwargs,
		Q	q,
		str	logging_file,
		str	logging_level,
		str	DATETIME_FORMAT,
		bool	ignore_errors,
		str	protocols_key,
		List[int]	decoy_ids,
		Optional[Union[str, bool]]	compression,
		AbstractSet[str]	client_residue_type_set,
		str	client_repr,
		**Dict[str, Any]	pyrosetta_init_kwargs
	)

A wrapper function for a user-provided PyRosetta protocol.

References pyrosetta.distributed.cluster.validators._validate_residue_type_sets(), and pyrosetta.distributed.cluster.multiprocessing.run_protocol().

user_protocol()

Any pyrosetta.distributed.cluster.multiprocessing.user_protocol	(	PackedPose	packed_pose,
		Callable[..., Any]	protocol,
		bool	ignore_errors,
		**Dict[Any, Any]	kwargs
	)

Run the user-provided PyRosetta protocol.

References basic::options::OptionKeys::docking::ligand.protocol.

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

user_spawn_thread()

List[Tuple[Optional[Union[PackedPose, bytes]], Union[Dict[Any, Any], bytes]]] pyrosetta.distributed.cluster.multiprocessing.user_spawn_thread	(	Callable[..., Any]	protocol,
		bytes	compressed_packed_pose,
		bytes	compressed_kwargs,
		Dict[str, Any]	pyrosetta_init_kwargs,
		List[int]	decoy_ids,
		str	protocols_key,
		Union[float, int]	timeout,
		bool	ignore_errors,
		str	logging_file,
		str	logging_level,
		str	DATETIME_FORMAT,
		Optional[Union[str, bool]]	compression,
		AbstractSet[str]	client_residue_type_set
	)

Generic worker task using the billiard multiprocessing module.

References pyrosetta.distributed.cluster.multiprocessing.get_target_results_kwargs().

Variable Documentation

__author__

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

private

P

pyrosetta.distributed.cluster.multiprocessing.P = TypeVar("P", bound=billiard.context.Process)

Q

pyrosetta.distributed.cluster.multiprocessing.Q = TypeVar("Q", bound=billiard.Queue)

S

pyrosetta.distributed.cluster.multiprocessing.S = TypeVar("S", bound=Serialization)