Skip to contents

Download specified pretrained model

download_pretrained.Rd

Downloads a designated pretrained model available in the `text2map.pretrained` package, hosted on GitLab. Some models need to be downloaded just once per machine. Downloading may take a while. If no location is specified (recommended), the file will be saved in the packages data folder and can be loaded using `load_pretrained()`.

Usage

download_pretrained(
  model = NULL,
  location = NULL,
  force = FALSE,
  quiet = FALSE
)

Arguments

model

Character string indicating model name to be downloaded

location

Default is `NULL` (and recommended), and will save in the R package data folder. If desired, specify saving the model elsewhere. Note: if saved elsewhere, ensure you point `load_pretrained()` to the correct file location.

force

Default `FALSE`. If model already exists locally, download will be stopped unless `TRUE`.

quiet

Logical (default `FALSE`) to mute informational messages

Details

Currently, the following models are available to download:

  • vecs_fasttext300_wiki_news

  • vecs_fasttext300_wiki_news_subword

  • vecs_fasttext300_commoncrawl

  • vecs_glove300_wiki_gigaword

  • vecs_cbow300_googlenews

  • vecs_sgns300_bnc_pos

  • vecs_sgns300_googlengrams_kte_en

  • vecs_sgns300_coha_histwords

  • vecs_sgns300_googlengrams_histwords

  • vecs_sgns300_googlengrams_fic_histwords

  • vecs_sgns300_googlengrams_histwords_fr

  • vecs_sgns300_googlengrams_histwords_de

  • vecs_sgns300_googlengrams_histwords_zh

  • vecs_svd300_googlengrams_histwords

  • vecs_sgns200_british_news

Author

Dustin Stoltz