Skip to contents

Displays a table of all models that can be downloaded with download_pretrained(), along with their metadata.

Usage

list_models(type = NULL, language = NULL, downloaded_only = FALSE)

Arguments

type

Optional filter: "static" for embedding models, "diachronic" for temporal models, "stm" for topic models, or NULL for all.

language

Optional filter: "English", "French", "German", "Chinese", or NULL for all.

downloaded_only

If TRUE, only show models that have been downloaded (always includes bundled models).

Value

Invisible data frame of model metadata.

Examples

list_models()
#> Available models:
#>                                    model language n_terms n_dims   method
#>                       stm_fiction_cohort  English    1000    204      STM
#>                               stm_envsoc  English     817     NA      STM
#>               vecs_fasttext300_wiki_news  English 1000000    300 fastText
#>       vecs_fasttext300_wiki_news_subword  English 1000000    300 fastText
#>             vecs_fasttext300_commoncrawl  English 2000000    300 fastText
#>              vecs_glove300_wiki_gigaword  English  400000    300    GloVe
#>                     vecs_glove50_twitter  English 1193514     50    GloVe
#>                    vecs_glove200_twitter  English 1193514    200    GloVe
#>                  vecs_cbow300_googlenews  English 3000000    300     CBOW
#>                     vecs_sgns300_bnc_pos  English  163473    300     SGNS
#>         vecs_sgns300_googlengrams_kte_en  English  928250    300     SGNS
#>               vecs_glove300_metal_lyrics  English   52885    300    GloVe
#>                    vecs_svd20_metal_type  English   54187     20      SVD
#>                vecs_svd20_metal_position  English      74     20      SVD
#>              vecs_sgns300_coha_histwords  English   50000    300     SGNS
#>      vecs_sgns300_googlengrams_histwords  English  100000    300     SGNS
#>  vecs_sgns300_googlengrams_fic_histwords  English  100000    300     SGNS
#>   vecs_sgns300_googlengrams_histwords_fr   French  100000    300     SGNS
#>   vecs_sgns300_googlengrams_histwords_de   German  100000    300     SGNS
#>   vecs_sgns300_googlengrams_histwords_zh  Chinese   29701    300     SGNS
#>       vecs_svd300_googlengrams_histwords  English   75682    300      SVD
#>                vecs_sgns200_british_news  English   78879    200     SGNS
#>        type     downloaded
#>         stm        Bundled
#>         stm        Bundled
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>      static Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
list_models(type = "diachronic")
#> Model results:
#>                                    model language n_terms n_dims method
#>              vecs_sgns300_coha_histwords  English   50000    300   SGNS
#>      vecs_sgns300_googlengrams_histwords  English  100000    300   SGNS
#>  vecs_sgns300_googlengrams_fic_histwords  English  100000    300   SGNS
#>   vecs_sgns300_googlengrams_histwords_fr   French  100000    300   SGNS
#>   vecs_sgns300_googlengrams_histwords_de   German  100000    300   SGNS
#>   vecs_sgns300_googlengrams_histwords_zh  Chinese   29701    300   SGNS
#>       vecs_svd300_googlengrams_histwords  English   75682    300    SVD
#>                vecs_sgns200_british_news  English   78879    200   SGNS
#>        type     downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
#>  diachronic Not downloaded
list_models(downloaded_only = TRUE)
#> Model results:
#>               model language n_terms n_dims method type downloaded
#>  stm_fiction_cohort  English    1000    204    STM  stm    Bundled
#>          stm_envsoc  English     817     NA    STM  stm    Bundled