#
models

Definitions of all models available in Transformers.js.

Example: Load and run an `AutoModel`.

    import { AutoModel, AutoTokenizer } from '@xenova/transformers';

    let tokenizer = await AutoTokenizer.from_pretrained('Xenova/bert-base-uncased');
    let model = await AutoModel.from_pretrained('Xenova/bert-base-uncased');

    let inputs = await tokenizer('I love transformers!');
    let { logits } = await model(inputs);
    // Tensor {
    //     data: Float32Array(183132) [-7.117443084716797, -7.107812881469727, -7.092104911804199, ...]
    //     dims: (3) [1, 6, 30522],
    //     type: "float32",
    //     size: 183132,
    // }

We also provide other `AutoModel`s (listed below), which you can use in the same way as the Python library. For example:

Example: Load and run a `AutoModelForSeq2SeqLM`.

    import { AutoModelForSeq2SeqLM, AutoTokenizer } from '@xenova/transformers';

    let tokenizer = await AutoTokenizer.from_pretrained('Xenova/t5-small');
    let model = await AutoModelForSeq2SeqLM.from_pretrained('Xenova/t5-small');

    let { input_ids } = await tokenizer('translate English to German: I love transformers!');
    let outputs = await model.generate(input_ids);
    let decoded = tokenizer.decode(outputs[0], { skip_special_tokens: true });
    // 'Ich liebe Transformatoren!'

- models
  - static
    - .PreTrainedModel ⇐ `Callable`
      - `new PreTrainedModel(config, session)`
      - instance
        - `.dispose()` ⇒ `Promise.<Array<unknown>>`
        - `._call(model_inputs)` ⇒ `Promise.<Object>`
        - `.forward(model_inputs)` ⇒ `Promise.<Object>`
        - `._get_logits_processor(generation_config, input_ids_seq_length)` ⇒ `LogitsProcessorList`
        - `._get_generation_config(generation_config)` ⇒ `GenerationConfig`
        - `.groupBeams(beams)` ⇒ `Array`
        - `.addPastKeyValues(decoderFeeds, pastKeyValues, [hasDecoder])`
      - static
        - `.from_pretrained(pretrained_model_name_or_path, options)` ⇒ `Promise.<PreTrainedModel>`
    - .BaseModelOutput
      - `new BaseModelOutput(output)`
    - .BertForMaskedLM ⇐ `BertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`
    - .BertForSequenceClassification ⇐ `BertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`
    - .BertForTokenClassification ⇐ `BertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`
    - .BertForQuestionAnswering ⇐ `BertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`
    - .DebertaModel
    - .DebertaForMaskedLM
      - `._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`
    - .DebertaForSequenceClassification
      - `._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`
    - .DebertaForTokenClassification
      - `._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`
    - .DebertaForQuestionAnswering
      - `._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`
    - .DebertaV2Model
    - .DebertaV2ForMaskedLM
      - `._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`
    - .DebertaV2ForSequenceClassification
      - `._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`
    - .DebertaV2ForTokenClassification
      - `._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`
    - .DebertaV2ForQuestionAnswering
      - `._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`
    - .DistilBertForSequenceClassification ⇐ `DistilBertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`
    - .DistilBertForTokenClassification ⇐ `DistilBertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`
    - .DistilBertForQuestionAnswering ⇐ `DistilBertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`
    - .DistilBertForMaskedLM ⇐ `DistilBertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`
    - .MobileBertForMaskedLM ⇐ `MobileBertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`
    - .MobileBertForSequenceClassification ⇐ `MobileBertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`
    - .MobileBertForQuestionAnswering ⇐ `MobileBertPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`
    - .MPNetModel ⇐ `MPNetPreTrainedModel`
    - .MPNetForMaskedLM ⇐ `MPNetPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`
    - .MPNetForSequenceClassification ⇐ `MPNetPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`
    - .MPNetForTokenClassification ⇐ `MPNetPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`
    - .MPNetForQuestionAnswering ⇐ `MPNetPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`
    - .T5ForConditionalGeneration ⇐ `T5PreTrainedModel`
      - `new T5ForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
      - `.getStartBeams(inputs, numOutputTokens)` ⇒ `Array`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<Object>`
    - .MT5ForConditionalGeneration ⇐ `MT5PreTrainedModel`
      - `new MT5ForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
      - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `Array.<any>`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<any>`
    - .BartModel ⇐ `BartPretrainedModel`
      - `.generate()` ⇒ `Promise.<any>`
    - .BartForConditionalGeneration ⇐ `BartPretrainedModel`
      - `new BartForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
      - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<Object>`
    - .RobertaForMaskedLM ⇐ `RobertaPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`
    - .RobertaForSequenceClassification ⇐ `RobertaPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`
    - .RobertaForTokenClassification ⇐ `RobertaPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`
    - .RobertaForQuestionAnswering ⇐ `RobertaPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`
    - .XLMRobertaForMaskedLM ⇐ `XLMRobertaPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`
    - .XLMRobertaForSequenceClassification ⇐ `XLMRobertaPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`
    - .XLMRobertaForTokenClassification ⇐ `XLMRobertaPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`
    - .XLMRobertaForQuestionAnswering ⇐ `XLMRobertaPreTrainedModel`
      - `._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`
    - .WhisperModel ⇐ `WhisperPreTrainedModel`
      - `.generate(...args)` ⇒ `Promise.<any>`
    - .WhisperForConditionalGeneration ⇐ `WhisperPreTrainedModel`
      - `new WhisperForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
      - `.generate(inputs, generation_config, logits_processor)` ⇒ `Promise.<Object>`
      - `.getStartBeams(inputTokenIds, numOutputTokens)` ⇒ `Array`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<Object>`
      - `._extract_token_timestamps(generate_outputs, alignment_heads, [num_frames], [time_precision])` ⇒ `Tensor`
    - .VisionEncoderDecoderModel ⇐ `PreTrainedModel`
      - `new VisionEncoderDecoderModel(config, session, decoder_merged_session)`
      - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<any>`
    - .CLIPModel
    - .CLIPTextModelWithProjection
      - `.from_pretrained()` : `PreTrainedModel.from_pretrained`
    - .CLIPVisionModelWithProjection
      - `.from_pretrained()` : `PreTrainedModel.from_pretrained`
    - .GPT2PreTrainedModel
      - `new GPT2PreTrainedModel(config, session)`
    - .GPT2LMHeadModel ⇐ `GPT2PreTrainedModel`
      - `.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<any>`
    - .GPTNeoPreTrainedModel
      - `new GPTNeoPreTrainedModel(config, session)`
    - .GPTBigCodePreTrainedModel
      - `new GPTBigCodePreTrainedModel(config, session)`
    - .CodeGenPreTrainedModel
      - `new CodeGenPreTrainedModel(config, session)`
    - .CodeGenModel ⇐ `CodeGenPreTrainedModel`
      - `.generate(...args)` ⇒ `Promise.<any>`
    - .CodeGenForCausalLM ⇐ `CodeGenPreTrainedModel`
      - `.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<any>`
    - .LlamaPreTrainedModel
      - `new LlamaPreTrainedModel(config, session)`
    - .LlamaModel
      - `.generate(...args)` ⇒ `Promise.<any>`
    - .BloomPreTrainedModel
      - `new BloomPreTrainedModel(config, session)`
    - .BloomModel
      - `.generate(...args)` ⇒ `Promise.<any>`
    - .BloomForCausalLM
      - `.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<any>`
    - .MptPreTrainedModel
      - `new MptPreTrainedModel(config, session)`
    - .MptModel
      - `.generate(...args)` ⇒ `Promise.<any>`
    - .MptForCausalLM
      - `.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<any>`
    - .DetrObjectDetectionOutput
      - `new DetrObjectDetectionOutput(output)`
    - .DetrSegmentationOutput
      - `new DetrSegmentationOutput(output)`
    - .YolosObjectDetectionOutput
      - `new YolosObjectDetectionOutput(output)`
    - .SamImageSegmentationOutput
      - `new SamImageSegmentationOutput(output)`
    - .MarianMTModel
      - `new MarianMTModel(config, session, decoder_merged_session, generation_config)`
      - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<Seq2SeqLMOutput>`
    - .M2M100ForConditionalGeneration
      - `new M2M100ForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
      - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`
      - `.runBeam(beam)` ⇒ `Promise.<any>`
      - `.updateBeam(beam, newTokenId)`
      - `.forward(model_inputs)` ⇒ `Promise.<Seq2SeqLMOutput>`
    - .Wav2Vec2Model
    - .PretrainedMixin
      - instance
        - `.MODEL_CLASS_MAPPINGS` : `*`
        - `.BASE_IF_FAIL`
      - static
        - `.from_pretrained()` : `PreTrainedModel.from_pretrained`
    - .AutoModel
    - .AutoModelForSequenceClassification
    - .AutoModelForTokenClassification
    - .AutoModelForSeq2SeqLM
    - .AutoModelForCausalLM
    - .AutoModelForMaskedLM
    - .AutoModelForQuestionAnswering
    - .AutoModelForVision2Seq
    - .AutoModelForImageClassification
    - .AutoModelForImageSegmentation
    - .AutoModelForObjectDetection
    - .AutoModelForMaskGeneration
    - .Seq2SeqLMOutput
      - `new Seq2SeqLMOutput(output)`
    - .SequenceClassifierOutput
      - `new SequenceClassifierOutput(output)`
    - .TokenClassifierOutput
      - `new TokenClassifierOutput(output)`
    - .MaskedLMOutput
      - `new MaskedLMOutput(output)`
    - .QuestionAnsweringModelOutput
      - `new QuestionAnsweringModelOutput(output)`
    - .CausalLMOutput
      - `new CausalLMOutput(output)`
    - .CausalLMOutputWithPast
      - `new CausalLMOutputWithPast(output)`
  - inner
    - `~forward(self, model_inputs)` ⇒ `Promise.<Object>`
    - `~PretrainedOptions` : `*`
    - `~TypedArray` : `*`
    - `~DecoderOutput` ⇒ `Promise.<(Array<Array<number>>|EncoderDecoderOutput|DecoderOutput)>`
    - `~WhisperGenerationConfig` : `Object`

