mirror of
https://github.com/explosion/spaCy.git
synced 2024-12-26 09:56:28 +03:00
Update CLI docs and document vocab command
This commit is contained in:
parent
5598542055
commit
12343e23fd
|
@ -34,6 +34,13 @@ p
|
||||||
+cell flag
|
+cell flag
|
||||||
+cell Show help message and available arguments.
|
+cell Show help message and available arguments.
|
||||||
|
|
||||||
|
+row("foot")
|
||||||
|
+cell creates
|
||||||
|
+cell directory, symlink
|
||||||
|
+cell
|
||||||
|
| The installed model package in your #[code site-packages]
|
||||||
|
| directory and a shortcut link as a symlink in #[code spacy/data].
|
||||||
|
|
||||||
+aside("Downloading best practices")
|
+aside("Downloading best practices")
|
||||||
| The #[code download] command is mostly intended as a convenient,
|
| The #[code download] command is mostly intended as a convenient,
|
||||||
| interactive wrapper – it performs compatibility checks and prints
|
| interactive wrapper – it performs compatibility checks and prints
|
||||||
|
@ -86,6 +93,13 @@ p
|
||||||
+cell flag
|
+cell flag
|
||||||
+cell Show help message and available arguments.
|
+cell Show help message and available arguments.
|
||||||
|
|
||||||
|
+row("foot")
|
||||||
|
+cell creates
|
||||||
|
+cell symlink
|
||||||
|
+cell
|
||||||
|
| A shortcut link of the given name as a symlink in
|
||||||
|
| #[code spacy/data].
|
||||||
|
|
||||||
+h(3, "info") Info
|
+h(3, "info") Info
|
||||||
|
|
||||||
p
|
p
|
||||||
|
@ -113,6 +127,11 @@ p
|
||||||
+cell flag
|
+cell flag
|
||||||
+cell Show help message and available arguments.
|
+cell Show help message and available arguments.
|
||||||
|
|
||||||
|
+row("foot")
|
||||||
|
+cell prints
|
||||||
|
+cell #[code stdout]
|
||||||
|
+cell Information about your spaCy installation.
|
||||||
|
|
||||||
+h(3, "validate") Validate
|
+h(3, "validate") Validate
|
||||||
+tag-new(2)
|
+tag-new(2)
|
||||||
|
|
||||||
|
@ -129,6 +148,12 @@ p
|
||||||
+code(false, "bash", "$").
|
+code(false, "bash", "$").
|
||||||
spacy validate
|
spacy validate
|
||||||
|
|
||||||
|
+table(["Argument", "Type", "Description"])
|
||||||
|
+row("foot")
|
||||||
|
+cell prints
|
||||||
|
+cell #[code stdout]
|
||||||
|
+cell Details about the compatibility of your installed models.
|
||||||
|
|
||||||
+h(3, "convert") Convert
|
+h(3, "convert") Convert
|
||||||
|
|
||||||
p
|
p
|
||||||
|
@ -172,6 +197,11 @@ p
|
||||||
+cell flag
|
+cell flag
|
||||||
+cell Show help message and available arguments.
|
+cell Show help message and available arguments.
|
||||||
|
|
||||||
|
+row("foot")
|
||||||
|
+cell creates
|
||||||
|
+cell JSON
|
||||||
|
+cell Data in spaCy's #[+a("/api/annotation#json-input") JSON format].
|
||||||
|
|
||||||
p The following converters are available:
|
p The following converters are available:
|
||||||
|
|
||||||
+table(["ID", "Description"])
|
+table(["ID", "Description"])
|
||||||
|
@ -286,6 +316,11 @@ p
|
||||||
+cell flag
|
+cell flag
|
||||||
+cell Show help message and available arguments.
|
+cell Show help message and available arguments.
|
||||||
|
|
||||||
|
+row("foot")
|
||||||
|
+cell creates
|
||||||
|
+cell model, pickle
|
||||||
|
+cell A spaCy model on each epoch, and a final #[code .pickle] file.
|
||||||
|
|
||||||
+h(4, "train-hyperparams") Environment variables for hyperparameters
|
+h(4, "train-hyperparams") Environment variables for hyperparameters
|
||||||
+tag-new(2)
|
+tag-new(2)
|
||||||
|
|
||||||
|
@ -395,6 +430,47 @@ p
|
||||||
+cell Gradient L2 norm constraint.
|
+cell Gradient L2 norm constraint.
|
||||||
+cell #[code 1.0]
|
+cell #[code 1.0]
|
||||||
|
|
||||||
|
+h(3, "vocab") Vocab
|
||||||
|
+tag-new(2)
|
||||||
|
|
||||||
|
p
|
||||||
|
| Compile a vocabulary from a #[+a("#") lexicon JSONL] file and optional
|
||||||
|
| word vectors. Will save out a valid spaCy model that you can load via
|
||||||
|
| #[+api("spacy#load") #[code spacy.load]] or package using the
|
||||||
|
| #[+api("cli#package") #[code package]] command.
|
||||||
|
|
||||||
|
+code(false, "bash", "$").
|
||||||
|
spacy vocab [lang] [output_dir] [lexemes_loc] [vectors_loc]
|
||||||
|
|
||||||
|
+table(["Argument", "Type", "Description"])
|
||||||
|
+row
|
||||||
|
+cell #[code lang]
|
||||||
|
+cell positional
|
||||||
|
+cell
|
||||||
|
| Model language
|
||||||
|
| #[+a("https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes") ISO code],
|
||||||
|
| e.g. #[code en].
|
||||||
|
|
||||||
|
+row
|
||||||
|
+cell #[code output_dir]
|
||||||
|
+cell positional
|
||||||
|
+cell Model output directory. Will be created if it doesn't exist.
|
||||||
|
|
||||||
|
+row
|
||||||
|
+cell #[code lexemes_loc]
|
||||||
|
+cell positional
|
||||||
|
+cell Location of lexical data in spaCy's #[+a("#") JSONL format].
|
||||||
|
|
||||||
|
+row
|
||||||
|
+cell #[code vectors_loc]
|
||||||
|
+cell positional
|
||||||
|
+cell Optional location of vectors data as numpy #[code .npz] file.
|
||||||
|
|
||||||
|
+row("foot")
|
||||||
|
+cell creates
|
||||||
|
+cell model
|
||||||
|
+cell A spaCy model containing the vocab and vectors.
|
||||||
|
|
||||||
+h(3, "evaluate") Evaluate
|
+h(3, "evaluate") Evaluate
|
||||||
+tag-new(2)
|
+tag-new(2)
|
||||||
|
|
||||||
|
@ -447,6 +523,11 @@ p
|
||||||
+cell flag
|
+cell flag
|
||||||
+cell Use gold preprocessing.
|
+cell Use gold preprocessing.
|
||||||
|
|
||||||
|
+row("foot")
|
||||||
|
+cell prints / creates
|
||||||
|
+cell #[code stdout], HTML
|
||||||
|
+cell Training results and optional displaCy visualizations.
|
||||||
|
|
||||||
|
|
||||||
+h(3, "package") Package
|
+h(3, "package") Package
|
||||||
|
|
||||||
|
@ -459,11 +540,19 @@ p
|
||||||
| are downloaded from
|
| are downloaded from
|
||||||
| #[+src(gh("spacy-dev-resources", "templates/model")) GitHub] to make
|
| #[+src(gh("spacy-dev-resources", "templates/model")) GitHub] to make
|
||||||
| sure you're always using the latest versions. This means you need to be
|
| sure you're always using the latest versions. This means you need to be
|
||||||
| connected to the internet to use this command.
|
| connected to the internet to use this command. After packaging, you
|
||||||
|
| can run #[code python setup.py sdist] from the newly created directory
|
||||||
|
| to turn your model into an installable archive file.
|
||||||
|
|
||||||
+code(false, "bash", "$", false, false, true).
|
+code(false, "bash", "$", false, false, true).
|
||||||
spacy package [input_dir] [output_dir] [--meta-path] [--create-meta] [--force]
|
spacy package [input_dir] [output_dir] [--meta-path] [--create-meta] [--force]
|
||||||
|
|
||||||
|
+aside-code("Example", "bash").
|
||||||
|
spacy package /input /output
|
||||||
|
cd /output/en_model-0.0.0
|
||||||
|
python setup.py sdist
|
||||||
|
pip install dist/en_model-0.0.0.tar.gz
|
||||||
|
|
||||||
+table(["Argument", "Type", "Description"])
|
+table(["Argument", "Type", "Description"])
|
||||||
+row
|
+row
|
||||||
+cell #[code input_dir]
|
+cell #[code input_dir]
|
||||||
|
@ -497,3 +586,8 @@ p
|
||||||
+cell #[code --help], #[code -h]
|
+cell #[code --help], #[code -h]
|
||||||
+cell flag
|
+cell flag
|
||||||
+cell Show help message and available arguments.
|
+cell Show help message and available arguments.
|
||||||
|
|
||||||
|
+row("foot")
|
||||||
|
+cell creates
|
||||||
|
+cell directory
|
||||||
|
+cell A Python package containing the spaCy model.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user