API reference#

Property Regression Models#

Data#

Upload and store your datasets on our platform to use with your protein engineering tasks.

openprotein.data.DataAPI

API interface for calling AssayData endpoints

openprotein.data.AssayDataset

Assay dataset which contains your sequences and measurements which can be used for training predictors.

Align#

Align your protein sequences or look up multiple sequence alignments.

openprotein.align.AlignAPI

Align API interface for creating alignments and MSAs (multiple sequence alignments) which can be used for other protein tasks.

openprotein.align.MSAFuture

Represents a future for MSA (Multiple Sequence Alignment) results.

Prompt#

Create prompts using sequences and structures to condition our proprietary high-performance PoET foundation models.

openprotein.prompt.PromptAPI

Prompt API providing the interface to create prompts for use with PoET models.

openprotein.prompt.Prompt

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

openprotein.prompt.Query

Query containing a sequence/structure used to query the PoET-2 model which opens up new workflows.

Foundation models#

Use foundation models to produce embeddings and logits with your protein sequences.

openprotein.embeddings.EmbeddingsAPI

Embeddings API providing the interface for creating embeddings using protein language models.

Models#

The foundation models on our platform are classed appropriately to identify the models and group their functionality.

openprotein.embeddings.PoET2Model

Class for OpenProtein's foundation model PoET 2.

openprotein.embeddings.PoETModel

Class for OpenProtein's foundation model PoET.

openprotein.embeddings.OpenProteinModel

Class providing inference endpoints for proprietary protein embedding models served by OpenProtein.

openprotein.embeddings.ESMModel

Class providing inference endpoints for Facebook's ESM protein language models.

Results#

The models produce asynchronous results which are modeled as futures which can be awaited.

openprotein.embeddings.EmbeddingsResultFuture

Future for manipulating results for embeddings-related requests.

openprotein.embeddings.EmbeddingsScoreFuture

Future for manipulating results for embeddings score-related requests.

openprotein.embeddings.EmbeddingsGenerateFuture

Future for manipulating results for embeddings generate-related requests.

Transform#

Transform and reduce your embeddings for use with visualization and training workflows.

SVD#

openprotein.svd.SVDAPI

SVD API providing the interface for creating and using SVD models.

openprotein.svd.SVDModel

Class providing embedding endpoint for SVD models.

UMAP#

openprotein.umap.UMAPAPI

UMAP API providing the interface to fit and run UMAP visualizations.

openprotein.umap.UMAPModel

Class providing embedding endpoint for UMAP models.

Predictor#

Train predictors from your assay datasets and use them to make predictions on novel sequences.

openprotein.predictor.PredictorAPI

Predictor API providing the interface to train and predict predictors.

openprotein.predictor.PredictorModel

Class providing predict endpoint for fitted predictor models.

openprotein.predictor.PredictionResultFuture

Prediction results represented as a future.

Design#

Design novel protein sequences based on your assay datasets and trained models, optimizing toward your design criteria.

openprotein.design.DesignAPI

Design API providing the interface to design novel proteins based on your design criteria.

openprotein.design.DesignFuture

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

Fold#

Make structure predictions on your protein sequences.

openprotein.fold.FoldAPI

Fold API provides a high level interface for making protein structure predictions.

openprotein.fold.Boltz2Model

Class providing inference endpoints for Boltz-2 structure prediction model which jointly models complex structures and binding affinities.

openprotein.fold.Boltz1xModel

Class providing inference endpoints for Boltz-1x open-source structure prediction model, which adds the use of inference potentials to improve performance.

openprotein.fold.Boltz1Model

Class providing inference endpoints for Boltz-1 open-source structure prediction model.

openprotein.fold.AlphaFold2Model

Class providing inference endpoints for AlphaFold2 structure prediction models, based on the implementation by ColabFold.

openprotein.fold.ESMFoldModel

Class providing inference endpoints for Facebook's ESMFold structure prediction models.

openprotein.fold.FoldResultFuture

Fold results represented as a future.

openprotein.fold.FoldComplexResultFuture

Future for manipulating results of a fold complex request.