##
models.PreTrainedModel ⇐ `Callable`

A base class for pre-trained models that provides the model configuration and an ONNX session.

Kind: static class of `models`
Extends: `Callable`

- .PreTrainedModel ⇐ `Callable`
  - `new PreTrainedModel(config, session)`
  - instance
    - `.dispose()` ⇒ `Promise.<Array<unknown>>`
    - `._call(model_inputs)` ⇒ `Promise.<Object>`
    - `.forward(model_inputs)` ⇒ `Promise.<Object>`
    - `._get_logits_processor(generation_config, input_ids_seq_length)` ⇒ `LogitsProcessorList`
    - `._get_generation_config(generation_config)` ⇒ `GenerationConfig`
    - `.groupBeams(beams)` ⇒ `Array`
    - `.addPastKeyValues(decoderFeeds, pastKeyValues, [hasDecoder])`
  - static
    - `.from_pretrained(pretrained_model_name_or_path, options)` ⇒ `Promise.<PreTrainedModel>`

###
`new PreTrainedModel(config, session)`

Creates a new instance of the `PreTrainedModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The model configuration.
session | `any` | session for the model.

###
`preTrainedModel.dispose()` ⇒ `Promise.<Array<unknown>>`

Disposes of all the ONNX sessions that were created during inference.

Kind: instance method of `PreTrainedModel`
Returns: `Promise.<Array<unknown>>` - An array of promises, one for each ONNX session that is being disposed.
Todo

- Use https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry

###
`preTrainedModel._call(model_inputs)` ⇒ `Promise.<Object>`

Runs the model with the provided inputs

Kind: instance method of `PreTrainedModel`
Returns: `Promise.<Object>` - Object containing output tensors

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | Object containing input tensors

###
`preTrainedModel.forward(model_inputs)` ⇒ `Promise.<Object>`

Forward method for a pretrained model. If not overridden by a subclass, the correct forward method will be chosen based on the model type.

Kind: instance method of `PreTrainedModel`
Returns: `Promise.<Object>` - The output data from the model in the format specified in the ONNX model.
Throws:

- `Error` This method must be implemented in subclasses.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The input data to the model in the format specified in the ONNX model.

###
`preTrainedModel._get_logits_processor(generation_config, input_ids_seq_length)` ⇒ `LogitsProcessorList`

Kind: instance method of `PreTrainedModel`

Param | Type | Description
--- | --- | ---
generation_config | `GenerationConfig` |
input_ids_seq_length | `number` | The starting sequence length for the input ids.

###
`preTrainedModel._get_generation_config(generation_config)` ⇒ `GenerationConfig`

This function merges multiple generation configs together to form a final generation config to be used by the model for text generation. It first creates an empty `GenerationConfig` object, then it applies the model’s own `generation_config` property to it. Finally, if a `generation_config` object was passed in the arguments, it overwrites the corresponding properties in the final config with those of the passed config object.

Kind: instance method of `PreTrainedModel`
Returns: `GenerationConfig` - The final generation config object to be used by the model for text generation.

Param | Type | Description
--- | --- | ---
generation_config | `GenerationConfig` | A `GenerationConfig` object containing generation parameters.

###
`preTrainedModel.groupBeams(beams)` ⇒ `Array`

Groups an array of beam objects by their ids.

Kind: instance method of `PreTrainedModel`
Returns: `Array` - An array of arrays, where each inner array contains beam objects with the same id.

Param | Type | Description
--- | --- | ---
beams | `Array` | The array of beam objects to group.

###
`preTrainedModel.addPastKeyValues(decoderFeeds, pastKeyValues, [hasDecoder])`

Adds past key values to the decoder feeds object. If pastKeyValues is null, creates new tensors for past key values.

Kind: instance method of `PreTrainedModel`

Param | Type | Default | Description
--- | --- | --- | ---
decoderFeeds | `Object` |  | The decoder feeds object to add past key values to.
pastKeyValues | `Object` |  | An object containing past key values.
[hasDecoder] | `boolean` | `false` | Whether the model has a decoder.

###
`PreTrainedModel.from_pretrained(pretrained_model_name_or_path, options)` ⇒ `Promise.<PreTrainedModel>`

Instantiate one of the model classes of the library from a pretrained model.

The model class to instantiate is selected based on the `model_type` property of the config object (either passed as an argument or loaded from `pretrained_model_name_or_path` if possible)

Kind: static method of `PreTrainedModel`
Returns: `Promise.<PreTrainedModel>` - A new instance of the `PreTrainedModel` class.

Param | Type | Description
--- | --- | ---
pretrained_model_name_or_path | `string` | The name or path of the pretrained model. Can be either: A string, the model id of a pretrained model hosted inside a model repo on huggingface.co. Valid model ids can be located at the root-level, like `bert-base-uncased`, or namespaced under a user or organization name, like `dbmdz/bert-base-german-cased`. A path to a directory containing model weights, e.g., `./my_model_directory/`.
options | `PretrainedOptions` | Additional options for loading the model.

##
models.BaseModelOutput

Base class for model’s outputs, with potential hidden states and attentions.

Kind: static class of `models`

###
`new BaseModelOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.last_hidden_state | `Tensor` | Sequence of hidden-states at the output of the last layer of the model.
[output.hidden_states] | `Tensor` | Hidden-states of the model at the output of each layer plus the optional initial embedding outputs.
[output.attentions] | `Tensor` | Attentions weights after the attention softmax, used to compute the weighted average in the self-attention heads.

##
models.BertForMaskedLM ⇐ `BertPreTrainedModel`

BertForMaskedLM is a class representing a BERT model for masked language modeling.

Kind: static class of `models`
Extends: `BertPreTrainedModel`

###
`bertForMaskedLM._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`

Calls the model on new inputs.

Kind: instance method of `BertForMaskedLM`
Returns: `Promise.<MaskedLMOutput>` - An object containing the model’s output logits for masked language modeling.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.BertForSequenceClassification ⇐ `BertPreTrainedModel`

BertForSequenceClassification is a class representing a BERT model for sequence classification.

Kind: static class of `models`
Extends: `BertPreTrainedModel`

###
`bertForSequenceClassification._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `BertForSequenceClassification`
Returns: `Promise.<SequenceClassifierOutput>` - An object containing the model’s output logits for sequence classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.BertForTokenClassification ⇐ `BertPreTrainedModel`

BertForTokenClassification is a class representing a BERT model for token classification.

Kind: static class of `models`
Extends: `BertPreTrainedModel`

###
`bertForTokenClassification._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `BertForTokenClassification`
Returns: `Promise.<TokenClassifierOutput>` - An object containing the model’s output logits for token classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.BertForQuestionAnswering ⇐ `BertPreTrainedModel`

