Function load

gensim/downloader.py:435–503

Download (if needed) dataset/model and load it to memory (unless `return_path` is set). Parameters ---------- name: str Name of the model/dataset. return_path: bool, optional If True, return full path to file, otherwise, return loaded model / iterable dataset. R

(name, return_path=False)

def load(name, return_path=False):
    """Download (if needed) dataset/model and load it to memory (unless `return_path` is set).

    Parameters
    ----------
    name: str
        Name of the model/dataset.
    return_path: bool, optional
        If True, return full path to file, otherwise, return loaded model / iterable dataset.

    Returns
    -------
    Model
        Requested model, if `name` is model and `return_path` == False.
    Dataset (iterable)
        Requested dataset, if `name` is dataset and `return_path` == False.
    str
        Path to file with dataset / model, only when `return_path` == True.

    Raises
    ------
    Exception
        Raised if `name` is incorrect.

    Examples
    --------
    Model example:

    .. sourcecode:: pycon

        >>> import gensim.downloader as api
        >>>
        >>> model = api.load("glove-twitter-25")  # load glove vectors
        >>> model.most_similar("cat")  # show words that similar to word 'cat'

    Dataset example:

    .. sourcecode:: pycon

        >>> import gensim.downloader as api
        >>>
        >>> wiki = api.load("wiki-en")  # load extracted Wikipedia dump, around 6 Gb
        >>> for article in wiki:  # iterate over all wiki script
        >>>     pass

    Download only example:

    .. sourcecode:: pycon

        >>> import gensim.downloader as api
        >>>
        >>> print(api.load("wiki-en", return_path=True))  # output: /home/user/gensim-data/wiki-en/wiki-en.gz

    """
    _create_base_dir()
    file_name = _get_filename(name)
    if file_name is None:
        raise ValueError("Incorrect model/corpus name")