From 9ff9afe889934d32cb888714c46af443499ca0c8 Mon Sep 17 00:00:00 2001 From: ines Date: Fri, 27 Oct 2017 14:37:42 +0200 Subject: [PATCH] Update spacy convert CLI docs --- website/api/_top-level/_cli.jade | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/website/api/_top-level/_cli.jade b/website/api/_top-level/_cli.jade index fc573e0ec..f19eb43d0 100644 --- a/website/api/_top-level/_cli.jade +++ b/website/api/_top-level/_cli.jade @@ -134,11 +134,12 @@ p p | Convert files into spaCy's #[+a("/api/annotation#json-input") JSON format] | for use with the #[code train] command and other experiment management - | functions. The right converter is chosen based on the file extension of - | the input file. Currently only supports #[code .conllu]. + | functions. The converter can be specified on the command line, or + | chosen based on the file extension of the input file. +code(false, "bash", "$", false, false, true). - spacy convert [input_file] [output_dir] [--n-sents] [--morphology] + spacy convert [input_file] [output_dir] [--converter] [--n-sents] + [--morphology] +table(["Argument", "Type", "Description"]) +row @@ -151,6 +152,11 @@ p +cell positional +cell Output directory for converted JSON file. + +row + +cell #[code converter], #[code -c] + +cell option + +cell #[+tag-new(2)] Name of converter to use (see below). + +row +cell #[code --n-sents], #[code -n] +cell option @@ -166,6 +172,25 @@ p +cell flag +cell Show help message and available arguments. +p The following converters are available: + ++table(["ID", "Description"]) + +row + +cell #[code auto] + +cell Automatically pick converter based on file extension (default). + + +row + +cell #[code conllu], #[code conll] + +cell Universal Dependencies #[code .conllu] or #[code .conll] format. + + +row + +cell #[code ner] + +cell Tab-based named entity recognition format. + + +row + +cell #[code iob] + +cell IOB named entity recognition format. + +h(3, "train") Train p