"""This file is a base class for feature scorer."""
from typing import Union
from anndata import AnnData
from anndata.experimental import AnnCollection
import numpy as np
from torch import nn
import scalr
from scalr.utils import build_object
[docs]
class ScoringBase:
"""Base class for the scorer."""
def __init__(self):
pass
# Abstract
[docs]
def generate_scores(self, model: nn.Module,
train_data: Union[AnnData, AnnCollection],
val_data: Union[AnnData, AnnCollection], target: str,
mappings: dict) -> np.ndarray:
"""A function to return the score of each feature for each class.
Args:
model (nn.Module): Trained model to generate scores from.
train_data (Union[AnnData, AnnCollection]): Training data of model.
val_data (Union[AnnData, AnnCollection]): Validation data of model.
target (str): Column in data, used to train the model on.
mappings (dict): Mapping of model output dimension to its
corresponding labels in the metadata columns.
Returns:
np.ndarray: score_matrix [num_classes X num_features]
"""
pass
[docs]
@classmethod
def get_default_params(cls) -> dict:
"""Class method to get default params."""
return dict()
[docs]
def build_scorer(scorer_config: dict) -> tuple[ScoringBase, dict]:
"""Builder object to get scorer, updated scorer_config."""
return build_object(scalr.feature.scoring, scorer_config)