From dbe86b3453e1883410dba7377799ee3281896349 Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Sun, 28 Jun 2020 15:45:19 +0200 Subject: [PATCH] Update project.py --- spacy/cli/project.py | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/spacy/cli/project.py b/spacy/cli/project.py index f5f41cc3a..8d06c494a 100644 --- a/spacy/cli/project.py +++ b/spacy/cli/project.py @@ -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