Skip to content

cli

heartKIT CLI API

The heartKIT CLI provides a command-line interface to interact with the heartKIT library.

$ heartkit --help

heartKIT CLI Options:
    --task [segmentation, rhythm, beat, denoise]
    --mode [download, feature, train, evaluate, export, demo]
    --config ["./path/to/config.json", or '{"raw: "json"}']

Classes

Functions

parse_content 

parse_content(cls: Type[B], content: str) -> B

Parse file or raw content into Pydantic model.

Parameters:

  • cls

    (B) –

    Pydantic model subclasss

  • content

    (str) –

    File path or raw content

Returns:

  • B ( B ) –

    Pydantic model subclass instance

Source code in heartkit/cli.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def parse_content(cls: Type[B], content: str) -> B:
    """Parse file or raw content into Pydantic model.

    Args:
        cls (B): Pydantic model subclasss
        content (str): File path or raw content

    Returns:
        B: Pydantic model subclass instance
    """
    if os.path.isfile(content):
        with open(content, "r", encoding="utf-8") as f:
            content = f.read()

    return cls.model_validate_json(json_data=content)

run 

run(
    mode: HKMode = ArgField("-m", description="Mode", default=HKMode.train),
    task: str = ArgField("-t", description="Task", default="rhythm"),
    config: str = ArgField("-c", description="File path or JSON content", default="{}"),
)

heartKIT CLI entry point.

Parameters:

  • mode

    (HKMode, default: ArgField('-m', description='Mode', default=train) ) –

    Mode. Defaults to HKMode.train.

  • task

    (str, default: ArgField('-t', description='Task', default='rhythm') ) –

    Task. Defaults to "rhythm".

  • config

    (str, default: ArgField('-c', description='File path or JSON content', default='{}') ) –

    File path or JSON content. Defaults to "{}".

Source code in heartkit/cli.py 
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
@parser.command()
def run(
    mode: HKMode = ArgField("-m", description="Mode", default=HKMode.train),
    task: str = ArgField("-t", description="Task", default="rhythm"),
    config: str = ArgField("-c", description="File path or JSON content", default="{}"),
):
    """heartKIT CLI entry point.

    Args:
        mode (HKMode, optional): Mode. Defaults to HKMode.train.
        task (str, optional): Task. Defaults to "rhythm".
        config (str, optional): File path or JSON content. Defaults to "{}".
    """

    logger.info(f"#STARTED MODE={mode} TASK={task}")

    if not TaskFactory.has(task):
        raise ValueError(f"Unknown task {task}")

    task_handler = TaskFactory.get(task)

    params = parse_content(HKTaskParams, config)

    match mode:
        case HKMode.download:
            task_handler.download(params)

        case HKMode.train:
            task_handler.train(params)

        case HKMode.evaluate:
            task_handler.evaluate(params)

        case HKMode.export:
            task_handler.export(params)

        case HKMode.demo:
            task_handler.demo(params)

        case _:
            logger.error("Error: Unknown command")
    # END MATCH

    logger.info(f"#FINISHED MODE={mode} TASK={task}")