Function debug_diff_cli

spacy/cli/debug_diff.py:16–69

Show a diff of a config file with respect to spaCy's defaults or another config file. If additional settings were used in the creation of the config file, then you must supply these as extra parameters to the command when comparing to the default settings. The generated diff can also be

(
    # fmt: off
    ctx: typer.Context,
    config_path: Path = Arg(
        ..., help="Path to config file", exists=True, allow_dash=True
    ),
    compare_to: Optional[Path] = Opt(
        None,
        help="Path to a config file to diff against, or `None` to compare against default settings",
        exists=True,
        allow_dash=True,
    ),
    optimize: Optimizations = Opt(
        Optimizations.efficiency.value,
        "--optimize",
        "-o",
        help="Whether the user config was optimized for efficiency or accuracy. Only relevant when comparing against the default config.",
    ),
    gpu: bool = Opt(
        False,
        "--gpu",
        "-G",
        help="Whether the original config can run on a GPU. Only relevant when comparing against the default config.",
    ),
    pretraining: bool = Opt(
        False,
        "--pretraining",
        "--pt",
        help="Whether to compare on a config with pretraining involved. Only relevant when comparing against the default config.",
    ),
    markdown: bool = Opt(
        False, "--markdown", "-md", help="Generate Markdown for GitHub issues"
    ),
    # fmt: on
)

    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
)
def debug_diff_cli(
    # fmt: off
    ctx: typer.Context,
    config_path: Path = Arg(
        ..., help="Path to config file", exists=True, allow_dash=True
    ),
    compare_to: Optional[Path] = Opt(
        None,
        help="Path to a config file to diff against, or `None` to compare against default settings",
        exists=True,
        allow_dash=True,
    ),
    optimize: Optimizations = Opt(
        Optimizations.efficiency.value,
        "--optimize",
        "-o",
        help="Whether the user config was optimized for efficiency or accuracy. Only relevant when comparing against the default config.",
    ),
    gpu: bool = Opt(
        False,
        "--gpu",
        "-G",
        help="Whether the original config can run on a GPU. Only relevant when comparing against the default config.",
    ),
    pretraining: bool = Opt(
        False,
        "--pretraining",
        "--pt",
        help="Whether to compare on a config with pretraining involved. Only relevant when comparing against the default config.",
    ),
    markdown: bool = Opt(
        False, "--markdown", "-md", help="Generate Markdown for GitHub issues"
    ),
    # fmt: on
):
    """Show a diff of a config file with respect to spaCy's defaults or another config file. If
    additional settings were used in the creation of the config file, then you
    must supply these as extra parameters to the command when comparing to the default settings. The generated diff
    can also be used when posting to the discussion forum to provide more
    information for the maintainers.

    The `optimize`, `gpu`, and `pretraining` options are only relevant when
    comparing against the default configuration (or specifically when `compare_to` is None).

    DOCS: https://spacy.io/api/cli#debug-diff
    """
    debug_diff(
        config_path=config_path,
        compare_to=compare_to,
        gpu=gpu,
        optimize=optimize,
        pretraining=pretraining,
        markdown=markdown,
    )


def debug_diff(