BertForQuestionAnswering is a class representing a BERT model for question answering.

Kind: static class of `models`
Extends: `BertPreTrainedModel`

###
`bertForQuestionAnswering._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`

Calls the model on new inputs.

Kind: instance method of `BertForQuestionAnswering`
Returns: `Promise.<QuestionAnsweringModelOutput>` - An object containing the model’s output logits for question answering.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DebertaModel

The bare DeBERTa Model transformer outputting raw hidden-states without any specific head on top.

Kind: static class of `models`

##
models.DebertaForMaskedLM

DeBERTa Model with a `language modeling` head on top.

Kind: static class of `models`

###
`debertaForMaskedLM._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`

Calls the model on new inputs.

Kind: instance method of `DebertaForMaskedLM`
Returns: `Promise.<MaskedLMOutput>` - An object containing the model’s output logits for masked language modeling.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DebertaForSequenceClassification

DeBERTa Model transformer with a sequence classification/regression head on top (a linear layer on top of the pooled output)

Kind: static class of `models`

###
`debertaForSequenceClassification._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `DebertaForSequenceClassification`
Returns: `Promise.<SequenceClassifierOutput>` - An object containing the model’s output logits for sequence classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DebertaForTokenClassification

DeBERTa Model with a token classification head on top (a linear layer on top of the hidden-states output) e.g. for Named-Entity-Recognition (NER) tasks.

Kind: static class of `models`

###
`debertaForTokenClassification._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `DebertaForTokenClassification`
Returns: `Promise.<TokenClassifierOutput>` - An object containing the model’s output logits for token classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DebertaForQuestionAnswering

DeBERTa Model with a span classification head on top for extractive question-answering tasks like SQuAD (a linear layers on top of the hidden-states output to compute `span start logits` and `span end logits`).

Kind: static class of `models`

###
`debertaForQuestionAnswering._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`

Calls the model on new inputs.

Kind: instance method of `DebertaForQuestionAnswering`
Returns: `Promise.<QuestionAnsweringModelOutput>` - An object containing the model’s output logits for question answering.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DebertaV2Model

The bare DeBERTa-V2 Model transformer outputting raw hidden-states without any specific head on top.

Kind: static class of `models`

##
models.DebertaV2ForMaskedLM

DeBERTa-V2 Model with a `language modeling` head on top.

Kind: static class of `models`

###
`debertaV2ForMaskedLM._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`

Calls the model on new inputs.

Kind: instance method of `DebertaV2ForMaskedLM`
Returns: `Promise.<MaskedLMOutput>` - An object containing the model’s output logits for masked language modeling.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DebertaV2ForSequenceClassification

DeBERTa-V2 Model transformer with a sequence classification/regression head on top (a linear layer on top of the pooled output)

Kind: static class of `models`

###
`debertaV2ForSequenceClassification._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `DebertaV2ForSequenceClassification`
Returns: `Promise.<SequenceClassifierOutput>` - An object containing the model’s output logits for sequence classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DebertaV2ForTokenClassification

DeBERTa-V2 Model with a token classification head on top (a linear layer on top of the hidden-states output) e.g. for Named-Entity-Recognition (NER) tasks.

Kind: static class of `models`

###
`debertaV2ForTokenClassification._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `DebertaV2ForTokenClassification`
Returns: `Promise.<TokenClassifierOutput>` - An object containing the model’s output logits for token classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DebertaV2ForQuestionAnswering

DeBERTa-V2 Model with a span classification head on top for extractive question-answering tasks like SQuAD (a linear layers on top of the hidden-states output to compute `span start logits` and `span end logits`).

Kind: static class of `models`

###
`debertaV2ForQuestionAnswering._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`

Calls the model on new inputs.

Kind: instance method of `DebertaV2ForQuestionAnswering`
Returns: `Promise.<QuestionAnsweringModelOutput>` - An object containing the model’s output logits for question answering.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DistilBertForSequenceClassification ⇐ `DistilBertPreTrainedModel`

DistilBertForSequenceClassification is a class representing a DistilBERT model for sequence classification.

Kind: static class of `models`
Extends: `DistilBertPreTrainedModel`

###
`distilBertForSequenceClassification._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `DistilBertForSequenceClassification`
Returns: `Promise.<SequenceClassifierOutput>` - An object containing the model’s output logits for sequence classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DistilBertForTokenClassification ⇐ `DistilBertPreTrainedModel`

DistilBertForTokenClassification is a class representing a DistilBERT model for token classification.

Kind: static class of `models`
Extends: `DistilBertPreTrainedModel`

###
`distilBertForTokenClassification._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `DistilBertForTokenClassification`
Returns: `Promise.<TokenClassifierOutput>` - An object containing the model’s output logits for token classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DistilBertForQuestionAnswering ⇐ `DistilBertPreTrainedModel`

DistilBertForQuestionAnswering is a class representing a DistilBERT model for question answering.

Kind: static class of `models`
Extends: `DistilBertPreTrainedModel`

###
`distilBertForQuestionAnswering._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`

Calls the model on new inputs.

Kind: instance method of `DistilBertForQuestionAnswering`
Returns: `Promise.<QuestionAnsweringModelOutput>` - An object containing the model’s output logits for question answering.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.DistilBertForMaskedLM ⇐ `DistilBertPreTrainedModel`

DistilBertForMaskedLM is a class representing a DistilBERT model for masking task.

Kind: static class of `models`
Extends: `DistilBertPreTrainedModel`

###
`distilBertForMaskedLM._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`

Calls the model on new inputs.

Kind: instance method of `DistilBertForMaskedLM`
Returns: `Promise.<MaskedLMOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.MobileBertForMaskedLM ⇐ `MobileBertPreTrainedModel`

MobileBertForMaskedLM is a class representing a MobileBERT model for masking task.

Kind: static class of `models`
Extends: `MobileBertPreTrainedModel`

###
`mobileBertForMaskedLM._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`

Calls the model on new inputs.

Kind: instance method of `MobileBertForMaskedLM`
Returns: `Promise.<MaskedLMOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.MobileBertForSequenceClassification ⇐ `MobileBertPreTrainedModel`

Kind: static class of `models`
Extends: `MobileBertPreTrainedModel`

###
`mobileBertForSequenceClassification._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `MobileBertForSequenceClassification`
Returns: `Promise.<SequenceClassifierOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.MobileBertForQuestionAnswering ⇐ `MobileBertPreTrainedModel`

Kind: static class of `models`
Extends: `MobileBertPreTrainedModel`

###
`mobileBertForQuestionAnswering._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`

Calls the model on new inputs.

Kind: instance method of `MobileBertForQuestionAnswering`
Returns: `Promise.<QuestionAnsweringModelOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.MPNetModel ⇐ `MPNetPreTrainedModel`

The bare MPNet Model transformer outputting raw hidden-states without any specific head on top.

Kind: static class of `models`
Extends: `MPNetPreTrainedModel`

##
models.MPNetForMaskedLM ⇐ `MPNetPreTrainedModel`

MPNetForMaskedLM is a class representing a MPNet model for masked language modeling.

Kind: static class of `models`
Extends: `MPNetPreTrainedModel`

###
`mpNetForMaskedLM._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`

Calls the model on new inputs.

Kind: instance method of `MPNetForMaskedLM`
Returns: `Promise.<MaskedLMOutput>` - An object containing the model’s output logits for masked language modeling.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.MPNetForSequenceClassification ⇐ `MPNetPreTrainedModel`

MPNetForSequenceClassification is a class representing a MPNet model for sequence classification.

Kind: static class of `models`
Extends: `MPNetPreTrainedModel`

###
`mpNetForSequenceClassification._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `MPNetForSequenceClassification`
Returns: `Promise.<SequenceClassifierOutput>` - An object containing the model’s output logits for sequence classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.MPNetForTokenClassification ⇐ `MPNetPreTrainedModel`

MPNetForTokenClassification is a class representing a MPNet model for token classification.

Kind: static class of `models`
Extends: `MPNetPreTrainedModel`

