Heimdall.task.Task

Contents

Heimdall.task.Task#

class Heimdall.task.Task(data, task_type, metrics, shuffle, head_config, loss_config, interaction_type=None, top_k=None, label_obsm_name=None, label_col_name=None, reducer_config=None, splits=None, train_split=(None,), track_metric=None)[source]#

Bases: ABC

Heimdall task key-value store.

Contains information about an scFM task and training details. (Pre)computes labels for each task.

Attributes

idx

interaction_type

label_col_name

label_obsm_name

labels

num_tasks

reducer_config

splits

top_k

track_metric

train_split

data

task_type

metrics

shuffle

head_config

loss_config

Methods

clear_cache_path(cache_dir, hash_vars, task_name)

collate(values)

from_cache(cache_dir, hash_vars, task_name)

get_cache_path(cache_dir, hash_vars, task_name)

get_inputs(idx, shared_inputs)

on_batch()

Callback to reset task state on start of sampling batch.

setup_labels()

to_cache(cache_dir, hash_vars, task_name)

Parameters:

  • data (CellRepresentation)

  • task_type (str)

  • metrics (list[str])

  • shuffle (bool)

  • head_config (DictConfig)

  • loss_config (DictConfig)

  • interaction_type (str | None)

  • top_k (list[int] | None)

  • label_obsm_name (str | None)

  • label_col_name (str | None)

  • reducer_config (DictConfig | None)

  • splits (DictConfig | None)

  • train_split (float | None)

  • track_metric (str | None)

Contents