Rooba
/
spaCy
mirror of https://github.com/explosion/spaCy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update examples README

This commit is contained in:
ines 2017-10-26 18:47:11 +02:00
parent cc2917c9e8
commit b7b285971f
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
examples/README.md
View File

@ -2,20 +2,18 @@
# spaCy examples # spaCy examples
The examples are Python scripts with well-behaved command line interfaces. For a full list of spaCy tutorials and code snippets, see the [documentation](https://spacy.io/docs/usage/tutorials). The examples are Python scripts with well-behaved command line interfaces. For
more detailed usage guides, see the [documentation](https://alpha.spacy.io/usage/).
## How to run an example To see the available arguments, you can use the `--help` or `-h` flag:
For example, to run the [`nn_text_class.py`](nn_text_class.py) script, do:
```bash ```bash
$ python examples/nn_text_class.py $ python examples/training/train_ner.py --help
usage: nn_text_class.py [-h] [-d 3] [-H 300] [-i 5] [-w 40000] [-b 24]
[-r 0.3] [-p 1e-05] [-e 0.005]
data_dir
nn_text_class.py: error: too few arguments
``` ```
You can print detailed help with the `-h` argument. While we try to keep the examples up to date, they are not currently exercised
by the test suite, as some of them require significant data downloads or take
While we try to keep the examples up to date, they are not currently exercised by the test suite, as some of them require significant data downloads or take time to train. If you find that an example is no longer running, [please tell us](https://github.com/explosion/spaCy/issues)! We know there's nothing worse than trying to figure out what you're doing wrong, and it turns out your code was never the problem. time to train. If you find that an example is no longer running,
[please tell us](https://github.com/explosion/spaCy/issues)! We know there's
nothing worse than trying to figure out what you're doing wrong, and it turns
out your code was never the problem.