###
`mpNetForTokenClassification._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `MPNetForTokenClassification`
Returns: `Promise.<TokenClassifierOutput>` - An object containing the model’s output logits for token classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.MPNetForQuestionAnswering ⇐ `MPNetPreTrainedModel`

MPNetForQuestionAnswering is a class representing a MPNet model for question answering.

Kind: static class of `models`
Extends: `MPNetPreTrainedModel`

###
`mpNetForQuestionAnswering._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`

Calls the model on new inputs.

Kind: instance method of `MPNetForQuestionAnswering`
Returns: `Promise.<QuestionAnsweringModelOutput>` - An object containing the model’s output logits for question answering.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.T5ForConditionalGeneration ⇐ `T5PreTrainedModel`

T5Model is a class representing a T5 model for conditional generation.

Kind: static class of `models`
Extends: `T5PreTrainedModel`

- .T5ForConditionalGeneration ⇐ `T5PreTrainedModel`
  - `new T5ForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
  - `.getStartBeams(inputs, numOutputTokens)` ⇒ `Array`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<Object>`

###
`new T5ForConditionalGeneration(config, session, decoder_merged_session, generation_config)`

Creates a new instance of the `T5ForConditionalGeneration` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The model configuration.
session | `any` | session for the model.
decoder_merged_session | `any` | session for the decoder.
generation_config | `GenerationConfig` | The generation configuration.

###
`t5ForConditionalGeneration.getStartBeams(inputs, numOutputTokens)` ⇒ `Array`

Generates the start beams for a given set of inputs and output length.

Kind: instance method of `T5ForConditionalGeneration`
Returns: `Array` - The start beams.

Param | Type | Description
--- | --- | ---
inputs | `Array.<Array<number>>` | The input token IDs.
numOutputTokens | `number` | The desired output length.

###
`t5ForConditionalGeneration.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `T5ForConditionalGeneration`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`t5ForConditionalGeneration.updateBeam(beam, newTokenId)`

Updates the given beam with a new token ID.

Kind: instance method of `T5ForConditionalGeneration`

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam.
newTokenId | `number` | The new token ID to add to the output sequence.

###
`t5ForConditionalGeneration.forward(model_inputs)` ⇒ `Promise.<Object>`

Runs the forward pass of the model for a given set of inputs.

Kind: instance method of `T5ForConditionalGeneration`
Returns: `Promise.<Object>` - The model output.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The model inputs.

##
models.MT5ForConditionalGeneration ⇐ `MT5PreTrainedModel`

A class representing a conditional sequence-to-sequence model based on the MT5 architecture.

Kind: static class of `models`
Extends: `MT5PreTrainedModel`

- .MT5ForConditionalGeneration ⇐ `MT5PreTrainedModel`
  - `new MT5ForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
  - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `Array.<any>`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<any>`

###
`new MT5ForConditionalGeneration(config, session, decoder_merged_session, generation_config)`

Creates a new instance of the `MT5ForConditionalGeneration` class.

Param | Type | Description
--- | --- | ---
config | `any` | The model configuration.
session | `any` | The ONNX session containing the encoder weights.
decoder_merged_session | `any` | The ONNX session containing the merged decoder weights.
generation_config | `GenerationConfig` | The generation configuration.

###
`mT5ForConditionalGeneration.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `Array.<any>`

Generates the start beams for the given input tokens and output sequence length.

Kind: instance method of `MT5ForConditionalGeneration`
Returns: `Array.<any>` - An array of `Beam` objects representing the start beams.

Param | Type | Description
--- | --- | ---
inputs | `Array.<any>` | The input sequence.
numOutputTokens | `number` | The desired length of the output sequence.
...args | `*` | Additional arguments to pass to the `seq2seqStartBeams` function.

###
`mT5ForConditionalGeneration.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `MT5ForConditionalGeneration`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`mT5ForConditionalGeneration.updateBeam(beam, newTokenId)`

Updates the given beam with the new predicted token.

Kind: instance method of `MT5ForConditionalGeneration`

Param | Type | Description
--- | --- | ---
beam | `any` | The beam to update.
newTokenId | `number` | The index of the predicted token.

###
`mT5ForConditionalGeneration.forward(model_inputs)` ⇒ `Promise.<any>`

Runs the forward pass of the model on the given inputs.

Kind: instance method of `MT5ForConditionalGeneration`
Returns: `Promise.<any>` - A Promise that resolves to the model outputs.

Param | Type | Description
--- | --- | ---
model_inputs | `any` | The model inputs.

##
models.BartModel ⇐ `BartPretrainedModel`

BART encoder and decoder model.

Kind: static class of `models`
Extends: `BartPretrainedModel`

###
`bartModel.generate()` ⇒ `Promise.<any>`

Throws an error because the current model class (BartModel) is not compatible with `.generate()`.

Kind: instance method of `BartModel`
Throws:

- `Error` The current model class (BartModel) is not compatible with `.generate()`.

##
models.BartForConditionalGeneration ⇐ `BartPretrainedModel`

BART model with a language model head for conditional generation.

Kind: static class of `models`
Extends: `BartPretrainedModel`

- .BartForConditionalGeneration ⇐ `BartPretrainedModel`
  - `new BartForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
  - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<Object>`

###
`new BartForConditionalGeneration(config, session, decoder_merged_session, generation_config)`

Creates a new instance of the `BartForConditionalGeneration` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The configuration object for the Bart model.
session | `Object` | The ONNX session used to execute the model.
decoder_merged_session | `Object` | The ONNX session used to execute the decoder.
generation_config | `Object` | The generation configuration object.

###
`bartForConditionalGeneration.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`

Returns the initial beam for generating output text.

Kind: instance method of `BartForConditionalGeneration`
Returns: `any` - The initial beam for generating output text.

Param | Type | Description
--- | --- | ---
inputs | `Object` | The input object containing the encoded input text.
numOutputTokens | `number` | The maximum number of output tokens to generate.
...args | `any` | Additional arguments to pass to the sequence-to-sequence generation function.

###
`bartForConditionalGeneration.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `BartForConditionalGeneration`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`bartForConditionalGeneration.updateBeam(beam, newTokenId)`

Updates the beam by appending the newly generated token ID to the list of output token IDs.

Kind: instance method of `BartForConditionalGeneration`

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.
newTokenId | `number` | The ID of the newly generated token to append to the list of output token IDs.

###
`bartForConditionalGeneration.forward(model_inputs)` ⇒ `Promise.<Object>`

Runs the forward pass of the model for a given set of inputs.

Kind: instance method of `BartForConditionalGeneration`
Returns: `Promise.<Object>` - The model output.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The model inputs.

##
models.RobertaForMaskedLM ⇐ `RobertaPreTrainedModel`

RobertaForMaskedLM class for performing masked language modeling on Roberta models.

Kind: static class of `models`
Extends: `RobertaPreTrainedModel`

###
`robertaForMaskedLM._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`

Calls the model on new inputs.

Kind: instance method of `RobertaForMaskedLM`
Returns: `Promise.<MaskedLMOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.RobertaForSequenceClassification ⇐ `RobertaPreTrainedModel`

RobertaForSequenceClassification class for performing sequence classification on Roberta models.

Kind: static class of `models`
Extends: `RobertaPreTrainedModel`

###
`robertaForSequenceClassification._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `RobertaForSequenceClassification`
Returns: `Promise.<SequenceClassifierOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.RobertaForTokenClassification ⇐ `RobertaPreTrainedModel`

RobertaForTokenClassification class for performing token classification on Roberta models.

Kind: static class of `models`
Extends: `RobertaPreTrainedModel`

###
`robertaForTokenClassification._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `RobertaForTokenClassification`
Returns: `Promise.<TokenClassifierOutput>` - An object containing the model’s output logits for token classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.RobertaForQuestionAnswering ⇐ `RobertaPreTrainedModel`

RobertaForQuestionAnswering class for performing question answering on Roberta models.

Kind: static class of `models`
Extends: `RobertaPreTrainedModel`

###
`robertaForQuestionAnswering._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`

Calls the model on new inputs.

Kind: instance method of `RobertaForQuestionAnswering`
Returns: `Promise.<QuestionAnsweringModelOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.XLMRobertaForMaskedLM ⇐ `XLMRobertaPreTrainedModel`

XLMRobertaForMaskedLM class for performing masked language modeling on XLMRoberta models.

Kind: static class of `models`
Extends: `XLMRobertaPreTrainedModel`

###
`xlmRobertaForMaskedLM._call(model_inputs)` ⇒ `Promise.<MaskedLMOutput>`

Calls the model on new inputs.

