Skip to contents

Get the log probability of each token in a sentence (or group of sentences) using a causal transformer model.


  model = getOption("pangoling.causal.default"),
  checkpoint = NULL,
  add_special_tokens = NULL,
  config_model = NULL,
  config_tokenizer = NULL,
  batch_size = 1,
  .id = NULL



Vector or list of texts.


Name of a pre-trained model or folder.


Folder of a checkpoint.


Whether to include special tokens. It has the same default as the AutoTokenizer method in Python.


List with other arguments that control how the model from Hugging Face is accessed.


List with other arguments that control how the tokenizer from Hugging Face is accessed.


Maximum size of the batch. Larges batches speedup processing but take more memory.


Name of the column with the sentence id.


A table with token names (token), log-probability (lp) and optionally sentence id.


A causal language model (also called GPT-like, auto-regressive, or decoder model) is a type of large language model usually used for text-generation that can predict the next word (or more accurately in fact token) based on a preceding context.

If not specified, the causal model that will be used is the one set in specified in the global option pangoling.causal.default, this can be accessed via getOption("pangoling.causal.default") (by default "gpt2"). To change the default option use options(pangoling.causal.default = "newcausalmodel").

A list of possible causal models can be found in Hugging Face website.

Using the config_model and config_tokenizer arguments, it's possible to control how the model and tokenizer from Hugging Face is accessed, see the Python method from_pretrained for details.

In case of errors when a new model is run, check the status of https://status.huggingface.co/

More examples

See the online article in pangoling website for more examples.

See also

Other causal model functions: causal_config(), causal_lp_mats(), causal_lp(), causal_next_tokens_tbl(), causal_preload()


if (FALSE) { # interactive()
  texts = c("The apple doesn't fall far from the tree."),
  model = "gpt2"