Update spacy convert CLI docs

This commit is contained in:
ines 2017-10-27 14:37:42 +02:00
parent 52f1bf2729
commit 9ff9afe889

View File

@ -134,11 +134,12 @@ p
p p
| Convert files into spaCy's #[+a("/api/annotation#json-input") JSON format] | Convert files into spaCy's #[+a("/api/annotation#json-input") JSON format]
| for use with the #[code train] command and other experiment management | for use with the #[code train] command and other experiment management
| functions. The right converter is chosen based on the file extension of | functions. The converter can be specified on the command line, or
| the input file. Currently only supports #[code .conllu]. | chosen based on the file extension of the input file.
+code(false, "bash", "$", false, false, true). +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"]) +table(["Argument", "Type", "Description"])
+row +row
@ -151,6 +152,11 @@ p
+cell positional +cell positional
+cell Output directory for converted JSON file. +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 +row
+cell #[code --n-sents], #[code -n] +cell #[code --n-sents], #[code -n]
+cell option +cell option
@ -166,6 +172,25 @@ p
+cell flag +cell flag
+cell Show help message and available arguments. +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 +h(3, "train") Train
p p