基础特征提取器

BaseAtomFeaturizer

基类：ABC

所有原子特征提取类的抽象基类。

源代码位于 bionemo/geometric/base_featurizer.py

class BaseAtomFeaturizer(ABC):
    """Abstract base featurizer class for all atom featurization classes."""

    @abstractproperty
    def n_dim(self) -> int:
        """Number of dimensions of computed feature."""
        ...

    @abstractmethod
    def get_atom_features(self):
        """Computes atom features."""
        ...

    def __call__(self, mol: Mol, atom_indices: Optional[Iterable] = None) -> list[int]:
        """Returns computed atom features."""
        return self.get_atom_features(mol, atom_indices)

__call__(mol, atom_indices=None)

返回计算出的原子特征。

源代码位于 bionemo/geometric/base_featurizer.py

def __call__(self, mol: Mol, atom_indices: Optional[Iterable] = None) -> list[int]:
    """Returns computed atom features."""
    return self.get_atom_features(mol, atom_indices)

get_atom_features() abstractmethod

计算原子特征。

源代码位于 bionemo/geometric/base_featurizer.py

@abstractmethod
def get_atom_features(self):
    """Computes atom features."""
    ...

n_dim()

计算特征的维度数量。

源代码位于 bionemo/geometric/base_featurizer.py

@abstractproperty
def n_dim(self) -> int:
    """Number of dimensions of computed feature."""
    ...

BaseBondFeaturizer

基类：ABC

所有键特征提取类的抽象基类。

源代码位于 bionemo/geometric/base_featurizer.py

class BaseBondFeaturizer(ABC):
    """Abstract base featurizer class for all bond featurization classes."""

    @abstractproperty
    def n_dim(self) -> int:
        """Number of dimensions of computed feature."""
        ...

    @abstractmethod
    def get_bond_features(self):
        """Computes bond features."""
        ...

    def __call__(self, mol: Mol, bond_indices: Optional[Iterable] = None) -> list[int]:
        """Returns computed bond features."""
        return self.get_bond_features(mol, bond_indices)

__call__(mol, bond_indices=None)

返回计算出的键特征。

源代码位于 bionemo/geometric/base_featurizer.py

def __call__(self, mol: Mol, bond_indices: Optional[Iterable] = None) -> list[int]:
    """Returns computed bond features."""
    return self.get_bond_features(mol, bond_indices)

get_bond_features() abstractmethod

计算键特征。

源代码位于 bionemo/geometric/base_featurizer.py

@abstractmethod
def get_bond_features(self):
    """Computes bond features."""
    ...

n_dim()

计算特征的维度数量。

源代码位于 bionemo/geometric/base_featurizer.py

@abstractproperty
def n_dim(self) -> int:
    """Number of dimensions of computed feature."""
    ...

BaseMoleculeFeaturizer

基类：ABC

分子特征提取类的抽象基类。

源代码位于 bionemo/geometric/base_featurizer.py

class BaseMoleculeFeaturizer(ABC):
    """Abstract base featurizer class for molecule featurization classes."""

    @abstractproperty
    def n_dim(self) -> int:
        """Number of dimensions of computed feature."""
        ...

    @abstractmethod
    def get_molecule_features(self, mol: Mol) -> torch.Tensor:
        """Computes molecule features."""
        ...

    def __call__(self, mol: Mol) -> torch.Tensor:
        """Returns computed molecule features."""
        return self.get_molecule_features(mol)

__call__(mol)

返回计算出的分子特征。

源代码位于 bionemo/geometric/base_featurizer.py

def __call__(self, mol: Mol) -> torch.Tensor:
    """Returns computed molecule features."""
    return self.get_molecule_features(mol)

get_molecule_features(mol) abstractmethod

计算分子特征。

源代码位于 bionemo/geometric/base_featurizer.py

@abstractmethod
def get_molecule_features(self, mol: Mol) -> torch.Tensor:
    """Computes molecule features."""
    ...

n_dim()

计算特征的维度数量。

