install_scoring_model {sentiment.ai}

Install a Scoring Model

Description

Install a Scoring Model

Usage

install_scoring_model(
  model = c("en.large", "en", "multi.large", "multi"),
  scoring = c("xgb", "glm"),
  scoring_version = "1.0",
  ...
)

Arguments

model

The embedding model, one of c("en.large", "en", "multi.large", "multi").

scoring

The scoring model, currently one of:

• "xgb" does default xgboost

• "glm" does generalized linear model (if you can't run xgboost)

scoring_version

Version of scoring model (will add more over time)

...

Additional options to the function, including:

• repo_url: OPTIONAL custom github repo blob url for external scoring models. The default repo_url is "https://github.com/BenWiseman/sentiment.ai/blob/main/models"

Details

This downloads the scoring models from a set repository in order to keep the main package within CRAN size limits.

In the future, this will also make it possible for the community to add new and improved models!

Value

0 if model did not need to be downloaded. 1 if model needed to be downloaded.