clearml-docs/docs/integrations/click.md

title
Click

click is a python package for creating command-line interfaces. ClearML integrates seamlessly with click and automatically logs its command-line parameters.

All you have to do is add two lines of code:

from clearml import Task
task = Task.init(task_name="<task_name>", project_name="<project_name>")

For example:

import click
from clearml import Task

@click.command()
@click.option('--count', default=1, help='Number of greetings.')
@click.option('--name', prompt='Your name', help='The person to greet.')

def hello(count, name):
    task = Task.init(project_name='examples', task_name='Click single command')

    for x in range(count):
        click.echo("Hello {}!".format(name))


if __name__ == '__main__':
    hello()

When this code is executed, ClearML logs your command-line arguments, which you can view in the WebApp, in the experiment's Configuration > Hyperparameters > Args section.

In the UI, you can clone the task multiple times and set the clones' parameter values for execution by the ClearML Agent. When the clone is executed, the executing agent will use the new parameter values as if set by the command-line.

See code examples demonstrating integrating ClearML with code that uses click.