openprotein.fold.FoldResultFuture#

class openprotein.fold.FoldResultFuture(session, job=None, metadata=None, sequences=None, max_workers=10)[source]#

Fold results represented as a future.

Parameters:
  • session (APISession)

  • job (FoldJob)

  • metadata (FoldMetadata | None)

  • sequences (list[bytes] | None)

  • max_workers (int)

job#

The fold job associated with this future.

Type:

FoldJob

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

Initialize a FoldResultFuture instance.

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

Parameters:
  • session (APISession)

  • job (FoldJob | None)

  • metadata (FoldMetadata | None)

  • sequences (list[bytes] | None)

  • max_workers (int)

Methods

__init__(session[, job, metadata, ...])

Initialize a FoldResultFuture instance.

cancelled()

Check if the job has been cancelled.

create(session[, job, metadata])

Factory method to create a FoldResultFuture or FoldComplexResultFuture.

done()

Check if the job has completed.

get([verbose])

Retrieve the fold results as a list of tuples mapping sequence to PDB-encoded string.

get_item(sequence)

Get fold results for a specified sequence.

refresh()

Refresh the job status and internal job object.

stream()

Retrieve results for this job as a stream.

stream_parallel()

Stream the results in parallel using a thread pool.

stream_sync()

Stream the results synchronously.

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.

end_date

The end timestamp of the job.

id

Get the ID of the fold request.

job_id

The unique identifier of the job.

job_type

The type of the job.

metadata

The fold metadata.

model_id

The fold model used.

progress_counter

The progress counter of the job.

sequences

Get the sequences submitted for the fold request.

start_date

The start timestamp of the job.

status

The current status of the job.

job

session