openprotein.design.DesignFuture#

class openprotein.design.DesignFuture(session, job=None, metadata=None)[source]#

A future object that will hold the results of the design job.

Parameters:

__init__(session, job=None, metadata=None)[source]#

Construct a future for a design job.

Takes in either a design job, or the design metadata.

Parameters:

Methods

`__init__`(session[, job, metadata])	Construct a future for a design job.
`cancelled`()	Check if the job has been cancelled.
`create`(session[, job_id, job, response])	Create an instance of the appropriate Future class based on the job type.
`done`()	Check if the job has completed.
`get`([verbose])	Return all results from the job by consuming the stream.
`get_assay`()	Get assay used for design job.
`refresh`()	Refresh the job status and internal job object.
`stream`([step])	Return the results from this job as a generator.
`wait`([interval, timeout, verbose])	Wait for the job to complete, then fetch results.
`wait_until_done`([interval, timeout, verbose])	Wait for the job to complete.

Attributes

`algorithm`	Algorithm used in the design.
`allowed_tokens`	Allowed tokens used in the design.
`assay`	Assay used in the design.
`created_date`	The creation timestamp of the job.
`criteria`	Criteria used in the design.
`crossover_prob`	Crossover probability used in the design.
`crossover_prob_pointwise`	Crossover probability pointwise used in the design.
`end_date`	The end timestamp of the job.
`id`	ID of the design.
`job_id`	The unique identifier of the job.
`job_type`	The type of the job.
`metadata`	Design metadata.
`mutation_average_mutations_per_seq`	Average mutations per sequence used in the design.
`n_offsprings`	Number of offsprings used in the design.
`num_rows`	Number of rows in the total design output (across all steps).
`num_steps`	Number of steps used in the design.
`pop_size`	Population size used in the design.
`progress_counter`	The progress counter of the job.
`start_date`	The start timestamp of the job.
`status`	The current status of the job.
`job`
`session`