Kind: instance method of `XLMRobertaForMaskedLM`
Returns: `Promise.<MaskedLMOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.XLMRobertaForSequenceClassification ⇐ `XLMRobertaPreTrainedModel`

XLMRobertaForSequenceClassification class for performing sequence classification on XLMRoberta models.

Kind: static class of `models`
Extends: `XLMRobertaPreTrainedModel`

###
`xlmRobertaForSequenceClassification._call(model_inputs)` ⇒ `Promise.<SequenceClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `XLMRobertaForSequenceClassification`
Returns: `Promise.<SequenceClassifierOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.XLMRobertaForTokenClassification ⇐ `XLMRobertaPreTrainedModel`

XLMRobertaForTokenClassification class for performing token classification on XLMRoberta models.

Kind: static class of `models`
Extends: `XLMRobertaPreTrainedModel`

###
`xlmRobertaForTokenClassification._call(model_inputs)` ⇒ `Promise.<TokenClassifierOutput>`

Calls the model on new inputs.

Kind: instance method of `XLMRobertaForTokenClassification`
Returns: `Promise.<TokenClassifierOutput>` - An object containing the model’s output logits for token classification.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.XLMRobertaForQuestionAnswering ⇐ `XLMRobertaPreTrainedModel`

XLMRobertaForQuestionAnswering class for performing question answering on XLMRoberta models.

Kind: static class of `models`
Extends: `XLMRobertaPreTrainedModel`

###
`xlmRobertaForQuestionAnswering._call(model_inputs)` ⇒ `Promise.<QuestionAnsweringModelOutput>`

Calls the model on new inputs.

Kind: instance method of `XLMRobertaForQuestionAnswering`
Returns: `Promise.<QuestionAnsweringModelOutput>` - returned object

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs to the model.

##
models.WhisperModel ⇐ `WhisperPreTrainedModel`

WhisperModel class for training Whisper models without a language model head.

Kind: static class of `models`
Extends: `WhisperPreTrainedModel`

###
`whisperModel.generate(...args)` ⇒ `Promise.<any>`

Throws an error when attempting to generate output since this model doesn’t have a language model head.

Kind: instance method of `WhisperModel`
Throws:

- Error

Param | Type
--- | ---
...args | `Array.<any>`

##
models.WhisperForConditionalGeneration ⇐ `WhisperPreTrainedModel`

WhisperForConditionalGeneration class for generating conditional outputs from Whisper models.

Kind: static class of `models`
Extends: `WhisperPreTrainedModel`

- .WhisperForConditionalGeneration ⇐ `WhisperPreTrainedModel`
  - `new WhisperForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
  - `.generate(inputs, generation_config, logits_processor)` ⇒ `Promise.<Object>`
  - `.getStartBeams(inputTokenIds, numOutputTokens)` ⇒ `Array`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<Object>`
  - `._extract_token_timestamps(generate_outputs, alignment_heads, [num_frames], [time_precision])` ⇒ `Tensor`

###
`new WhisperForConditionalGeneration(config, session, decoder_merged_session, generation_config)`

Creates a new instance of the `WhisperForConditionalGeneration` class.

Param | Type | Description
--- | --- | ---
config | `Object` | Configuration object for the model.
session | `Object` | ONNX Session object for the model.
decoder_merged_session | `Object` | ONNX Session object for the decoder.
generation_config | `Object` | Configuration object for the generation process.

###
`whisperForConditionalGeneration.generate(inputs, generation_config, logits_processor)` ⇒ `Promise.<Object>`

Generates outputs based on input and generation configuration.

Kind: instance method of `WhisperForConditionalGeneration`
Returns: `Promise.<Object>` - Promise object represents the generated outputs.

Param | Type | Default | Description
--- | --- | --- | ---
inputs | `Object` |  | Input data for the model.
generation_config | `WhisperGenerationConfig` | `` | Configuration object for the generation process.
logits_processor | `Object` | `` | Optional logits processor object.

###
`whisperForConditionalGeneration.getStartBeams(inputTokenIds, numOutputTokens)` ⇒ `Array`

Gets the start beams for generating outputs.

Kind: instance method of `WhisperForConditionalGeneration`
Returns: `Array` - Array of start beams.

Param | Type | Description
--- | --- | ---
inputTokenIds | `Array` | Array of input token IDs.
numOutputTokens | `number` | Number of output tokens to generate.

###
`whisperForConditionalGeneration.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `WhisperForConditionalGeneration`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`whisperForConditionalGeneration.updateBeam(beam, newTokenId)`

Updates the beam by appending the newly generated token ID to the list of output token IDs.

Kind: instance method of `WhisperForConditionalGeneration`

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.
newTokenId | `number` | The ID of the newly generated token to append to the list of output token IDs.

###
`whisperForConditionalGeneration.forward(model_inputs)` ⇒ `Promise.<Object>`

Runs the forward pass of the model for a given set of inputs.

Kind: instance method of `WhisperForConditionalGeneration`
Returns: `Promise.<Object>` - The model output.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The model inputs.

###
`whisperForConditionalGeneration._extract_token_timestamps(generate_outputs, alignment_heads, [num_frames], [time_precision])` ⇒ `Tensor`

Calculates token-level timestamps using the encoder-decoder cross-attentions and dynamic time-warping (DTW) to map each output token to a position in the input audio.

Kind: instance method of `WhisperForConditionalGeneration`
Returns: `Tensor` - tensor containing the timestamps in seconds for each predicted token

Param | Type | Default | Description
--- | --- | --- | ---
generate_outputs | `Object` |  | Outputs generated by the model
generate_outputs.cross_attentions | `Array.<Array<Array<Tensor>>>` |  | The cross attentions output by the model
generate_outputs.decoder_attentions | `Array.<Array<Array<Tensor>>>` |  | The decoder attentions output by the model
generate_outputs.sequences | `Array.<Array<number>>` |  | The sequences output by the model
alignment_heads | `Array.<Array<number>>` |  | Alignment heads of the model
[num_frames] | `number` | `` | Number of frames in the input audio.
[time_precision] | `number` | `0.02` | Precision of the timestamps in seconds

##
models.VisionEncoderDecoderModel ⇐ `PreTrainedModel`

Vision Encoder-Decoder model based on OpenAI’s GPT architecture for image captioning and other vision tasks

Kind: static class of `models`
Extends: `PreTrainedModel`

- .VisionEncoderDecoderModel ⇐ `PreTrainedModel`
  - `new VisionEncoderDecoderModel(config, session, decoder_merged_session)`
  - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<any>`

###
`new VisionEncoderDecoderModel(config, session, decoder_merged_session)`

Creates a new instance of the `VisionEncoderDecoderModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The configuration object specifying the hyperparameters and other model settings.
session | `Object` | The ONNX session containing the encoder model.
decoder_merged_session | `any` | The ONNX session containing the merged decoder model.

###
`visionEncoderDecoderModel.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`

Generate beam search outputs for the given input pixels and number of output tokens.

Kind: instance method of `VisionEncoderDecoderModel`
Returns: `any` - An array of Beam objects representing the top-K output sequences.

Param | Type | Description
--- | --- | ---
inputs | `array` | The input pixels as a Tensor.
numOutputTokens | `number` | The number of output tokens to generate.
...args | `*` | Optional additional arguments to pass to seq2seqStartBeams.

