transformers.js/pr_1665/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;Type Definitions&quot;,&quot;local&quot;:&quot;type-definitions&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;GenerationFunctionParametersBase&quot;,&quot;local&quot;:&quot;generationfunctionparametersbase&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;GenerationFunctionParameters&quot;,&quot;local&quot;:&quot;generationfunctionparameters&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3}],&quot;depth&quot;:2}],&quot;depth&quot;:1}">
		<link href="/docs/transformers.js/pr_1665/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/entry/start.cb58eb6f.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/scheduler.6efaaf90.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/singletons.08239980.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/paths.611c3944.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/entry/app.9eafcf9d.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/preload-helper.4b821645.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/index.eb3e1f0f.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/nodes/0.d361a553.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/nodes/8.74bfd103.js">
		<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.699f2734.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;Type Definitions&quot;,&quot;local&quot;:&quot;type-definitions&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;GenerationFunctionParametersBase&quot;,&quot;local&quot;:&quot;generationfunctionparametersbase&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;GenerationFunctionParameters&quot;,&quot;local&quot;:&quot;generationfunctionparameters&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3}],&quot;depth&quot;:2}],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p>  <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>  <h2 class="relative group"><a id="type-definitions" 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="#type-definitions"><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>Type Definitions</span></h2> <a id="module_generation/parameters.GenerationFunctionParametersBase"></a>  <h3 class="relative group"><a id="generationfunctionparametersbase" 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="#generationfunctionparametersbase"><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>GenerationFunctionParametersBase</span></h3> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <ul data-svelte-h="svelte-j1y1x8"><li><code>inputs</code> (<a href="../utils/tensor#module_utils/tensor.Tensor"><code>Tensor</code></a>) <em>optional</em> — defaults to <code>null</code> — The sequence used as a prompt for 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>.</li> <li><code>generation_config</code> (<a href="./configuration_utils#module_generation/configuration_utils.GenerationConfig"><code>GenerationConfig</code></a>) <em>optional</em> — defaults to <code>null</code> — The generation configuration to use as the base parameters for the generation call.
<code>**kwargs</code> passed to generate that match attributes of <code>generation_config</code> will override them.
If <code>generation_config</code> is not provided, the default is used, with the following loading
priority:
<ul><li>(1) from the <code>generation_config.json</code> model file, if it exists;</li> <li>(2) from the model configuration. Unspecified parameters inherit the default values documented by <code>GenerationConfig</code>.</li></ul></li> <li><code>logits_processor</code> (<a href="./logits_process#module_generation/logits_process.LogitsProcessorList"><code>LogitsProcessorList</code></a>) <em>optional</em> — defaults to <code>null</code> — Custom logits processors that complement the default logits processors built from arguments and
the generation config. If a logits processor duplicates one already created from the arguments or
generation config, an error is thrown. This feature is intended for advanced users.</li> <li><code>stopping_criteria</code> (<a href="./stopping_criteria#module_generation/stopping_criteria.StoppingCriteria"><code>StoppingCriteria</code></a> | <a href="./stopping_criteria#module_generation/stopping_criteria.StoppingCriteria"><code>StoppingCriteria</code></a>[] | <a href="./stopping_criteria#module_generation/stopping_criteria.StoppingCriteriaList"><code>StoppingCriteriaList</code></a>) <em>optional</em> — defaults to <code>null</code> — Custom stopping criteria that complement the default stopping criteria built from arguments and the
generation config. If a stopping criterion duplicates one already created from the arguments or
generation config, an error is thrown. This feature is intended for advanced users.</li> <li><code>streamer</code> (<a href="./streamers#module_generation/streamers.BaseStreamer"><code>BaseStreamer</code></a>) <em>optional</em> — defaults to <code>null</code> — Streamer object 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.</li> <li><code>decoder_input_ids</code> (<code>number[]</code> | <a href="../utils/tensor#module_utils/tensor.Tensor"><code>Tensor</code></a>) <em>optional</em> — defaults to <code>null</code> — If the model is an encoder-decoder model, this argument is used to pass the <code>decoder_input_ids</code>.</li> <li><code>past_key_values</code> (<a href="./cache#module_generation/cache.DynamicCache"><code>DynamicCache</code></a> | <code>null</code>) <em>optional</em> — defaults to <code>null</code> — 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.</li></ul> <a id="module_generation/parameters.GenerationFunctionParameters"></a>  <h3 class="relative group"><a id="generationfunctionparameters" 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="#generationfunctionparameters"><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>GenerationFunctionParameters</span></h3> <p data-svelte-h="svelte-1c2plu4"><em>Type:</em> <a href="./parameters#module_generation/parameters.GenerationFunctionParametersBase"><code>GenerationFunctionParametersBase</code></a> &amp; <code>Partial</code>&lt;<a href="./configuration_utils#module_generation/configuration_utils.GenerationConfig"><code>GenerationConfig</code></a>&gt; &amp; <code>{[key: string]: unknown}</code></p> <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_1t06csc = {
						assets: "/docs/transformers.js/pr_1665/en",
						base: "/docs/transformers.js/pr_1665/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

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