Skip to content

task

Classes

HKTask

heartKIT Task base class. All tasks should inherit from this class.

Functions

description staticmethod 
description() -> str

Get task description

Returns:

  • str ( str ) –

    description

Source code in heartkit/tasks/task.py 
13
14
15
16
17
18
19
20
21
@staticmethod
def description() -> str:
    """Get task description

    Returns:
        str: description

    """
    return ""
download staticmethod 
download(params: HKTaskParams) -> None

Download datasets

Parameters:

Source code in heartkit/tasks/task.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
@staticmethod
def download(params: HKTaskParams) -> None:
    """Download datasets

    Args:
        params (HKTaskParams): Task parameters

    """
    os.makedirs(params.job_dir, exist_ok=True)
    logger = helia.utils.setup_logger(__name__, level=params.verbose, file_path=params.job_dir / "download.log")
    logger.debug(f"Creating working directory in {params.job_dir}")

    for ds in params.datasets:
        if DatasetFactory.has(ds.name):
            logger.debug(f"Downloading dataset: {ds.name}")
            Dataset = DatasetFactory.get(ds.name)
            ds: HKDataset = Dataset(**ds.params)
            ds.download(
                num_workers=params.data_parallelism,
                force=params.force_download,
            )
train staticmethod 
train(params: HKTaskParams) -> None

Train a model

Parameters:

Source code in heartkit/tasks/task.py 
47
48
49
50
51
52
53
54
55
@staticmethod
def train(params: HKTaskParams) -> None:
    """Train a model

    Args:
        params (HKTaskParams): Task parameters

    """
    raise NotImplementedError
evaluate staticmethod 
evaluate(params: HKTaskParams) -> None

Evaluate a model

Parameters:

Source code in heartkit/tasks/task.py 
57
58
59
60
61
62
63
64
65
@staticmethod
def evaluate(params: HKTaskParams) -> None:
    """Evaluate a model

    Args:
        params (HKTaskParams): Task parameters

    """
    raise NotImplementedError
export staticmethod 
export(params: HKTaskParams) -> None

Export a model

Parameters:

Source code in heartkit/tasks/task.py 
67
68
69
70
71
72
73
74
75
@staticmethod
def export(params: HKTaskParams) -> None:
    """Export a model

    Args:
        params (HKTaskParams): Task parameters

    """
    raise NotImplementedError
demo staticmethod 
demo(params: HKTaskParams) -> None

Run a demo

Parameters:

Source code in heartkit/tasks/task.py 
77
78
79
80
81
82
83
84
85
@staticmethod
def demo(params: HKTaskParams) -> None:
    """Run a demo

    Args:
        params (HKTaskParams): Task parameters

    """
    raise NotImplementedError