###
`visionEncoderDecoderModel.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `VisionEncoderDecoderModel`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`visionEncoderDecoderModel.updateBeam(beam, newTokenId)`

Update the given beam with the additional predicted token ID.

Kind: instance method of `VisionEncoderDecoderModel`

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam.
newTokenId | `number` | The new predicted token ID to add to the beam's output sequence.

###
`visionEncoderDecoderModel.forward(model_inputs)` ⇒ `Promise.<any>`

Compute the forward pass of the model on the given input tensors.

Kind: instance method of `VisionEncoderDecoderModel`
Returns: `Promise.<any>` - The output tensor of the model.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The input tensors as an object with keys 'pixel_values' and 'decoder_input_ids'.

##
models.CLIPModel

CLIP Text and Vision Model with a projection layers on top

Example: Perform zero-shot image classification with a `CLIPModel`.

    import { AutoTokenizer, AutoProcessor, CLIPModel, RawImage } from '@xenova/transformers';

    // Load tokenizer, processor, and model
    let tokenizer = await AutoTokenizer.from_pretrained('Xenova/clip-vit-base-patch16');
    let processor = await AutoProcessor.from_pretrained('Xenova/clip-vit-base-patch16');
    let model = await CLIPModel.from_pretrained('Xenova/clip-vit-base-patch16');

    // Run tokenization
    let texts = ['a photo of a car', 'a photo of a football match']
    let text_inputs = tokenizer(texts, { padding: true, truncation: true });

    // Read image and run processor
    let image = await RawImage.read('https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/football-match.jpg');
    let image_inputs = await processor(image);

    // Run model with both text and pixel inputs
    let output = await model({ ...text_inputs, ...image_inputs });
    // {
    //   logits_per_image: Tensor {
    //     dims: [ 1, 2 ],
    //     data: Float32Array(2) [ 18.579734802246094, 24.31830596923828 ],
    //   },
    //   logits_per_text: Tensor {
    //     dims: [ 2, 1 ],
    //     data: Float32Array(2) [ 18.579734802246094, 24.31830596923828 ],
    //   },
    //   text_embeds: Tensor {
    //     dims: [ 2, 512 ],
    //     data: Float32Array(1024) [ ... ],
    //   },
    //   image_embeds: Tensor {
    //     dims: [ 1, 512 ],
    //     data: Float32Array(512) [ ... ],
    //   }
    // }

Kind: static class of `models`

##
models.CLIPTextModelWithProjection

CLIP Text Model with a projection layer on top (a linear layer on top of the pooled output)

Example: Compute text embeddings with `CLIPTextModelWithProjection`.

    import { AutoTokenizer, CLIPTextModelWithProjection } from '@xenova/transformers';

    // Load tokenizer and text model
    const tokenizer = await AutoTokenizer.from_pretrained('Xenova/clip-vit-base-patch16');
    const text_model = await CLIPTextModelWithProjection.from_pretrained('Xenova/clip-vit-base-patch16');

    // Run tokenization
    let texts = ['a photo of a car', 'a photo of a football match'];
    let text_inputs = tokenizer(texts, { padding: true, truncation: true });

    // Compute embeddings
    const { text_embeds } = await text_model(text_inputs);
    // Tensor {
    //   dims: [ 2, 512 ],
    //   type: 'float32',
    //   data: Float32Array(1024) [ ... ],
    //   size: 1024
    // }

Kind: static class of `models`

###
`CLIPTextModelWithProjection.from_pretrained()` : `PreTrainedModel.from_pretrained`

Kind: static method of `CLIPTextModelWithProjection`

##
models.CLIPVisionModelWithProjection

CLIP Vision Model with a projection layer on top (a linear layer on top of the pooled output)

Example: Compute vision embeddings with `CLIPVisionModelWithProjection`.

    import { AutoProcessor, CLIPVisionModelWithProjection, RawImage} from '@xenova/transformers';

    // Load processor and vision model
    const processor = await AutoProcessor.from_pretrained('Xenova/clip-vit-base-patch16');
    const vision_model = await CLIPVisionModelWithProjection.from_pretrained('Xenova/clip-vit-base-patch16');

    // Read image and run processor
    let image = await RawImage.read('https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/football-match.jpg');
    let image_inputs = await processor(image);

    // Compute embeddings
    const { image_embeds } = await vision_model(image_inputs);
    // Tensor {
    //   dims: [ 1, 512 ],
    //   type: 'float32',
    //   data: Float32Array(512) [ ... ],
    //   size: 512
    // }

Kind: static class of `models`

###
`CLIPVisionModelWithProjection.from_pretrained()` : `PreTrainedModel.from_pretrained`

Kind: static method of `CLIPVisionModelWithProjection`

##
models.GPT2PreTrainedModel

Kind: static class of `models`

###
`new GPT2PreTrainedModel(config, session)`

Creates a new instance of the `GPT2PreTrainedModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The configuration of the model.
session | `any` | The ONNX session containing the model weights.

##
models.GPT2LMHeadModel ⇐ `GPT2PreTrainedModel`

GPT-2 language model head on top of the GPT-2 base model. This model is suitable for text generation tasks.

Kind: static class of `models`
Extends: `GPT2PreTrainedModel`

- .GPT2LMHeadModel ⇐ `GPT2PreTrainedModel`
  - `.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<any>`

###
`gpT2LMHeadModel.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`

Initializes and returns the beam for text generation task

Kind: instance method of `GPT2LMHeadModel`
Returns: `any` - A Beam object representing the initialized beam.

Param | Type | Description
--- | --- | ---
inputTokenIds | `Tensor` | The input token ids.
numOutputTokens | `number` | The number of tokens to be generated.
inputs_attention_mask | `Tensor` | Optional input attention mask.

###
`gpT2LMHeadModel.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `GPT2LMHeadModel`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`gpT2LMHeadModel.updateBeam(beam, newTokenId)`

Updates the given beam with the new generated token id.

Kind: instance method of `GPT2LMHeadModel`

Param | Type | Description
--- | --- | ---
beam | `any` | The Beam object representing the beam.
newTokenId | `number` | The new generated token id to be added to the beam.

###
`gpT2LMHeadModel.forward(model_inputs)` ⇒ `Promise.<any>`

Forward pass for the model.

Kind: instance method of `GPT2LMHeadModel`
Returns: `Promise.<any>` - The output tensor of the model.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs for the model.

##
models.GPTNeoPreTrainedModel

Kind: static class of `models`

###
`new GPTNeoPreTrainedModel(config, session)`

Creates a new instance of the `GPTNeoPreTrainedModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The configuration of the model.
session | `any` | The ONNX session containing the model weights.

##
models.GPTBigCodePreTrainedModel

Kind: static class of `models`

###
`new GPTBigCodePreTrainedModel(config, session)`

Creates a new instance of the `GPTBigCodePreTrainedModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The configuration of the model.
session | `any` | The ONNX session containing the model weights.

##
models.CodeGenPreTrainedModel

Kind: static class of `models`

###
`new CodeGenPreTrainedModel(config, session)`

Creates a new instance of the `CodeGenPreTrainedModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The model configuration object.
session | `Object` | The ONNX session object.

##
models.CodeGenModel ⇐ `CodeGenPreTrainedModel`

CodeGenModel is a class representing a code generation model without a language model head.

Kind: static class of `models`
Extends: `CodeGenPreTrainedModel`

###
`codeGenModel.generate(...args)` ⇒ `Promise.<any>`

Throws an error indicating that the current model class is not compatible with `.generate()`, as it doesn’t have a language model head.

Kind: instance method of `CodeGenModel`
Throws:

- `Error` The current model class is not compatible with `.generate()`

Param | Type | Description
--- | --- | ---
...args | `any` | Arguments passed to the generate function

##
models.CodeGenForCausalLM ⇐ `CodeGenPreTrainedModel`

CodeGenForCausalLM is a class that represents a code generation model based on the GPT-2 architecture. It extends the `CodeGenPreTrainedModel` class.

Kind: static class of `models`
Extends: `CodeGenPreTrainedModel`

- .CodeGenForCausalLM ⇐ `CodeGenPreTrainedModel`
  - `.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<any>`

###
`codeGenForCausalLM.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`

Initializes and returns the beam for text generation task

Kind: instance method of `CodeGenForCausalLM`
Returns: `any` - A Beam object representing the initialized beam.

Param | Type | Description
--- | --- | ---
inputTokenIds | `Tensor` | The input token ids.
numOutputTokens | `number` | The number of tokens to be generated.
inputs_attention_mask | `Tensor` | Optional input attention mask.

###
`codeGenForCausalLM.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `CodeGenForCausalLM`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`codeGenForCausalLM.updateBeam(beam, newTokenId)`

Updates the given beam with the new generated token id.

Kind: instance method of `CodeGenForCausalLM`

Param | Type | Description
--- | --- | ---
beam | `any` | The Beam object representing the beam.
newTokenId | `number` | The new generated token id to be added to the beam.

###
`codeGenForCausalLM.forward(model_inputs)` ⇒ `Promise.<any>`

Forward pass for the model.

Kind: instance method of `CodeGenForCausalLM`
Returns: `Promise.<any>` - The output tensor of the model.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs for the model.

##
models.LlamaPreTrainedModel

The bare LLama Model outputting raw hidden-states without any specific head on top.

Kind: static class of `models`

###
`new LlamaPreTrainedModel(config, session)`

Creates a new instance of the `LlamaPreTrainedModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The model configuration object.
session | `Object` | The ONNX session object.