源代码位于 bionemo/geometric/base_featurizer.py

@abstractproperty
def n_dim(self) -> int:
    """Number of dimensions of computed feature."""
    ...

get_boolean_atomic_prop(atom, prop_list=None)

检索给定原子的布尔原子属性。

此函数获取原子的布尔属性。如果提供了特定的属性列表，则检索这些属性。否则，它将获取原子所有可用的布尔属性。

参数

名称	类型	描述	默认值
原子	原子	要从中检索属性的原子对象。	必需
属性列表	列表	要检索的特定属性名称列表。如果为 None，则将获取所有可用属性。默认为 None。	无

返回

名称	类型	描述
列表	list[bool]	与请求的属性对应的布尔值列表。

源代码位于 bionemo/geometric/base_featurizer.py

def get_boolean_atomic_prop(atom: Atom, prop_list=None) -> list[bool]:
    """Retrieves boolean atomic properties for a given atom.

    This function fetches boolean properties of an atom. If a specific list of
    properties is provided, it retrieves those properties. Otherwise, it fetches
    all available boolean properties for the atom.

    Args:
        atom: The atom object to retrieve properties from.
        prop_list (list, optional): A list of specific property names to retrieve.
            If None, all available properties will be fetched. Defaults to None.

    Returns:
        list: A list of boolean values corresponding to the requested properties.
    """
    _prop_list = prop_list if prop_list else atom.GetPropNames()

    return [atom.GetBoolProp(prop) for prop in _prop_list]

get_double_atomic_prop(atom, prop_list=None)

检索给定原子的双精度原子属性。

此函数获取原子的双精度属性。如果提供了特定的属性列表，则检索这些属性。否则，它将获取原子所有可用的双精度属性。

参数

名称	类型	描述	默认值
原子		要从中检索属性的原子对象。	必需
属性列表	列表	要检索的特定属性名称列表。如果为 None，则将获取所有可用属性。默认为 None。	无

返回

名称	类型	描述
列表	list[float]	与请求的属性对应的浮点值列表。

源代码位于 bionemo/geometric/base_featurizer.py

def get_double_atomic_prop(atom, prop_list=None) -> list[float]:
    """Retrieves double atomic properties for a given atom.

    This function fetches double properties of an atom. If a specific list of
    properties is provided, it retrieves those properties. Otherwise, it fetches
    all available double properties for the atom.

    Args:
        atom: The atom object to retrieve properties from.
        prop_list (list, optional): A list of specific property names to retrieve.
            If None, all available properties will be fetched. Defaults to None.

    Returns:
        list: A list of float values corresponding to the requested properties.
    """
    if prop_list is not None:
        _prop_list = prop_list
    else:
        _prop_list = atom.GetPropNames()

    return [atom.GetDoubleProp(prop) for prop in _prop_list]

one_hot_enc(val, num_class)

对整数值执行 one-hot 编码。

此函数创建输入值的 one-hot 编码表示，作为布尔值列表。结果列表的长度等于 num_class，其中只有索引 val 处的元素设置为 True。

参数

名称	类型	描述	默认值
值	整数	表示要进行 one-hot 编码的值的整数。必须在 [0, num_class - 1] 范围内。	必需
类数量	整数	表示类总数或可能类数的整数。	必需

返回

类型	描述
list[bool]	val 的 One-hot 编码。

源代码位于 bionemo/geometric/base_featurizer.py

def one_hot_enc(val: int, num_class: int) -> list[bool]:
    """Performs one-hot encoding on an integer value.

    This function creates a one-hot encoded representation of the input value
    as a list of boolean values. The resulting list has a length equal to
    `num_class`, where only the element at index `val` is set to True.

    Args:
        val (int): An integer representing the value to be one-hot encoded.
            Must be in the range [0, num_class - 1].
        num_class (int): An integer representing the total number of classes or
            possible classes.

    Returns:
        One-hot encoding of `val`.
    """
    one_hot = [False] * num_class
    one_hot[val] = True
    return one_hot