transformers.js/pr_1649/en/api/generation/parameters.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;generation/parameters&quot;,&quot;local&quot;:&quot;generationparameters&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;generation/parameters~GenerationFunctionParametersBase : Object&quot;,&quot;local&quot;:&quot;generationparametersgenerationfunctionparametersbase--object&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;generation/parameters~GenerationFunctionParameters : GenerationFunctionParametersBase | Partial. < GenerationConfig >&quot;,&quot;local&quot;:&quot;generationparametersgenerationfunctionparameters--generationfunctionparametersbase--partial--generationconfig-&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}">
		<link href="/docs/transformers.js/pr_1649/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/entry/start.5f753a22.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/chunks/scheduler.6efaaf90.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/chunks/singletons.c0807d75.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/chunks/paths.c5938264.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/entry/app.db3dfcb7.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/chunks/preload-helper.1d8e1e5d.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/chunks/index.eb3e1f0f.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/nodes/0.1b727385.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/nodes/8.34b3e695.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.16f13047.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;generation/parameters&quot;,&quot;local&quot;:&quot;generationparameters&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;generation/parameters~GenerationFunctionParametersBase : Object&quot;,&quot;local&quot;:&quot;generationparametersgenerationfunctionparametersbase--object&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;generation/parameters~GenerationFunctionParameters : GenerationFunctionParametersBase | Partial. < GenerationConfig >&quot;,&quot;local&quot;:&quot;generationparametersgenerationfunctionparameters--generationfunctionparametersbase--partial--generationconfig-&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p> <a id="module_generation/parameters" class="group"></a>  <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 h-7 max-sm:h-7 px-2 max-sm:px-1.5 text-sm font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0 hover:text-gray-800 dark:hover:text-gray-200"><svg class="sm:size-3.5 size-3" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-7 max-sm:h-7 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible sm:size-3.5 size-3 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg></button></div> </div>  <h1 class="relative group"><a id="generationparameters" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#generationparameters"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>generation/parameters</span></h1> <ul data-svelte-h="svelte-5umayr"><li><a href="#module_generation/parameters">generation/parameters</a> <ul><li><a href="#module_generation/parameters..GenerationFunctionParametersBase"><code>~GenerationFunctionParametersBase</code></a> : <code>Object</code></li> <li><a href="#module_generation/parameters..GenerationFunctionParameters"><code>~GenerationFunctionParameters</code></a> : <code>GenerationFunctionParametersBase</code> | <code>Partial.&lt;GenerationConfig&gt;</code></li></ul></li></ul> <hr> <a id="module_generation/parameters..GenerationFunctionParametersBase" class="group"></a>  <h2 class="relative group"><a id="generationparametersgenerationfunctionparametersbase--object" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#generationparametersgenerationfunctionparametersbase--object"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>generation/parameters~GenerationFunctionParametersBase : Object</span></h2> <p data-svelte-h="svelte-1wuofvz"><strong>Kind</strong>: inner typedef of <a href="#module_generation/parameters"><code>generation/parameters</code></a><br> <strong>Properties</strong></p> <table data-svelte-h="svelte-r41ni6"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>[inputs]</td><td><code><a href="#Tensor">Tensor</a></code></td><td><code></code></td><td><p>(<code>Tensor</code> of varying shape depending on the modality, <em>optional</em>):
The sequence used as a prompt for the generation or as model inputs to the encoder. If <code>null</code> the
method initializes it with <code>bos_token_id</code> and a batch size of 1. For decoder-only models <code>inputs</code>
should be in the format of <code>input_ids</code>. For encoder-decoder models <em>inputs</em> can represent any of
<code>input_ids</code>, <code>input_values</code>, <code>input_features</code>, or <code>pixel_values</code>.</p></td> </tr><tr><td>[generation_config]</td><td><code>GenerationConfig</code></td><td><code></code></td><td><p>(<code>GenerationConfig</code>, <em>optional</em>):
The generation configuration to be used as base parametrization for the generation call.
<code>**kwargs</code> passed to generate matching the attributes of <code>generation_config</code> will override them.
If <code>generation_config</code> is not provided, the default will be used, which has the following loading
priority:</p> <ul><li>(1) from the <code>generation_config.json</code> model file, if it exists;</li> <li>(2) from the model configuration. Please note that unspecified parameters will inherit [<code>GenerationConfig</code>]&#39;s
default values, whose documentation should be checked to parameterize generation.</li></ul></td> </tr><tr><td>[logits_processor]</td><td><code>LogitsProcessorList</code></td><td><code></code></td><td><p>(<code>LogitsProcessorList</code>, <em>optional</em>):
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.</p></td> </tr><tr><td>[stopping_criteria]</td><td><code>StoppingCriteria</code> | <code>Array</code> | <code>StoppingCriteriaList</code></td><td><code></code></td><td><p>(<code>StoppingCriteriaList</code>, <em>optional</em>):
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.</p></td> </tr><tr><td>[streamer]</td><td><code>BaseStreamer</code></td><td><code></code></td><td><p>(<code>BaseStreamer</code>, <em>optional</em>):
Streamer object that will be used to stream the generated sequences. Generated tokens are passed
through <code>streamer.put(token_ids)</code> and the streamer is responsible for any further processing.</p></td> </tr><tr><td>[decoder_input_ids]</td><td><code>Array</code> | <code><a href="#Tensor">Tensor</a></code></td><td><code></code></td><td><p>(<code>number[]</code> or <code>Tensor</code>, <em>optional</em>):
If the model is an encoder-decoder model, this argument is used to pass the <code>decoder_input_ids</code>.</p></td> </tr><tr><td>[past_key_values]</td><td><code><a href="#DynamicCache">DynamicCache</a></code> | <code>null</code></td><td><code></code></td><td><p>(<code>DynamicCache</code>, <em>optional</em>):
A cache object that stores previously computed key/value states. When provided, the model will
use these cached states to avoid recomputing them, significantly speeding up sequential generation.</p></td></tr></tbody></table> <hr> <a id="module_generation/parameters..GenerationFunctionParameters" class="group"></a>  <h2 class="relative group"><a id="generationparametersgenerationfunctionparameters--generationfunctionparametersbase--partial--generationconfig-" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#generationparametersgenerationfunctionparameters--generationfunctionparametersbase--partial--generationconfig-"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>generation/parameters~GenerationFunctionParameters : GenerationFunctionParametersBase | Partial. &lt; GenerationConfig ></span></h2> <p data-svelte-h="svelte-zfcqcp"><strong>Kind</strong>: inner typedef of <a href="#module_generation/parameters"><code>generation/parameters</code></a></p> <hr> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/transformers.js/blob/main/packages/transformers/docs/source/api/generation/parameters.md" target="_blank"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg> <span data-svelte-h="svelte-zjs2n5"><span class="underline">Update</span> on GitHub</span></a>  <p></p> 
			
			<script>
				{
					__sveltekit_rvrl7f = {
						assets: "/docs/transformers.js/pr_1649/en",
						base: "/docs/transformers.js/pr_1649/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/transformers.js/pr_1649/en/_app/immutable/entry/start.5f753a22.js"),
						import("/docs/transformers.js/pr_1649/en/_app/immutable/entry/app.db3dfcb7.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 8],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>