art.cli package

Submodules

art.cli.main

art.cli.main.bert_transfer_learning_tutorial()

Create a project named ‘bert_transfer_learning_tutorial’ using the ‘bert_transfer_learning_tutorial’ branch.

art.cli.main.create_project(project_name: str, keep_as_repo: bool = False, branch: str = 'main') → None

Create a new project using a specified Cookiecutter template.

Parameters:

  • project_name (str) – The name of the new project.

  • keep_as_repo (bool, optional) – Whether to keep the .git directory. Defaults to False.

  • branch (str, optional) – The branch of the template to use. Defaults to “main”.

art.cli.main.get_started()

Create a project named ‘mnist_tutorial’ using the ‘mnist_tutorial’ branch.

art.cli.main.regularization_tutorial()

Creates a regularize tutorial.

art.cli.main.run_dashboard(experiment_folder: str = '.')

Run dashboard for a given experiment folder.

art.cli.utils

class art.cli.utils.ProjectType(value)

Bases: Enum

Enum for project types

CLASSIFICATION = 1
CLUSTERING = 3
REGRESSION = 2
TIME_SERIES = 4
art.cli.utils.get_git_user_info()

Retrieve the git user’s username and email.

Returns:

A tuple containing the git username and email.

Returns (None, None) if retrieval fails.

Return type:

Tuple[str, str]

Raises:

subprocess.CalledProcessError – If the git command fails.

Module contents