##
models.LlamaModel

The bare LLaMA Model outputting raw hidden-states without any specific head on top.

Kind: static class of `models`

###
`llamaModel.generate(...args)` ⇒ `Promise.<any>`

Throws an error indicating that the current model class is not compatible with `.generate()`, as it doesn’t have a language model head.

Kind: instance method of `LlamaModel`
Throws:

- `Error` The current model class is not compatible with `.generate()`

Param | Type | Description
--- | --- | ---
...args | `any` | Arguments passed to the generate function

##
models.BloomPreTrainedModel

The Bloom Model transformer with a language modeling head on top (linear layer with weights tied to the input embeddings).

Kind: static class of `models`

###
`new BloomPreTrainedModel(config, session)`

Creates a new instance of the `BloomPreTrainedModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The configuration of the model.
session | `any` | The ONNX session containing the model weights.

##
models.BloomModel

The bare Bloom Model transformer outputting raw hidden-states without any specific head on top.

Kind: static class of `models`

###
`bloomModel.generate(...args)` ⇒ `Promise.<any>`

BloomModel is not compatible with `.generate()`, as it doesn’t have a language model head.

Kind: instance method of `BloomModel`
Throws:

- `Error`

Param | Type
--- | ---
...args | `any`

##
models.BloomForCausalLM

The Bloom Model transformer with a language modeling head on top (linear layer with weights tied to the input embeddings).

Kind: static class of `models`

- .BloomForCausalLM
  - `.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<any>`

###
`bloomForCausalLM.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`

Initializes and returns the beam for text generation task

Kind: instance method of `BloomForCausalLM`
Returns: `any` - A Beam object representing the initialized beam.

Param | Type | Description
--- | --- | ---
inputTokenIds | `Tensor` | The input token ids.
numOutputTokens | `number` | The number of tokens to be generated.
inputs_attention_mask | `Tensor` | Optional input attention mask.

###
`bloomForCausalLM.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `BloomForCausalLM`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`bloomForCausalLM.updateBeam(beam, newTokenId)`

Updates the given beam with the new generated token id.

Kind: instance method of `BloomForCausalLM`

Param | Type | Description
--- | --- | ---
beam | `any` | The Beam object representing the beam.
newTokenId | `number` | The new generated token id to be added to the beam.

###
`bloomForCausalLM.forward(model_inputs)` ⇒ `Promise.<any>`

Forward pass for the model.

Kind: instance method of `BloomForCausalLM`
Returns: `Promise.<any>` - The output tensor of the model.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs for the model.

##
models.MptPreTrainedModel

Kind: static class of `models`

###
`new MptPreTrainedModel(config, session)`

Creates a new instance of the `MptPreTrainedModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The model configuration object.
session | `Object` | The ONNX session object.

##
models.MptModel

The bare Mpt Model transformer outputting raw hidden-states without any specific head on top.

Kind: static class of `models`

###
`mptModel.generate(...args)` ⇒ `Promise.<any>`

Throws an error indicating that the current model class is not compatible with `.generate()`, as it doesn’t have a language model head.

Kind: instance method of `MptModel`
Throws:

- `Error` The current model class is not compatible with `.generate()`

Param | Type | Description
--- | --- | ---
...args | `any` | Arguments passed to the generate function

##
models.MptForCausalLM

The MPT Model transformer with a language modeling head on top (linear layer with weights tied to the input embeddings).

Kind: static class of `models`

- .MptForCausalLM
  - `.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<any>`

###
`mptForCausalLM.getStartBeams(inputTokenIds, numOutputTokens, inputs_attention_mask)` ⇒ `any`

Initializes and returns the beam for text generation task

Kind: instance method of `MptForCausalLM`
Returns: `any` - A Beam object representing the initialized beam.

Param | Type | Description
--- | --- | ---
inputTokenIds | `Tensor` | The input token ids.
numOutputTokens | `number` | The number of tokens to be generated.
inputs_attention_mask | `Tensor` | Optional input attention mask.

###
`mptForCausalLM.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `MptForCausalLM`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`mptForCausalLM.updateBeam(beam, newTokenId)`

Updates the given beam with the new generated token id.

Kind: instance method of `MptForCausalLM`

Param | Type | Description
--- | --- | ---
beam | `any` | The Beam object representing the beam.
newTokenId | `number` | The new generated token id to be added to the beam.

###
`mptForCausalLM.forward(model_inputs)` ⇒ `Promise.<any>`

Forward pass for the model.

Kind: instance method of `MptForCausalLM`
Returns: `Promise.<any>` - The output tensor of the model.

Param | Type | Description
--- | --- | ---
model_inputs | `Object` | The inputs for the model.

##
models.DetrObjectDetectionOutput

Kind: static class of `models`

###
`new DetrObjectDetectionOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.logits | `Tensor` | Classification logits (including no-object) for all queries.
output.pred_boxes | `Tensor` | Normalized boxes coordinates for all queries, represented as (center_x, center_y, width, height). These values are normalized in [0, 1], relative to the size of each individual image in the batch (disregarding possible padding).

##
models.DetrSegmentationOutput

Kind: static class of `models`

###
`new DetrSegmentationOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.logits | `Tensor` | The output logits of the model.
output.pred_boxes | `Tensor` | Predicted boxes.
output.pred_masks | `Tensor` | Predicted masks.

##
models.YolosObjectDetectionOutput

Kind: static class of `models`

###
`new YolosObjectDetectionOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.logits | `Tensor` | Classification logits (including no-object) for all queries.
output.pred_boxes | `Tensor` | Normalized boxes coordinates for all queries, represented as (center_x, center_y, width, height). These values are normalized in [0, 1], relative to the size of each individual image in the batch (disregarding possible padding).

##
models.SamImageSegmentationOutput

Base class for Segment-Anything model’s output.

Kind: static class of `models`

###
`new SamImageSegmentationOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.iou_scores | `Tensor` | The output logits of the model.
output.pred_masks | `Tensor` | Predicted boxes.

##
models.MarianMTModel

Kind: static class of `models`

- .MarianMTModel
  - `new MarianMTModel(config, session, decoder_merged_session, generation_config)`
  - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<Seq2SeqLMOutput>`

###
`new MarianMTModel(config, session, decoder_merged_session, generation_config)`

Creates a new instance of the `MarianMTModel` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The model configuration object.
session | `Object` | The ONNX session object.
decoder_merged_session | `any` |
generation_config | `any` |

###
`marianMTModel.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`

Initializes and returns the beam for text generation task

Kind: instance method of `MarianMTModel`
Returns: `any` - A Beam object representing the initialized beam.

Param | Type | Description
--- | --- | ---
inputs | `Array.<any>` | The input token ids.
numOutputTokens | `number` | The number of tokens to be generated.
...args | `Array.<any>` |

###
`marianMTModel.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `MarianMTModel`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`marianMTModel.updateBeam(beam, newTokenId)`

Kind: instance method of `MarianMTModel`

Param | Type
--- | ---
beam | `any`
newTokenId | `any`

###
`marianMTModel.forward(model_inputs)` ⇒ `Promise.<Seq2SeqLMOutput>`

Kind: instance method of `MarianMTModel`

Param | Type
--- | ---
model_inputs | `any`

##
models.M2M100ForConditionalGeneration

Kind: static class of `models`

- .M2M100ForConditionalGeneration
  - `new M2M100ForConditionalGeneration(config, session, decoder_merged_session, generation_config)`
  - `.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`
  - `.runBeam(beam)` ⇒ `Promise.<any>`
  - `.updateBeam(beam, newTokenId)`
  - `.forward(model_inputs)` ⇒ `Promise.<Seq2SeqLMOutput>`

###
`new M2M100ForConditionalGeneration(config, session, decoder_merged_session, generation_config)`

Creates a new instance of the `M2M100ForConditionalGeneration` class.

Param | Type | Description
--- | --- | ---
config | `Object` | The model configuration object.
session | `Object` | The ONNX session object.
decoder_merged_session | `any` |
generation_config | `any` |

###
`m2M100ForConditionalGeneration.getStartBeams(inputs, numOutputTokens, ...args)` ⇒ `any`

Initializes and returns the beam for text generation task

Kind: instance method of `M2M100ForConditionalGeneration`
Returns: `any` - A Beam object representing the initialized beam.

