spaCy/examples
Ines Montani 4cd9ec0f00
💫 Update training examples and use minibatching (#2830)
<!--- Provide a general summary of your changes in the title. -->

## Description
Update the training examples in `/examples/training` to show usage of spaCy's `minibatch` and `compounding` helpers ([see here](https://spacy.io/usage/training#tips-batch-size) for details). The lack of batching in the examples has caused some confusion in the past, especially for beginners who would copy-paste the examples, update them with large training sets and experienced slow and unsatisfying results.

### Types of change
enhancements

## Checklist
<!--- Before you submit the PR, go over this checklist and make sure you can
tick off all the boxes. [] -> [x] -->
- [x] I have submitted the spaCy Contributor Agreement.
- [x] I ran the tests, and all new and existing tests passed.
- [x] My changes don't require a change to the documentation, or if they do, I've added all required information.
2018-10-10 01:40:29 +02:00
..
information_extraction Add links to Reddit data (see #2401) 2018-05-31 16:22:43 +02:00
keras_parikh_entailment Update Keras Example for (Parikh et al, 2016) implementation (#2803) 2018-10-01 10:28:45 +02:00
notebooks Update Keras Example for (Parikh et al, 2016) implementation (#2803) 2018-10-01 10:28:45 +02:00
pipeline Add example for Issue #2627 2018-08-05 13:33:52 +02:00
training 💫 Update training examples and use minibatching (#2830) 2018-10-10 01:40:29 +02:00
README.md Get docs ready for v2.0.0 2017-11-07 12:00:43 +01:00
deep_learning_keras.py Fixed spaCy+Keras example (#2763) 2018-09-15 13:06:39 +02:00
vectors_fast_text.py Update vectors_loc description 2017-11-17 14:57:11 +01:00
vectors_tensorboard.py Port over TensorBoard example 2018-03-24 17:15:48 +01:00
vectors_tensorboard_standalone.py Add example using TensorBoard standalone projector 2018-03-25 21:50:13 -07:00

README.md

spaCy examples

The examples are Python scripts with well-behaved command line interfaces. For more detailed usage guides, see the documentation.

To see the available arguments, you can use the --help or -h flag:

$ python examples/training/train_ner.py --help

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! 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.