transformers.js/src/generation/parameters.js

/**
 * @module generation/parameters
 */

/**
 * @typedef {Object} GenerationFunctionParameters
 * @property {import('../utils/tensor.js').Tensor} [inputs=null] (`Tensor` of varying shape depending on the modality, *optional*):
 * The sequence used as a prompt for the generation or as model inputs to the encoder. If `null` the
 * method initializes it with `bos_token_id` and a batch size of 1. For decoder-only models `inputs`
 * should be in the format of `input_ids`. For encoder-decoder models *inputs* can represent any of
 * `input_ids`, `input_values`, `input_features`, or `pixel_values`.
 * @property {import('./configuration_utils.js').GenerationConfig} [generation_config=null] (`GenerationConfig`, *optional*):
 * The generation configuration to be used as base parametrization for the generation call.
 * `**kwargs` passed to generate matching the attributes of `generation_config` will override them.
 * If `generation_config` is not provided, the default will be used, which has the following loading
 * priority:
 * - (1) from the `generation_config.json` model file, if it exists;
 * - (2) from the model configuration. Please note that unspecified parameters will inherit [`GenerationConfig`]'s
 * default values, whose documentation should be checked to parameterize generation.
 * @property {import('./logits_process.js').LogitsProcessorList} [logits_processor=null] (`LogitsProcessorList`, *optional*):
 * Custom logits processors that complement the default logits processors built from arguments and
 * generation config. If a logit processor is passed that is already created with the arguments or a
 * generation config an error is thrown. This feature is intended for advanced users.
 * @property {import('./stopping_criteria.js').StoppingCriteriaList} [stopping_criteria=null] (`StoppingCriteriaList`, *optional*):
 * Custom stopping criteria that complements the default stopping criteria built from arguments and a
 * generation config. If a stopping criteria is passed that is already created with the arguments or a
 * generation config an error is thrown. This feature is intended for advanced users.
 * @property {import('./streamers.js').BaseStreamer} [streamer=null] (`BaseStreamer`, *optional*):
 * Streamer object that will be used to stream the generated sequences. Generated tokens are passed
 * through `streamer.put(token_ids)` and the streamer is responsible for any further processing.
 * @property {number[]} [decoder_input_ids=null] (`number[]`, *optional*):
 * If the model is an encoder-decoder model, this argument is used to pass the `decoder_input_ids`.
 * @param {any} [kwargs] (`Dict[str, any]`, *optional*):
 */