explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2024-12-26 18:06:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ines Montani 2017-01-14 21:12:11 +01:00 committed by GitHub
parent c77698af25
commit 332ce2d758
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
spacy/tests/README.md
View File

@ -56,7 +56,7 @@ def test_tokenizer_keep_urls(tokenizer, text):
assert len(tokens) == 1 assert len(tokens) == 1
``` ```
This will run the test once for each `text` value. Even if you're only testing one example, it's usually best to specify it as a parameter. This will later make it easier for people to quickly add additional test cases without having to modify the test. This will run the test once for each `text` value. Even if you're only testing one example, it's usually best to specify it as a parameter. This will later make it easier for others to quickly add additional test cases without having to modify the test.
You can also specify parameters as tuples to test with multiple values per test: You can also specify parameters as tuples to test with multiple values per test:
@ -88,7 +88,7 @@ These are the main fixtures that are currently available:
| `hu_tokenizer` | Creates a Hungarian `Tokenizer` object. | | `hu_tokenizer` | Creates a Hungarian `Tokenizer` object. |
| `en_vocab` | Creates an English `Vocab` object. | | `en_vocab` | Creates an English `Vocab` object. |
| `en_entityrecognizer` | Creates an English `EntityRecognizer` object. | | `en_entityrecognizer` | Creates an English `EntityRecognizer` object. |
| `lemmatizer` | Creates a `Lemmatizer` object from the installed language data (`None` if no language data is found). | `lemmatizer` | Creates a `Lemmatizer` object from the installed language data (`None` if no data is found).
| `EN` | Creates an instance of `English`. Only use for tests that require the models. | | `EN` | Creates an instance of `English`. Only use for tests that require the models. |
| `DE` | Creates an instance of `German`. Only use for tests that require the models. | | `DE` | Creates an instance of `German`. Only use for tests that require the models. |
| `text_file` | Creates an instance of `StringIO` to simulate reading from and writing to files. | | `text_file` | Creates an instance of `StringIO` to simulate reading from and writing to files. |
@ -128,8 +128,6 @@ def test_doc_token_api_strings(en_tokenizer):
assert doc[0].dep_ == 'ROOT' assert doc[0].dep_ == 'ROOT'
``` ```
If you're tokenizing before creating a `Doc`, make sure to use the tokenizer's vocab. Otherwise, you can also use the `en_vocab` fixture.
You can construct a `Doc` with the following arguments: You can construct a `Doc` with the following arguments:
| Argument | Description | | Argument | Description |
@ -139,8 +137,8 @@ You can construct a `Doc` with the following arguments:
| `heads` | List of heads as integers. | | `heads` | List of heads as integers. |
| `pos` | List of POS tags as text values. | | `pos` | List of POS tags as text values. |
| `tag` | List of tag names as text values. | | `tag` | List of tag names as text values. |
| `dep` | List of dependencies, as text values. | | `dep` | List of dependencies as text values. |
| `ents` | List of entity tuples with `ent_id`, `label`, `start`, `end` (for example `('Stewart Lee', 'PERSON', 0, 2)`). The `label` will be looked up in `doc.vocab.strings[label]`. | | `ents` | List of entity tuples with `ent_id`, `label`, `start`, `end` (for example `('Stewart Lee', 'PERSON', 0, 2)`). The `label` will be looked up in `vocab.strings[label]`. |
Here's how to quickly get these values from within spaCy: Here's how to quickly get these values from within spaCy: