pyrosetta.distributed.utility.log.ProgressLogger Class Reference

Inheritance diagram for pyrosetta.distributed.utility.log.ProgressLogger:

Public Member Functions
def	__init__ (self, logger, prefix, level=logging.INFO, seconds=None, iterations=None, fraction=None, total=None)
def	increment (self, by=1)
def	__iadd__ (self, other)
def	logging_iter (self, iterable)
def	count (self, start=0, step=1)
def	iterate (self, sequence)
def	enumerate (self, sequence)

Public Attributes
	logger
	level
	prefix
	seconds
	iterations
	fraction
	total
	iteration
	last_iteration
	start_time
	last_time

Detailed Description

Issues incremental log messages for a set of tasks.

Constructor & Destructor Documentation

__init__()

def pyrosetta.distributed.utility.log.ProgressLogger.__init__	(		self,
			logger,
			prefix,
			level = logging.INFO,
			seconds = None,
			iterations = None,
			fraction = None,
			total = None
	)

Initialize progress logger.

logger - target logger
level - target log level
prefix - string prefix in log message
seconds - emit log message after given seconds seconds
iterations - emit log message after given interations
fraction - emit log message at given fraction of total run, valid only if total provided
total - total number of tasks

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

Member Function Documentation

__iadd__()

def pyrosetta.distributed.utility.log.ProgressLogger.__iadd__	(		self,
			other
	)

References HBondedPairIterator.increment(), and pyrosetta.distributed.utility.log.ProgressLogger.increment().

count()

def pyrosetta.distributed.utility.log.ProgressLogger.count	(		self,
			start = 0,
			step = 1
	)

Generator returning evenly spaced values starting with n, incrementing on iteration.

Referenced by pyrosetta.distributed.utility.log.ProgressLogger.enumerate().

enumerate()

def pyrosetta.distributed.utility.log.ProgressLogger.enumerate	(		self,
			sequence
	)

Return a generator that enumerates an iterable, performing increment calls on each iteration.

If sequence is sized and self.total is None, self.total will be updated to length of sequence.

References Tensor.count, numeric::geometry::hashing::Counter.count, numeric::model_quality::RmsData.count(), detail::counting_buffer< T >.count(), detail::buffer_traits.count(), detail::fixed_buffer_traits.count(), detail::iterator_buffer< OutputIt, T, Traits >.count(), detail::counting_iterator.count(), detail::truncating_iterator_base< OutputIt >.count(), pyrosetta.distributed.utility.log.ProgressLogger.count(), ObjexxFCL.len(), ScoreBreakdown.total, pyrosetta.distributed.utility.log.ProgressLogger.total, and basic::options::OptionKeys::in::file.zip.

increment()

def pyrosetta.distributed.utility.log.ProgressLogger.increment	(		self,
			by = 1
	)

Indicate that 'by' tasks have been completed and log if needed.

References pyrosetta.distributed.utility.log.ProgressLogger.fraction, schema.Trajectory.iteration, pyrosetta.distributed.utility.log.ProgressLogger.iteration, SamplingManager.iterations, apps::pilot::KicSandbox.iterations, schema.Job.iterations, pyrosetta.distributed.utility.log.ProgressLogger.iterations, pyrosetta.distributed.utility.log.ProgressLogger.last_iteration, pyrosetta.distributed.utility.log.ProgressLogger.last_time, schema.Temperature.level, SphereNode.level(), basic::TracerOptions.level, pyrosetta.distributed.utility.log.ProgressLogger.level, pyrosetta.distributed.utility.log.LoggingContext.level, ui::network::IndexPack.level, numeric.log(), pyrosetta.distributed.utility.log.LoggerMixin.logger(), pyrosetta.distributed.utility.log.ProgressLogger.logger, pyrosetta.distributed.utility.log.LoggingContext.logger, binder::Config.prefix, formatting_range< Char, Enable >.prefix, utility::io::TarFileHeader.prefix, detail::int_writer< OutputIt, Char, UInt >.prefix, formatting_tuple< Char, Enable >.prefix, pyrosetta.distributed.utility.log.ProgressLogger.prefix, utility::options::OptionCollection.prefix(), pyrosetta.distributed.utility.log.ProgressLogger.seconds, ScoreBreakdown.total, and pyrosetta.distributed.utility.log.ProgressLogger.total.

Referenced by pyrosetta.distributed.utility.log.ProgressLogger.__iadd__(), and pyrosetta.distributed.utility.log.ProgressLogger.iterate().

iterate()

def pyrosetta.distributed.utility.log.ProgressLogger.iterate	(		self,
			sequence
	)

Return a generator that wraps an iterable, performing increment calls on each iteration.

If sequence is sized and self.total is None, self.total will be updated to length of sequence.

References HBondedPairIterator.increment(), pyrosetta.distributed.utility.log.ProgressLogger.increment(), ObjexxFCL.len(), ScoreBreakdown.total, and pyrosetta.distributed.utility.log.ProgressLogger.total.

logging_iter()

def pyrosetta.distributed.utility.log.ProgressLogger.logging_iter	(		self,
			iterable
	)

Wrap iterator in logging increment.

Member Data Documentation

fraction

pyrosetta.distributed.utility.log.ProgressLogger.fraction

Referenced by pyrosetta.distributed.utility.log.ProgressLogger.increment().

iteration

pyrosetta.distributed.utility.log.ProgressLogger.iteration

Referenced by schema.Trajectory.__repr__(), and pyrosetta.distributed.utility.log.ProgressLogger.increment().

iterations

pyrosetta.distributed.utility.log.ProgressLogger.iterations

Referenced by pyrosetta.distributed.utility.log.ProgressLogger.increment().

last_iteration

pyrosetta.distributed.utility.log.ProgressLogger.last_iteration

Referenced by pyrosetta.distributed.utility.log.ProgressLogger.increment().

last_time

pyrosetta.distributed.utility.log.ProgressLogger.last_time

Referenced by pyrosetta.distributed.utility.log.ProgressLogger.increment().

level

pyrosetta.distributed.utility.log.ProgressLogger.level

Referenced by pyrosetta.distributed.utility.log.LoggingContext.__enter__(), pyrosetta.distributed.utility.log.LoggingContext.__exit__(), schema.Temperature.__repr__(), and pyrosetta.distributed.utility.log.ProgressLogger.increment().

logger

pyrosetta.distributed.utility.log.ProgressLogger.logger

Referenced by pyrosetta.distributed.utility.log.LoggingContext.__exit__(), pyrosetta.distributed.utility.log.ProgressLogger.increment(), and pyrosetta.distributed.tasks.taskbase.TaskBase.maybe_setup().

prefix

pyrosetta.distributed.utility.log.ProgressLogger.prefix

Referenced by pyrosetta.distributed.utility.log.ProgressLogger.increment().

seconds

pyrosetta.distributed.utility.log.ProgressLogger.seconds

Referenced by pyrosetta.distributed.utility.log.ProgressLogger.increment().

start_time

pyrosetta.distributed.utility.log.ProgressLogger.start_time

Referenced by schema.Job.duration().

total

pyrosetta.distributed.utility.log.ProgressLogger.total

Referenced by pyrosetta.distributed.utility.log.ProgressLogger.enumerate(), pyrosetta.distributed.utility.log.ProgressLogger.increment(), and pyrosetta.distributed.utility.log.ProgressLogger.iterate().

---

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

• src/python/PyRosetta/src/pyrosetta/distributed/utility/log.py