Source code for tdc.multi_pred.antibodyaff

# -*- coding: utf-8 -*-
# Author: TDC Team
# License: MIT

import warnings

warnings.filterwarnings("ignore")
import sys

from ..utils import print_sys
from . import bi_pred_dataset, multi_pred_dataset
from ..metadata import dataset_names


class AntibodyAff(bi_pred_dataset.DataLoader):

    """Data loader class to load datasets in Antibody-antigen Affinity Prediction task.
    More info: https://tdcommons.ai/multi_pred_tasks/antibodyaff/

    Task Description: Regression. Given the amino acid sequence of antibody and antigen, predict their binding affinity.


    Args:
        name (str): the dataset name.
        path (str, optional):
            The path to save the data file, defaults to './data'
        label_name (str, optional):
            For multi-label dataset, specify the label name, defaults to None
        print_stats (bool, optional):
            Whether to print basic statistics of the dataset, defaults to False


    """

    def __init__(self, name, path="./data", label_name=None, print_stats=False):
        """Create Antibody-antigen Affinity dataloader object"""
        super().__init__(
            name,
            path,
            label_name,
            print_stats,
            dataset_names=dataset_names["AntibodyAff"],
        )
        self.entity1_name = "Antibody"
        self.entity2_name = "Antigen"
        self.two_types = True

        if print_stats:
            self.print_stats()

        print("Done!", flush=True, file=sys.stderr)