Skip to content

clicommands

clicommands

Module for clicommands provided with the package

Functions

dagit 

dagit(context)

Starts dagit with the niceml repository

Source code in niceml/cli/clicommands.py 
14
15
16
17
@task
def dagit(context):
    """Starts dagit with the niceml repository"""
    context.run("python -m dagster dev -m niceml.dagster.jobs.repository")

dashboard 

dashboard(
    context, config_path="configs/dashboard/local.yaml"
)

Starts the experiment dashboard

Source code in niceml/cli/clicommands.py 
20
21
22
23
24
25
26
@task(help={"config_path": "config_path to your dashboard configuration"})
def dashboard(context, config_path="configs/dashboard/local.yaml"):
    """Starts the experiment dashboard"""
    import niceml.dashboard.dashboard as db_module  # pylint: disable=import-outside-toplevel

    run_file = db_module.__file__
    context.run(f"streamlit run {run_file} {config_path}")

evaluation 

evaluation(context, config_path)

Starts a job_eval job

Source code in niceml/cli/clicommands.py 
35
36
37
38
@task(help={"config_path": "config_path to your job_eval job config"})
def evaluation(context, config_path):
    """Starts a job_eval job"""
    execute_job(context, "job_eval", config_path)

execute 

execute(context, job_name, config_path)

Starts a job with given name

Source code in niceml/cli/clicommands.py 
49
50
51
52
@task
def execute(context, job_name, config_path):
    """Starts a job with given name"""
    execute_job(context, job_name, config_path)

execute_job 

execute_job(context, job_name, config_path)

helper function to run jobs

Source code in niceml/cli/clicommands.py 
102
103
104
105
106
def execute_job(context, job_name, config_path):
    """helper function to run jobs"""
    context.run(
        f"dagster job execute -m niceml.dagster.jobs.repository -j {job_name} -c {config_path}"
    )

gendata 

gendata(
    context,
    config_path="configs/jobs/job_data_generation/job_data_generation.yaml",
)

Starts a job_data_generation job

Source code in niceml/cli/clicommands.py 
41
42
43
44
45
46
@task(help={"config_path": "config_path to your job_data_generation job config"})
def gendata(
    context, config_path="configs/jobs/job_data_generation/job_data_generation.yaml"
):
    """Starts a job_data_generation job"""
    execute_job(context, "job_data_generation", config_path)

init 

init(context)

Initializes an empty niceml project

Source code in niceml/cli/clicommands.py 
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
@task
def init(context):
    """Initializes an empty niceml project"""

    old_pyproject_toml = toml.load(
        join(os.path.abspath(os.getcwd()), "pyproject.toml")
    )["tool"]["poetry"]

    attributes_of_interest = [
        "name",
        "version",
        "description",
        "authors",
        "packages",
        "dependencies",
    ]
    copier_data_dict = {}

    for attribute in attributes_of_interest:
        try:
            attribute_value = old_pyproject_toml[attribute]
        except KeyError:
            continue
        copier_data_dict[attribute] = f"{attribute_value}"

        if attribute == "name":
            package_name = attribute_value.replace(" ", "")
            package_name = package_name.replace("-", "")
            package_name = package_name.replace("_", "")
            copier_data_dict["package_name"] = package_name

        if attribute == "authors":
            copier_data_dict[attribute] = attribute_value

        if attribute == "dependencies":
            copier_data_dict[attribute] = toml.dumps(
                attribute_value, encoder=toml.TomlPreserveInlineDictEncoder()
            )

    copier.run_auto(
        src_path="gh:codecentric-oss/niceml",
        dst_path=f"{os.path.abspath(os.getcwd())}",
        data=copier_data_dict,
        overwrite=True,
    )

train 

train(context, config_path)

Starts a job_train job

Source code in niceml/cli/clicommands.py 
29
30
31
32
@task(help={"config_path": "config_path to your job_train job config"})
def train(context, config_path):
    """Starts a job_train job"""
    execute_job(context, "job_train", config_path)