hf_zero_shot_classification_payload: Zero Shot Classification Payload

View source: R/inference.R

hf_zero_shot_classification_payloadR Documentation

Zero Shot Classification Payload

Description

This task is super useful to try out classification with zero code, you simply pass a sentence/paragraph and the possible labels for that sentence, and you get a result.

Usage

hf_zero_shot_classification_payload(
  string,
  candidate_labels,
  multi_label = FALSE
)

Arguments

string

a string or list of strings

candidate_labels

a list of strings that are potential classes for inputs. (max 10 candidate_labels, for more, simply run multiple requests, results are going to be misleading if using too many candidate_labels anyway. If you want to keep the exact same, you can simply run multi_label=True and do the scaling on your end. )

multi_label

(Default: false) Boolean that is set to True if classes can overlap

Value

An inference payload

See Also

https://huggingface.co/docs/api-inference/detailed_parameters#zeroshot-classification-task


farach/huggingfaceR documentation built on Feb. 4, 2023, 10:31 p.m.