Update project.py

This commit is contained in:
Ines Montani 2020-06-28 15:45:19 +02:00
parent dbfa292ed3
commit dbe86b3453

View File

@ -38,9 +38,15 @@ CACHES = [
]
DVC_CONFIG_COMMENT = """# This file is auto-generated by spaCy based on your project.yml. Do not edit
# it directly and edit the project.yml instead and re-run the project."""
CLI_HELP = f"""Command-line interface for spaCy projects and working with project
templates. You'd typically start by cloning a project template to a local
directory and fetching its assets like datasets etc. See the project's
{CONFIG_FILE} for the available commands. Under the hood, spaCy uses DVC (Data
Version Control) to manage input and output files and to ensure steps are only
re-run if their inputs change.
"""
project_cli = typer.Typer(help="Command-line interface for spaCy projects")
project_cli = typer.Typer(help=CLI_HELP)
@project_cli.callback(invoke_without_command=True)
@ -96,7 +102,7 @@ def project_assets_cli(
project_dir: Path = Arg(..., help="Path to cloned project", exists=True, file_okay=False),
# fmt: on
):
"""Use DVC (Data Version Control) to fetch the assets for the project,
"""Use DVC (Data Version Control) to fetch project assets. Assets are
defined in the "assets" section of the project config. If possible, DVC
will try to track the files so you can pull changes from upstream. It will
also try and store the checksum so the assets are versioned. If th file