openprotein.prompt.Prompt#

class openprotein.prompt.Prompt(session, job=None, metadata=None, num_replicates=None)[source]#

Prompt which contains a set of sequences and/or structures used to condition the PoET models.

Parameters:

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

Initialize a new Prompt instance.

Parameters:

session (APISession) – An APISession object used for interacting with the API.
job (PromptJob | None) – A PromptJob containing information about the optional prompt job.
metadata (PromptMetadata) – A PromptMetadata object containing metadata for the prompt.
num_replicates (int | None)

Methods

`__init__`(session[, job, metadata, ...])	Initialize a new Prompt instance.
`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`()	Return the results from this job.
`refresh`()	Refresh the job status and internal job object.
`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

`created_date`	The creation timestamp of the job.
`description`
`end_date`	The end timestamp of the job.
`id`	The unique identifier of the job.
`job_id`	The unique identifier of the job.
`job_type`	The type of the job.
`name`
`num_replicates`
`progress_counter`	The progress counter of the job.
`start_date`	The start timestamp of the job.
`status`	The current status of the job.
`metadata`
`session`
`job`