Function parse_project_model_name

deeplabcut/modelzoo/utils.py:187–231

Parses model zoo model names for SuperAnimal models. Args: superanimal_name: the name of the SuperAnimal model name to parse Returns: project_name: the parsed SuperAnimal model name model_name: the model architecture (e.g., dlcrnet, hrnetw32)

(superanimal_name: str)

def parse_project_model_name(superanimal_name: str) -> tuple[str, str]:
    """Parses model zoo model names for SuperAnimal models.

    Args:
        superanimal_name: the name of the SuperAnimal model name to parse

    Returns:
        project_name: the parsed SuperAnimal model name
        model_name: the model architecture (e.g., dlcrnet, hrnetw32)
    """

    if superanimal_name == "superanimal_quadruped":
        warnings.warn(
            f"{superanimal_name} is deprecated and will be removed in a future version. Use"
            f"{superanimal_name}_model_suffix instead.",
            DeprecationWarning,
            stacklevel=2,
        )
        superanimal_name = "superanimal_quadruped_hrnetw32"

    if superanimal_name == "superanimal_topviewmouse":
        warnings.warn(
            f"{superanimal_name} is deprecated and will be removed in a future version. Use"
            f"{superanimal_name}_model_suffix instead.",
            DeprecationWarning,
            stacklevel=2,
        )
        superanimal_name = "superanimal_topviewmouse_dlcrnet"

    model_name = superanimal_name.split("_")[-1]
    project_name = superanimal_name.replace(f"_{model_name}", "")

    dlc_root_path = get_deeplabcut_path()
    modelzoo_path = os.path.join(dlc_root_path, "modelzoo")

    available_model_configs = glob(os.path.join(modelzoo_path, "model_configs", "*.yaml"))
    available_models = [os.path.splitext(os.path.basename(path))[0] for path in available_model_configs]

    if model_name not in available_models:
        raise ValueError(f"Model {model_name} not found. Available models are: {available_models}")

    available_project_configs = glob(os.path.join(modelzoo_path, "project_configs", "*.yaml"))
    [os.path.splitext(os.path.basename(path))[0] for path in available_project_configs]

    return project_name, model_name


def get_superanimal_colormaps():