Skip to content

Commit a6a8c3b

Browse files
committed
update rest api pages
1 parent 7995118 commit a6a8c3b

File tree

4 files changed

+29
-76
lines changed

4 files changed

+29
-76
lines changed

source/rest-api/assay-datasets.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Assay Datasets
2+
==============
3+
4+
Upload your assay datasets for use with our platform's property predictors module.
5+
6+
Assaydata
7+
---------
8+
Endpoints to upload a dataset to OpenProtein.AI’s engineering platform for training, predicting and evaluating tasks. The expected format of each dataset as 2 column CSV:
9+
10+
- The full sequence of each variant (mutation codes are also accepted)
11+
- 1+ columns with your measured properties (missing values are acceptable)
12+
13+
Endpoints
14+
---------
15+
.. raw:: html
16+
17+
<script type="module" src="../_static/js/swaggerProject.js"></script>
18+
<div id="swagger-ui"></div>

source/rest-api/index.rst

Lines changed: 11 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,14 @@ The endpoints include:
1818

1919
After authenticating, we recommend proceeding directly to the respective workflow pages:
2020

21-
`Property Regression <./property-regression.rst>`_
21+
`Assay datasets <./assay-datasets.rst>`_
2222
--------------------------------------------------
2323

24-
Kickoff your Property Regression by using the endpoints to enable analyzing datasets, training sequence-to-function prediction models, using those models to predict properties for new sequences, and designing optimized libraries of sequence variants.
24+
Upload your assay datasets for use with our platform's property predictors module.
2525

2626
The endpoints include:
2727

2828
- Assaydata
29-
- Train
30-
- Predict
31-
- Design
32-
- Jobs
33-
- Embeddings
34-
- Predictor
35-
36-
`PoET <./poet.rst>`_
37-
--------------------
38-
Design *de novo* sequences using these endpoints, without functional measurements of the protein of interest. Our proprietary models enable generation of single substitution, combinatorial variant libraries, or a high-diversity library.
39-
40-
The endpoints include:
41-
42-
- PoET
4329

4430
`Foundation Models <./embeddings.rst>`_
4531
---------------------------------------
@@ -85,7 +71,7 @@ The endpoints include:
8571

8672
`Design <./design.rst>`_
8773
------------------------------------
88-
Design de novo sequences and structures on our platform! You can either start from your assays and design sequences which optimize targets using your trained property predictors, or you can start from a target structure and use RFdiffusion to generate a structure based on your input structure.
74+
Design de novo sequences and structures on our platform! You can either start from your assays and design sequences which optimize targets using your trained property predictors, or you can start from a target structure and use RFdiffusion or BoltzGen to generate a structure based on your input structure.
8975

9076
The endpoints include:
9177

@@ -104,12 +90,11 @@ To start accessing our suite of APIs, refer to these articles to get started:
10490
:hidden:
10591
:maxdepth: 1
10692

107-
Authentication and Jobs <authentication-and-jobs>
108-
Property Regression <property-regression>
109-
PoET <poet>
110-
Align <align>
111-
Prompt <prompt>
112-
Embeddings <embeddings>
113-
Fold <fold>
114-
Predictor <predictor>
115-
Design <design>
93+
Authentication and Jobs <./authentication-and-jobs.rst>
94+
Assay datasets <./assay-datasets.rst>
95+
Align <./align.rst>
96+
Prompt <./prompt.rst>
97+
Embeddings <./embeddings.rst>
98+
Fold <./fold.rst>
99+
Predictor <./predictor.rst>
100+
Design <./design.rst>

source/rest-api/poet.rst

Lines changed: 0 additions & 14 deletions
This file was deleted.

source/rest-api/property-regression.rst

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)