pyrosetta.distributed.tasks.taskbase.TaskBase Class Reference

Inheritance diagram for pyrosetta.distributed.tasks.taskbase.TaskBase:

Public Member Functions
def	__repr__
def	__name__
def	__getstate__
def	__setstate__
def	maybe_setup
def	setup
def	execute
def	__call__
Public Member Functions inherited from pyrosetta.distributed.utility.log.LoggerMixin
def	logger

Public Attributes
	is_setup

Detailed Description

Base class for traitlets-based callable, pickle-able task objects.

Callable-base parallelization frameworks rely on two core properties to define a task:
    - The task must be callable, defining a sensible __call__ attribute.
    - The task must be pickle-able.

Function objects fulfill these requirements, however parallelization frameworks differ in their
support of variable closures. Additionally, tasks may require the execution of a relatively costly
initialization procedure to support rapid execution against a large number of input arguments.

The TaskBase object is designed to capture the behavior of a functional
closure, support single-run setup, and defining two types of member attributes:
    state    - pickle-able configuration attributes defining the behavior of
               the task object.
    run data - attributes required to execute the task that can be
               generated from configuration state

Tasks partition between these classes by annotating state as traitlets, and
run data as arbitrary attributes. Tasks are then pickled by capturing
all named traites.

Member Function Documentation

def pyrosetta.distributed.tasks.taskbase.TaskBase.__call__	(		self,
			args,
			kwargs
	)

References pyrosetta.distributed.tasks.taskbase.TaskBase.execute(), and pyrosetta.distributed.tasks.taskbase.TaskBase.maybe_setup().

def pyrosetta.distributed.tasks.taskbase.TaskBase.__getstate__

(

self

)

def pyrosetta.distributed.tasks.taskbase.TaskBase.__name__

(

self

)

References pyrosetta.distributed.docs.ComponentDoc.__repr__(), pyrosetta.distributed.tasks.taskbase.TaskBase.__repr__(), arls_impl.DockingFile.__repr__(), pyrosetta.bindings.pose.ResidueLabelAccessor.__repr__(), and pyrosetta.bindings.pose.PoseResidueLabelAccessor.__repr__().

def pyrosetta.distributed.tasks.taskbase.TaskBase.__repr__

(

self

)

References fmt.join().

Referenced by pyrosetta.distributed.tasks.taskbase.TaskBase.__name__().

def pyrosetta.distributed.tasks.taskbase.TaskBase.__setstate__	(		self,
			state
	)

