register_embedding

register_embedding(embedding_class)

Register new embedding to the collection.

Example:

import polars as pl
import perturb_lib as plib


@plib.register_embedding
class CoolEmbedding(pl.DataFrame):
    def __init__(self):
        super().__init__(data={"feature": [1.1, 2.2]}, index=["PSMA1", "STAT1"])

Parameters:

embedding_class (type[DataFrame]) – embedding class to register

Raises:

ValueError – If embedding class with the same name exists already.