Param | Type | Description
--- | --- | ---
inputs | `Array.<any>` | The input token ids.
numOutputTokens | `number` | The number of tokens to be generated.
...args | `Array.<any>` |

###
`m2M100ForConditionalGeneration.runBeam(beam)` ⇒ `Promise.<any>`

Runs a single step of the beam search generation algorithm.

Kind: instance method of `M2M100ForConditionalGeneration`
Returns: `Promise.<any>` - The updated beam after a single generation step.

Param | Type | Description
--- | --- | ---
beam | `any` | The current beam being generated.

###
`m2M100ForConditionalGeneration.updateBeam(beam, newTokenId)`

Kind: instance method of `M2M100ForConditionalGeneration`

Param | Type
--- | ---
beam | `any`
newTokenId | `any`

###
`m2M100ForConditionalGeneration.forward(model_inputs)` ⇒ `Promise.<Seq2SeqLMOutput>`

Kind: instance method of `M2M100ForConditionalGeneration`

Param | Type
--- | ---
model_inputs | `any`

##
models.Wav2Vec2Model

The bare Wav2Vec2 Model transformer outputting raw hidden-states without any specific head on top.

Example: Load and run an `Wav2Vec2Model` for feature extraction.

    import { AutoProcessor, read_audio } from '@xenova/transformers';

    // Read and preprocess audio
    const processor = await AutoProcessor.from_pretrained('Xenova/mms-300m');
    const audio = await read_audio('https://huggingface.co/datasets/Narsil/asr_dummy/resolve/main/mlk.flac', 16000);
    const inputs = await processor(audio);

    // Run model with inputs
    const model = await AutoModel.from_pretrained('Xenova/mms-300m');
    const output = await model(inputs);
    // {
    //   last_hidden_state: Tensor {
    //     dims: [ 1, 1144, 1024 ],
    //     type: 'float32',
    //     data: Float32Array(1171456) [ ... ],
    //     size: 1171456
    //   }
    // }

Kind: static class of `models`

##
models.PretrainedMixin

Base class of all AutoModels. Contains the `from_pretrained` function which is used to instantiate pretrained models.

Kind: static class of `models`

- .PretrainedMixin
  - instance
    - `.MODEL_CLASS_MAPPINGS` : `*`
    - `.BASE_IF_FAIL`
  - static
    - `.from_pretrained()` : `PreTrainedModel.from_pretrained`

###
`pretrainedMixin.MODEL_CLASS_MAPPINGS` : `*`

Mapping from model type to model class.

Kind: instance property of `PretrainedMixin`

###
`pretrainedMixin.BASE_IF_FAIL`

Whether to attempt to instantiate the base class (`PretrainedModel`) if the model type is not found in the mapping.

Kind: instance property of `PretrainedMixin`

###
`PretrainedMixin.from_pretrained()` : `PreTrainedModel.from_pretrained`

Kind: static method of `PretrainedMixin`

##
models.AutoModel

Helper class which is used to instantiate pretrained models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForSequenceClassification

Helper class which is used to instantiate pretrained sequence classification models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForTokenClassification

Helper class which is used to instantiate pretrained token classification models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForSeq2SeqLM

Helper class which is used to instantiate pretrained sequence-to-sequence models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForCausalLM

Helper class which is used to instantiate pretrained causal language models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForMaskedLM

Helper class which is used to instantiate pretrained masked language models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForQuestionAnswering

Helper class which is used to instantiate pretrained question answering models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForVision2Seq

Helper class which is used to instantiate pretrained vision-to-sequence models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForImageClassification

Helper class which is used to instantiate pretrained image classification models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForImageSegmentation

Helper class which is used to instantiate pretrained image segmentation models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForObjectDetection

Helper class which is used to instantiate pretrained object detection models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.AutoModelForMaskGeneration

Helper class which is used to instantiate pretrained object detection models with the `from_pretrained` function. The chosen model class is determined by the type specified in the model config.

Kind: static class of `models`

##
models.Seq2SeqLMOutput

Kind: static class of `models`

###
`new Seq2SeqLMOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.logits | `Tensor` | The output logits of the model.
output.past_key_values | `Tensor` | An tensor of key/value pairs that represent the previous state of the model.
output.encoder_outputs | `Tensor` | The output of the encoder in a sequence-to-sequence model.
[output.decoder_attentions] | `Tensor` | Attentions weights of the decoder, after the attention softmax, used to compute the weighted average in the self-attention heads.
[output.cross_attentions] | `Tensor` | Attentions weights of the decoder's cross-attention layer, after the attention softmax, used to compute the weighted average in the cross-attention heads.

##
models.SequenceClassifierOutput

Base class for outputs of sentence classification models.

Kind: static class of `models`

###
`new SequenceClassifierOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.logits | `Tensor` | classification (or regression if config.num_labels==1) scores (before SoftMax).

##
models.TokenClassifierOutput

Base class for outputs of token classification models.

Kind: static class of `models`

###
`new TokenClassifierOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.logits | `Tensor` | Classification scores (before SoftMax).

##
models.MaskedLMOutput

Base class for masked language models outputs.

Kind: static class of `models`

###
`new MaskedLMOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.logits | `Tensor` | Prediction scores of the language modeling head (scores for each vocabulary token before SoftMax).

##
models.QuestionAnsweringModelOutput

Base class for outputs of question answering models.

Kind: static class of `models`

###
`new QuestionAnsweringModelOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.start_logits | `Tensor` | Span-start scores (before SoftMax).
output.end_logits | `Tensor` | Span-end scores (before SoftMax).

##
models.CausalLMOutput

Base class for causal language model (or autoregressive) outputs.

Kind: static class of `models`

###
`new CausalLMOutput(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.logits | `Tensor` | Prediction scores of the language modeling head (scores for each vocabulary token before softmax).

##
models.CausalLMOutputWithPast

Base class for causal language model (or autoregressive) outputs.

Kind: static class of `models`

###
`new CausalLMOutputWithPast(output)`

Param | Type | Description
--- | --- | ---
output | `Object` | The output of the model.
output.logits | `Tensor` | Prediction scores of the language modeling head (scores for each vocabulary token before softmax).
output.past_key_values | `Tensor` | Contains pre-computed hidden-states (key and values in the self-attention blocks) that can be used (see `past_key_values` input) to speed up sequential decoding.

##
`models~forward(self, model_inputs)` ⇒ `Promise.<Object>`

Helper function to determine which `forward` method to run for a specific model.

Kind: inner method of `models`
Returns: `Promise.<Object>` - The model output

Param | Type | Description
--- | --- | ---
self | `Object` | The calling object
model_inputs | `Object` | The inputs to be sent to the model

##
`models~PretrainedOptions` : `*`

Kind: inner typedef of `models`

##
`models~TypedArray` : `*`

Kind: inner typedef of `models`

##
`models~DecoderOutput` ⇒ `Promise.<(Array<Array<number>>|EncoderDecoderOutput|DecoderOutput)>`

Generates text based on the given inputs and generation configuration using the model.

Kind: inner typedef of `models`
Returns: `Promise.<(Array<Array<number>>|EncoderDecoderOutput|DecoderOutput)>` - An array of generated output sequences, where each sequence is an array of token IDs.
Throws:

- `Error` Throws an error if the inputs array is empty.

Param | Type | Default | Description
--- | --- | --- | ---
inputs | `Tensor` | `Array` | `TypedArray` |  | An array of input token IDs.
generation_config | `Object` | `GenerationConfig` | `null` |  | The generation configuration to use. If null, default configuration will be used.
logits_processor | `Object` | `null` |  | An optional logits processor to use. If null, a new LogitsProcessorList instance will be created.
options | `Object` |  | options
[options.inputs_attention_mask] | `Object` | `` | An optional attention mask for the inputs.

##
`models~WhisperGenerationConfig` : `Object`

Kind: inner typedef of `models`
Extends: `GenerationConfig`
Properties

Name | Type | Default | Description
--- | --- | --- | ---
[return_timestamps] | `boolean` | `` | Whether to return the timestamps with the text. This enables the `WhisperTimestampsLogitsProcessor`.
[return_token_timestamps] | `boolean` | `` | Whether to return token-level timestamps with the text. This can be used with or without the `return_timestamps` option. To get word-level timestamps, use the tokenizer to group the tokens into words.
[num_frames] | `number` | `` | The number of audio frames available in this chunk. This is only used generating word-level timestamps.