References pyrosetta.distributed.docs.ComponentDoc.__init__(), pyrosetta.distributed.utility.log.classproperty.__init__(), test.Workshop9_my_shapes.MyShape.__init__(), pyrosetta.distributed.tasks.score.ScorePoseTask.__init__(), sidechain_cst_3.Residue.__init__(), erraser_option.erraser_option.__init__(), pyrosetta.protocols.structure_search.StructureSearchManager.__init__(), test.T850_SubClassing.PyValue.__init__(), options.KeepSameFile.__init__(), test.Workshop9_my_shapes.MyCircle.__init__(), pyrosetta.tests.distributed.test_gil.HeartBeat.__init__(), test.T860_SubClassing_EnergyMethods.MyCI1B_Method.__init__(), test.T850_SubClassing.A.__init__(), test.T870_SubClassing_EnergyMethods2.CI1B_Method.__init__(), pyrosetta.distributed.cluster.logging_support.LoggingSupport.__init__(), sidechain_cst_3.Atom.__init__(), test.T007_TracerIO.MyPyTracer.__init__(), pyrosetta.distributed.tasks.rosetta_scripts.BaseRosettaScriptsTask.__init__(), options_class.Option.__init__(), pyrosetta.distributed.packed_pose.core.PackedPose.__init__(), test.Workshop9_my_shapes.MySquare.__init__(), pyrosetta.distributed.viewer.modules.setBackgroundColor.__init__(), pyrosetta.distributed.cluster.exceptions.InputError.__init__(), arls_impl.DockingCase.__init__(), test.T870_SubClassing_EnergyMethods2.CI2B_Method.__init__(), pyrosetta.distributed.viewer.core.Viewer.__init__(), pyrosetta.io.silent_file_map.SilentFilePoseAccessor.__init__(), pyrosetta.network.rosetta_udp_to_tcp_bridge.PR_UDPServer.__init__(), pyrosetta.protocols.h5_fragment_store_provider.H5PyFragmentStoreProvider.__init__(), pyrosetta.logging_support.PythonLoggingSink.__init__(), pyrosetta.distributed.cluster.exceptions.InputFileError.__init__(), pyrosetta.PythonPyExitCallback.__init__(), pyrosetta.toolbox.py_jobdistributor.PyJobDistributor.__init__(), test.Workshop9_my_shapes.PhiNByXDegreesMover.__init__(), pyrosetta.distributed.utility.log.ProgressLogger.__init__(), arls_impl.DockingFile.__init__(), pyrosetta.distributed.cluster.exceptions.OutputError.__init__(), test.T850_SubClassing.PyOverloadTest.__init__(), test.T870_SubClassing_EnergyMethods2.CD2B_Method.__init__(), pyrosetta.distributed.viewer.modules.setDisulfides.__init__(), pyrosetta.distributed.cluster.exceptions.WorkerError.__init__(), pyrosetta.io.silent_file_map.SilentFileEnergyAccessor.__init__(), test.Workshop9_my_shapes.LengthScoreMethod.__init__(), test.T850_SubClassing.My_New_Mover.__init__(), test.Workshop9_my_shapes.CI2BScoreMethod.__init__(), pyrosetta.io.silent_file_map.SilentFileMap.__init__(), test.T850_SubClassing.MyNewCI1B_Creator.__init__(), pyrosetta.distributed.viewer.modules.setHydrogenBonds.__init__(), test.T850_SubClassing.MyNewCI1B.__init__(), pyrosetta.bindings.pose.PoseResidueAccessor.__init__(), pyrosetta.distributed.utility.log.Plog.__init__(), mutant_modeler.MutantModeler.__init__(), pyrosetta.distributed.utility.log.LoggingContext.__init__(), pyrosetta.distributed.viewer.core.ViewerInputError.__init__(), pyrosetta.distributed.viewer.modules.setHydrogens.__init__(), pyrosetta.PyMOLRosettaServer.PR_UDPServer.__init__(), PyMOL-RosettaServer.PR_UDPServer.__init__(), PyMOL-Rosetta-relay-client.PR_UDPServer.__init__(), pyrosetta.bindings.pose.ResidueLabelAccessor.__init__(), pyrosetta.bindings.pose.PoseResidueLabelMaskAccessor.__init__(), pyrosetta.bindings.pose.PoseResidueLabelAccessor.__init__(), pyrosetta.EnergyMethod.__init__(), pyrosetta.distributed.viewer.modules.setStyle.__init__(), pyrosetta.bindings.pose.PoseScoreAccessor.__init__(), pyrosetta.distributed.viewer.modules.setSurface.__init__(), pyrosetta.distributed.viewer.modules.setZoom.__init__(), pyrosetta.distributed.viewer.modules.setZoomTo.__init__(), pyrosetta.distributed.viewer.modules.ViewerInputError.__init__(), pyrosetta.PyMOLRosettaServer.XYZCoord.__init__(), PyMOL-RosettaServer.XYZCoord.__init__(), pyrosetta.PyMOLRosettaServer.PlanePoints.__init__(), PyMOL-RosettaServer.PlanePoints.__init__(), PyMOL-Rosetta-relay-client.XYZCoord.__init__(), pyrosetta.PyMOLRosettaServer.Matrix.__init__(), PyMOL-RosettaServer.Matrix.__init__(), PyMOL-Rosetta-relay-client.PlanePoints.__init__(), PyMOL-Rosetta-relay-client.Matrix.__init__(), and PyMOL-Rosetta-relay-client.SecretInputDialog.__init__().

def pyrosetta.distributed.tasks.taskbase.TaskBase.execute

(

self

)

Referenced by pyrosetta.distributed.tasks.taskbase.TaskBase.__call__().

def pyrosetta.distributed.tasks.taskbase.TaskBase.maybe_setup

(

self

)

References pyrosetta.distributed.tasks.score.ScorePoseTask.setup(), pyrosetta.distributed.tasks.rosetta_scripts.BaseRosettaScriptsTask.setup(), pyrosetta.distributed.tasks.taskbase.TaskBase.setup(), LigandDockBench.setup(), zinc2_homodimer_design.setup(), zinc1_homodimer_design.setup(), HPatchByChainNPDCalculator.setup(), and NBuriedUnsatsCalcultor.setup().

Referenced by pyrosetta.distributed.tasks.taskbase.TaskBase.__call__().

def pyrosetta.distributed.tasks.taskbase.TaskBase.setup

(

self

)

Referenced by pyrosetta.distributed.tasks.taskbase.TaskBase.maybe_setup().

Member Data Documentation

pyrosetta.distributed.tasks.taskbase.TaskBase.is_setup

---

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

• src/python/PyRosetta/src/pyrosetta/distributed/tasks/taskbase.py