File size: 8,015 Bytes
0161e74 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | from collections.abc import Callable
from dataclasses import dataclass
from typing import Any
import jax
import jax.numpy as jnp
from src.utils._types import ArrayLike
__all__ = [
"BaseDataMixin",
"ConditionData",
"PredictionData",
"TrainingData",
"ValidationData",
]
@dataclass
class ReturnData: # TODO: this should rather be a NamedTuple
split_covariates_mask: jnp.ndarray | None
split_idx_to_covariates: dict[int, tuple[Any, ...]]
perturbation_covariates_mask: jnp.ndarray | None
perturbation_idx_to_covariates: dict[int, tuple[Any, ...]]
perturbation_idx_to_id: dict[int, Any]
condition_data: dict[str, ArrayLike]
control_to_perturbation: dict[int, ArrayLike]
max_combination_length: int
condition_data_id: jnp.ndarray # mapping from perturbation_idx to condition_id
class BaseDataMixin:
"""Base class for data containers."""
@property
def n_controls(self) -> int:
"""Returns the number of control covariate values."""
return len(self.split_idx_to_covariates) # type: ignore[attr-defined]
@property
def n_perturbations(self) -> int:
"""Returns the number of perturbation covariate combinations."""
return len(self.perturbation_idx_to_covariates) # type: ignore[attr-defined]
@property
def n_perturbation_covariates(self) -> int:
"""Returns the number of perturbation covariates."""
return len(self.condition_data) # type: ignore[attr-defined]
def _format_params(self, fmt: Callable[[Any], str]) -> str:
params = {
"n_controls": self.n_controls,
"n_perturbations": self.n_perturbations,
}
return ", ".join(f"{name}={fmt(val)}" for name, val in params.items())
def __repr__(self) -> str:
return f"{self.__class__.__name__}[{self._format_params(repr)}]"
@dataclass
class ConditionData(BaseDataMixin):
"""Data container containing condition embeddings.
Parameters
----------
condition_data
Dictionary with embeddings for conditions.
max_combination_length
Maximum number of covariates in a combination.
null_value
Token to use for masking `null_value`.
data_manager
Data manager used to generate the data.
condition_data_id
Mapping from perturbation index to condition ID.
"""
condition_data: dict[str, ArrayLike]
max_combination_length: int
perturbation_idx_to_covariates: dict[int, tuple[str, ...]]
perturbation_idx_to_id: dict[int, Any]
null_value: Any
data_manager: Any
condition_data_id: jnp.ndarray
@dataclass
class TrainingData(BaseDataMixin):
"""Training data.
Parameters
----------
cell_data
The representation of cell data, e.g. PCA of gene expression data.
split_covariates_mask
Mask of the split covariates.
split_idx_to_covariates
Dictionary explaining values in ``split_covariates_mask``.
perturbation_covariates_mask
Mask of the perturbation covariates.
perturbation_idx_to_covariates
Dictionary explaining values in ``perturbation_covariates_mask``.
condition_data
Dictionary with embeddings for conditions.
control_to_perturbation
Mapping from control index to target distribution indices.
max_combination_length
Maximum number of covariates in a combination.
data_manager
The data manager
condition_data_id
Mapping from perturbation index to condition ID.
"""
cell_data: jax.Array # (n_cells, n_features)
split_covariates_mask: jax.Array # (n_cells,), which cell assigned to which source distribution
split_idx_to_covariates: dict[int, tuple[Any, ...]] # (n_sources,) dictionary explaining split_covariates_mask
perturbation_covariates_mask: jax.Array # (n_cells,), which cell assigned to which target distribution
perturbation_idx_to_covariates: dict[
int, tuple[str, ...]
] # (n_targets,), dictionary explaining perturbation_covariates_mask
perturbation_idx_to_id: dict[int, Any]
condition_data: dict[str, ArrayLike] # (n_targets,) all embeddings for conditions
control_to_perturbation: dict[int, ArrayLike] # mapping from control idx to target distribution idcs
max_combination_length: int
null_value: Any
data_manager: Any
condition_data_id: jnp.ndarray
cell_data_id: Any
@dataclass
class ValidationData(BaseDataMixin):
"""Data container for the validation data.
Parameters
----------
cell_data
The representation of cell data, e.g. PCA of gene expression data.
split_covariates_mask
Mask of the split covariates.
split_idx_to_covariates
Dictionary explaining values in ``split_covariates_mask``.
perturbation_covariates_mask
Mask of the perturbation covariates.
perturbation_idx_to_covariates
Dictionary explaining values in ``perturbation_covariates_mask``.
condition_data
Dictionary with embeddings for conditions.
control_to_perturbation
Mapping from control index to target distribution indices.
max_combination_length
Maximum number of covariates in a combination.
data_manager
The data manager
condition_data_id
Mapping from perturbation index to condition ID.
n_conditions_on_log_iteration
Number of conditions to use for computation callbacks at each logged iteration.
If :obj:`None`, use all conditions.
n_conditions_on_train_end
Number of conditions to use for computation callbacks at the end of training.
If :obj:`None`, use all conditions.
"""
cell_data: jax.Array # (n_cells, n_features)
split_covariates_mask: jax.Array # (n_cells,), which cell assigned to which source distribution
split_idx_to_covariates: dict[int, tuple[Any, ...]] # (n_sources,) dictionary explaining split_covariates_mask
perturbation_covariates_mask: jax.Array # (n_cells,), which cell assigned to which target distribution
perturbation_idx_to_covariates: dict[
int, tuple[str, ...]
] # (n_targets,), dictionary explaining perturbation_covariates_mask
perturbation_idx_to_id: dict[int, Any]
condition_data: dict[str, ArrayLike] # (n_targets,) all embeddings for conditions
control_to_perturbation: dict[int, jax.Array] # mapping from control idx to target distribution idcs
max_combination_length: int
null_value: Any
data_manager: Any
condition_data_id: jnp.ndarray
n_conditions_on_log_iteration: int | None = None
n_conditions_on_train_end: int | None = None
@dataclass
class PredictionData(BaseDataMixin):
"""Data container to perform prediction.
Parameters
----------
src_data
Dictionary with data for source cells.
condition_data
Dictionary with embeddings for conditions.
control_to_perturbation
Mapping from control index to target distribution indices.
covariate_encoder
Encoder for the primary covariate.
max_combination_length
Maximum number of covariates in a combination.
null_value
Token to use for masking ``null_value``.
condition_data_id
Mapping from condition name to condition ID embedding.
"""
cell_data: jax.Array # (n_cells, n_features)
split_covariates_mask: jax.Array # (n_cells,), which cell assigned to which source distribution
split_idx_to_covariates: dict[int, tuple[Any, ...]] # (n_sources,) dictionary explaining split_covariates_mask
perturbation_idx_to_covariates: dict[
int, tuple[str, ...]
] # (n_targets,), dictionary explaining perturbation_covariates_mask
perturbation_idx_to_id: dict[int, Any]
condition_data: dict[str, ArrayLike] # (n_targets,) all embeddings for conditions
control_to_perturbation: dict[int, ArrayLike]
max_combination_length: int
null_value: Any
data_manager: Any
condition_data_id: jnp.ndarray
|