From b7b285971fb2e0f058e83ebebc4834cb670c4a7c Mon Sep 17 00:00:00 2001 From: ines Date: Thu, 26 Oct 2017 18:47:11 +0200 Subject: [PATCH] Update examples README --- examples/README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/examples/README.md b/examples/README.md index d7168f613..18a1760ec 100644 --- a/examples/README.md +++ b/examples/README.md @@ -2,20 +2,18 @@ # 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 - -For example, to run the [`nn_text_class.py`](nn_text_class.py) script, do: +To see the available arguments, you can use the `--help` or `-h` flag: ```bash -$ python examples/nn_text_class.py -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 +$ python examples/training/train_ner.py --help ``` -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 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. +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.