API reference

Property Regression Models

Data

openprotein.api.data.DataAPI	API interface for calling AssayData endpoints
openprotein.api.data.AssayDataset	Future Job for manipulating results

Train

openprotein.api.train.TrainingAPI	API interface for calling Train endpoints
openprotein.api.train.TrainFuture	Future Job for manipulating results
openprotein.api.predict.PredictFuture	Future Job for manipulating results

Design

openprotein.api.design.DesignAPI	interface for calling Design endpoints
openprotein.api.design.DesignFuture	Future Job for manipulating results

Foundation models

Endpoints

openprotein.api.embedding.EmbeddingAPI

This class defines a high level interface for accessing the embeddings API.

Models

openprotein.api.embedding.OpenProteinModel	Class providing inference endpoints for proprietary protein embedding models served by OpenProtein.
openprotein.api.embedding.ESMModel	Class providing inference endpoints for Facebook's ESM protein language Models.
openprotein.api.embedding.PoETModel	Class for OpenProtein's foundation model PoET - NB.
openprotein.api.embedding.SVDModel	Class providing embedding endpoint for SVD models.

Results

openprotein.api.embedding.EmbeddingResultFuture	Future Job for manipulating results
openprotein.api.poet.PoetScoreFuture	Represents a result of a PoET scoring job.
openprotein.api.poet.PoetSingleSiteFuture	Represents a result of a PoET single-site analysis job.
openprotein.api.poet.PoetGenerateFuture	Represents a result of a PoET generation job.

Align

openprotein.api.align.AlignAPI	API interface for calling Poet and Align endpoints
openprotein.api.align.PromptFuture	Represents a result of a prompt job.
openprotein.api.align.MSAFuture	Represents a result of a MSA job.

Fold

openprotein.api.fold.FoldAPI	This class defines a high level interface for accessing the fold API.
openprotein.api.fold.ESMFoldModel
openprotein.api.fold.AlphaFold2Model
openprotein.api.fold.FoldResultFuture