# Vectorsclassv2.0 This feature is new and was introduced in spaCy v2.0Store, save and load word vectors.

Vectors data is kept in the `Vectors.data`

attribute, which should be an instance of `numpy.ndarray`

(for CPU vectors) or `cupy.ndarray`

(for GPU vectors). Multiple keys can be mapped to the same vector, and not all of the rows in the table need to be assigned – so `vectors.n_keys`

may be greater or smaller than `vectors.shape[0]`

.

## Vectors.__init__method

Create a new vector store. You can set the vector values and keys directly on initialisation, or supply a `shape`

keyword argument to create an empty table you can add vectors to later.

Name | Type | Description |
---|---|---|

`data` | `ndarray[ndim=1, dtype='float32']` | The vector data. |

`keys` | iterable | A sequence of keys aligned with the data. |

`shape` | tuple | Size of the table as `(n_entries, n_columns)` , the number of entries and number of columns. Not required if you're initialising the object with `data` and `keys` . |

returns | `Vectors` | The newly created object. |

## Vectors.__getitem__method

Get a vector by key. If the key is not found in the table, a `KeyError`

is raised.

Name | Type | Description |
---|---|---|

`key` | int | The key to get the vector for. |

returns | `ndarray[ndim=1, dtype='float32']` | The vector for the key. |

## Vectors.__setitem__method

Set a vector for the given key.

Name | Type | Description |
---|---|---|

`key` | int | The key to set the vector for. |

`vector` | `ndarray[ndim=1, dtype='float32']` | The vector to set. |

## Vectors.__iter__method

Iterate over the keys in the table.

Name | Type | Description |
---|---|---|

yields | int | A key in the table. |

## Vectors.__len__method

Return the number of vectors in the table.

Name | Type | Description |
---|---|---|

returns | int | The number of vectors in the table. |

## Vectors.__contains__method

Check whether a key has been mapped to a vector entry in the table.

Name | Type | Description |
---|---|---|

`key` | int | The key to check. |

returns | bool | Whether the key has a vector entry. |

## Vectors.addmethod

Add a key to the table, optionally setting a vector value as well. Keys can be mapped to an existing vector by setting `row`

, or a new vector can be added. When adding unicode keys, keep in mind that the `Vectors`

class itself has no `StringStore`

, so you have to store the hash-to-string mapping separately. If you need to manage the strings, you should use the `Vectors`

via the `Vocab`

class, e.g. `vocab.vectors`

.

Name | Type | Description |
---|---|---|

`key` | unicode / int | The key to add. |

`vector` | `ndarray[ndim=1, dtype='float32']` | An optional vector to add for the key. |

`row` | int | An optional row number of a vector to map the key to. |

returns | int | The row the vector was added to. |

## Vectors.resizemethod

Resize the underlying vectors array. If `inplace=True`

, the memory is reallocated. This may cause other references to the data to become invalid, so only use `inplace=True`

if you're sure that's what you want. If the number of vectors is reduced, keys mapped to rows that have
been deleted are removed. These removed items are returned as a list of `(key, row)`

tuples.

Name | Type | Description |
---|---|---|

`shape` | tuple | A `(rows, dims)` tuple describing the number of rows and dimensions. |

`inplace` | bool | Reallocate the memory. |

returns | list | The removed items as a list of `(key, row)` tuples. |

## Vectors.keysmethod

A sequence of the keys in the table.

Name | Type | Description |
---|---|---|

returns | iterable | The keys. |

## Vectors.valuesmethod

Iterate over vectors that have been assigned to at least one key. Note that some vectors may be unassigned, so the number of vectors returned may be less than the length of the vectors table.

Name | Type | Description |
---|---|---|

yields | `ndarray[ndim=1, dtype='float32']` | A vector in the table. |

## Vectors.itemsmethod

Iterate over `(key, vector)`

pairs, in order.

Name | Type | Description |
---|---|---|

yields | tuple | `(key, vector)` pairs, in order. |

## Vectors.shapeproperty

Get `(rows, dims)`

tuples of number of rows and number of dimensions in the vector table.

Name | Type | Description |
---|---|---|

returns | tuple | A `(rows, dims)` pair. |

## Vectors.sizeproperty

The vector size, i.e. `rows * dims`

.

Name | Type | Description |
---|---|---|

returns | int | The vector size. |

## Vectors.is_fullproperty

Whether the vectors table is full and has no slots are available for new
keys. If a table is full, it can be resized using `Vectors.resize`

.

Name | Type | Description |
---|---|---|

returns | bool | Whether the vectors table is full. |

## Vectors.n_keysproperty

Get the number of keys in the table. Note that this is the number of *all* keys, not just unique vectors. If several keys are mapped are mapped to the same vectors, they will be counted individually.

Name | Type | Description |
---|---|---|

returns | int | The number of all keys in the table. |

## Vectors.from_glovemethod

Load GloVe vectors from a directory. Assumes binary format, that the vocab is in a `vocab.txt`

, and that vectors are named `vectors.{size}.[fd].bin`

, e.g. `vectors.128.f.bin`

for 128d float32 vectors, `vectors.300.d.bin`

for 300d float64 (double) vectors, etc. By default GloVe outputs 64-bit vectors.

Name | Type | Description |
---|---|---|

`path` | unicode / `Path` | The path to load the GloVe vectors from. |

## Vectors.to_diskmethod

Save the current state to a directory.

Name | Type | Description |
---|---|---|

`path` | unicode / `Path` | A path to a directory, which will be created if it doesn't exist. Paths may be either strings or `Path` -like objects. |

`**exclude` | - | Named attributes to prevent from being saved. |

## Vectors.from_diskmethod

Loads state from a directory. Modifies the object in place and returns it.

Name | Type | Description |
---|---|---|

`path` | unicode / `Path` | A path to a directory. Paths may be either strings or `Path` -like objects. |

returns | `Vectors` | The modified `Vectors` object. |

## Vectors.to_bytesmethod

Serialize the current state to a binary string.

Name | Type | Description |
---|---|---|

`**exclude` | - | Named attributes to prevent from being serialized. |

returns | bytes | The serialized form of the `Vectors` object. |

## Vectors.from_bytesmethod

Load state from a binary string.

Name | Type | Description |
---|---|---|

`data` | bytes | The data to load from. |

`**exclude` | - | Named attributes to prevent from being loaded. |

returns | `Vectors` | The `Vectors` object. |

## Attributes

Name | Type | Description |
---|---|---|

`data` | `ndarray[ndim=1, dtype='float32']` | Stored vectors data. `numpy` is used for CPU vectors, `cupy` for GPU vectors. |

`key2row` | dict | Dictionary mapping word hashes to rows in the `Vectors.data` table. |

`keys` | `ndarray[ndim=1, dtype='float32']` | Array keeping the keys in order, such that `keys[vectors.key2row[key]] == key` |