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

Update Vectors.find docs [ci skip]

Browse Source
This commit is contained in:
Ines Montani 2019-03-16 17:10:57 +01:00
parent 2eecd756fa
commit 2c5dd4d602
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spacy/vectors.pyx
View File

@ -247,7 +247,7 @@ cdef class Vectors:
Returns int, -1 if missing.
keys (iterable): Find rows that the keys point to.
Returns ndarray.
row (int): Find the first key that point to the row.
row (int): Find the first key that points to the row.
Returns int.
rows (iterable): Find the keys that point to the rows.
Returns ndarray.

21
website/docs/api/vectors.md
View File

@ -211,6 +211,27 @@ Iterate over `(key, vector)` pairs, in order.
| ---------- | ----- | -------------------------------- |
| **YIELDS** | tuple | `(key, vector)` pairs, in order. |
## Vectors.find (#find tag="method")
Look up one or more keys by row, or vice versa.
> #### Example
>
> ```python
> row = nlp.vocab.vectors.find(key=u"cat")
> rows = nlp.vocab.vectors.find(keys=[u"cat", u"dog"])
> key = nlp.vocab.vectors.find(row=256)
> keys = nlp.vocab.vectors.find(rows=[18, 256, 985])
> ```
| Name | Type | Description |
| ----------- | ------------------------------------- | ------------------------------------------------------------------------ |
| `key` | unicode / int | Find the row that the given key points to. Returns int, `-1` if missing. |
| `keys` | iterable | Find rows that the keys point to. Returns `ndarray`. |
| `row` | int | Find the first key that points to the row. Returns int. |
| `rows` | iterable | Find the keys that point to the rows. Returns ndarray. |
| **RETURNS** | The requested key, keys, row or rows. |
## Vectors.shape {#shape tag="property"}
Get `(rows, dims)` tuples of number of rows and number of dimensions in the