openprotein.api.data#

Upload your dataset to OpenProtein.AI’s engineering platform for train, predict and design tasks.

class openprotein.api.data.DataAPI[source]#

API interface for calling AssayData endpoints

__init__(session)[source]#

init the DataAPI.

Parameters:

session (APISession) – Session object for API communication.

list()[source]#

List all assay datasets.

Returns:

List of all assay datasets.

Return type:

List[AssayDataset]

create(table, name, description=None)[source]#

Create a new assay dataset.

Parameters:

  • table (pd.DataFrame) – DataFrame containing the assay data.

  • name (str) – Name of the assay dataset.

  • description (str, optional) – Description of the assay dataset, by default None.

Returns:

Created assay dataset.

Return type:

AssayDataset

get(assay_id, verbose=False)[source]#

Get an assay dataset by its ID.

Parameters:

  • assay_id (str) – ID of the assay dataset.

  • verbose (bool)

Returns:

Assay dataset with the specified ID.

Return type:

AssayDataset

Raises:

KeyError – If no assay dataset with the given ID is found.

load_assay(assay_id)[source]#

Reload a Submitted job to resume from where you left off!

Parameters:

assay_id (str) – The identifier of the job whose details are to be loaded.

Returns:

Job

Return type:

Job

Raises:

  • HTTPError – If the request to the server fails.

  • InvalidJob – If the Job is of the wrong type

class openprotein.api.data.AssayDataset[source]#

Future Job for manipulating results

__init__(session, metadata)[source]#

init for AssayDataset.

Parameters:

  • session (APISession) – Session object for API communication.

  • metadata (AssayMetadata) – Metadata object of the assay data.

list_models()[source]#

List models assoicated with assay.

Returns:

List of models

Return type:

List

update(assay_name=None, assay_description=None)[source]#

Update the assay metadata.

Parameters:

  • assay_name (str, optional) – New name of the assay, by default None.

  • assay_description (str, optional) – New description of the assay, by default None.

Return type:

None

get_first()[source]#

Get head slice of assay data.

Returns:

Dataframe containing the slice of assay data.

Return type:

pd.DataFrame

get_slice(start, end)[source]#

Get a slice of assay data.

Parameters:

  • start (int) – Start index of the slice.

  • end (int) – End index of the slice.

Returns:

Dataframe containing the slice of assay data.

Return type:

pd.DataFrame