Buckets:
| <meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"processors","local":"processors","sections":[{"title":"processors.Processor","local":"processorsprocessor","sections":[{"title":"new Processor(config, components, chat_template)","local":"new-processorconfig-components-chattemplate","sections":[],"depth":3},{"title":"processor.image_processor ⇒ ImageProcessor | undefined","local":"processorimageprocessor--imageprocessor--undefined","sections":[],"depth":3},{"title":"processor.tokenizer ⇒ PreTrainedTokenizer | undefined","local":"processortokenizer--pretrainedtokenizer--undefined","sections":[],"depth":3},{"title":"processor.feature_extractor ⇒ FeatureExtractor | undefined","local":"processorfeatureextractor--featureextractor--undefined","sections":[],"depth":3},{"title":"processor.apply_chat_template(messages, options) ⇒ ReturnType. < PreTrainedTokenizer >","local":"processorapplychattemplatemessages-options--returntype--pretrainedtokenizer-","sections":[],"depth":3},{"title":"processor.batch_decode(...args) ⇒ ReturnType. < PreTrainedTokenizer >","local":"processorbatchdecodeargs--returntype--pretrainedtokenizer-","sections":[],"depth":3},{"title":"processor.decode(...args) ⇒ ReturnType. < PreTrainedTokenizer >","local":"processordecodeargs--returntype--pretrainedtokenizer-","sections":[],"depth":3},{"title":"processor._call(input, ...args) ⇒ Promise. < any >","local":"processorcallinput-args--promise--any-","sections":[],"depth":3},{"title":"Processor.from_pretrained(pretrained_model_name_or_path, options) ⇒ Promise. < Processor >","local":"processorfrompretrainedpretrainedmodelnameorpath-options--promise--processor-","sections":[],"depth":3}],"depth":2},{"title":"processors~PreTrainedTokenizer : Object","local":"processorspretrainedtokenizer--object","sections":[],"depth":2}],"depth":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/13.92ccbfb1.js"> | |
| <link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.16f13047.js"> | |
| <link rel="modulepreload" href="/docs/transformers.js/pr_1649/en/_app/immutable/chunks/CodeBlock.72c8dd07.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"processors","local":"processors","sections":[{"title":"processors.Processor","local":"processorsprocessor","sections":[{"title":"new Processor(config, components, chat_template)","local":"new-processorconfig-components-chattemplate","sections":[],"depth":3},{"title":"processor.image_processor ⇒ ImageProcessor | undefined","local":"processorimageprocessor--imageprocessor--undefined","sections":[],"depth":3},{"title":"processor.tokenizer ⇒ PreTrainedTokenizer | undefined","local":"processortokenizer--pretrainedtokenizer--undefined","sections":[],"depth":3},{"title":"processor.feature_extractor ⇒ FeatureExtractor | undefined","local":"processorfeatureextractor--featureextractor--undefined","sections":[],"depth":3},{"title":"processor.apply_chat_template(messages, options) ⇒ ReturnType. < PreTrainedTokenizer >","local":"processorapplychattemplatemessages-options--returntype--pretrainedtokenizer-","sections":[],"depth":3},{"title":"processor.batch_decode(...args) ⇒ ReturnType. < PreTrainedTokenizer >","local":"processorbatchdecodeargs--returntype--pretrainedtokenizer-","sections":[],"depth":3},{"title":"processor.decode(...args) ⇒ ReturnType. < PreTrainedTokenizer >","local":"processordecodeargs--returntype--pretrainedtokenizer-","sections":[],"depth":3},{"title":"processor._call(input, ...args) ⇒ Promise. < any >","local":"processorcallinput-args--promise--any-","sections":[],"depth":3},{"title":"Processor.from_pretrained(pretrained_model_name_or_path, options) ⇒ Promise. < Processor >","local":"processorfrompretrainedpretrainedmodelnameorpath-options--promise--processor-","sections":[],"depth":3}],"depth":2},{"title":"processors~PreTrainedTokenizer : Object","local":"processorspretrainedtokenizer--object","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <a id="module_processors" 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="processors" 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="#processors"><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>processors</span></h1> <p data-svelte-h="svelte-199vh5q">Processors are used to prepare inputs (e.g., text, image or audio) for a model.</p> <p data-svelte-h="svelte-1olsie5"><strong>Example:</strong> Using a <code>WhisperProcessor</code> to prepare an audio input for a model.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" 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> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START --><span class="hljs-keyword">import</span> { <span class="hljs-title class_">AutoProcessor</span>, read_audio } <span class="hljs-keyword">from</span> <span class="hljs-string">'@huggingface/transformers'</span>; | |
| <span class="hljs-keyword">const</span> processor = <span class="hljs-keyword">await</span> <span class="hljs-title class_">AutoProcessor</span>.<span class="hljs-title function_">from_pretrained</span>(<span class="hljs-string">'openai/whisper-tiny.en'</span>); | |
| <span class="hljs-keyword">const</span> audio = <span class="hljs-keyword">await</span> <span class="hljs-title function_">read_audio</span>(<span class="hljs-string">'https://huggingface.co/datasets/Narsil/asr_dummy/resolve/main/mlk.flac'</span>, <span class="hljs-number">16000</span>); | |
| <span class="hljs-keyword">const</span> { input_features } = <span class="hljs-keyword">await</span> <span class="hljs-title function_">processor</span>(audio); | |
| <span class="hljs-comment">// Tensor {</span> | |
| <span class="hljs-comment">// data: Float32Array(240000) [0.4752984642982483, 0.5597258806228638, 0.56434166431427, ...],</span> | |
| <span class="hljs-comment">// dims: [1, 80, 3000],</span> | |
| <span class="hljs-comment">// type: 'float32',</span> | |
| <span class="hljs-comment">// size: 240000,</span> | |
| <span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <ul data-svelte-h="svelte-ofp8fj"><li><a href="#module_processors">processors</a> <ul><li><em>static</em> <ul><li><a href="#module_processors.Processor">.Processor</a> <ul><li><a href="#new_module_processors.Processor_new"><code>new Processor(config, components, chat_template)</code></a></li> <li><em>instance</em> <ul><li><a href="#module_processors.Processor+image_processor"><code>.image_processor</code></a> ⇒ <code>ImageProcessor</code> | <code>undefined</code></li> <li><a href="#module_processors.Processor+tokenizer"><code>.tokenizer</code></a> ⇒ <code>PreTrainedTokenizer</code> | <code>undefined</code></li> <li><a href="#module_processors.Processor+feature_extractor"><code>.feature_extractor</code></a> ⇒ <a href="#FeatureExtractor"><code>FeatureExtractor</code></a> | <code>undefined</code></li> <li><a href="#module_processors.Processor+apply_chat_template"><code>.apply_chat_template(messages, options)</code></a> ⇒ <code>ReturnType.<PreTrainedTokenizer></code></li> <li><a href="#module_processors.Processor+batch_decode"><code>.batch_decode(...args)</code></a> ⇒ <code>ReturnType.<PreTrainedTokenizer></code></li> <li><a href="#module_processors.Processor+decode"><code>.decode(...args)</code></a> ⇒ <code>ReturnType.<PreTrainedTokenizer></code></li> <li><a href="#module_processors.Processor+_call"><code>._call(input, ...args)</code></a> ⇒ <code>Promise.<any></code></li></ul></li> <li><em>static</em> <ul><li><a href="#module_processors.Processor.from_pretrained"><code>.from_pretrained(pretrained_model_name_or_path, options)</code></a> ⇒ <code>Promise.<Processor></code></li></ul></li></ul></li></ul></li> <li><em>inner</em> <ul><li><a href="#module_processors..PreTrainedTokenizer"><code>~PreTrainedTokenizer</code></a> : <code>Object</code></li></ul></li></ul></li></ul> <hr> <a id="module_processors.Processor" class="group"></a> <h2 class="relative group"><a id="processorsprocessor" 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="#processorsprocessor"><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>processors.Processor</span></h2> <p data-svelte-h="svelte-o9f953">Represents a Processor that extracts features from an input.</p> <p data-svelte-h="svelte-wmyz1o"><strong>Kind</strong>: static class of <a href="#module_processors"><code>processors</code></a></p> <ul data-svelte-h="svelte-1ql1vqu"><li><a href="#module_processors.Processor">.Processor</a> <ul><li><a href="#new_module_processors.Processor_new"><code>new Processor(config, components, chat_template)</code></a></li> <li><em>instance</em> <ul><li><a href="#module_processors.Processor+image_processor"><code>.image_processor</code></a> ⇒ <code>ImageProcessor</code> | <code>undefined</code></li> <li><a href="#module_processors.Processor+tokenizer"><code>.tokenizer</code></a> ⇒ <code>PreTrainedTokenizer</code> | <code>undefined</code></li> <li><a href="#module_processors.Processor+feature_extractor"><code>.feature_extractor</code></a> ⇒ <a href="#FeatureExtractor"><code>FeatureExtractor</code></a> | <code>undefined</code></li> <li><a href="#module_processors.Processor+apply_chat_template"><code>.apply_chat_template(messages, options)</code></a> ⇒ <code>ReturnType.<PreTrainedTokenizer></code></li> <li><a href="#module_processors.Processor+batch_decode"><code>.batch_decode(...args)</code></a> ⇒ <code>ReturnType.<PreTrainedTokenizer></code></li> <li><a href="#module_processors.Processor+decode"><code>.decode(...args)</code></a> ⇒ <code>ReturnType.<PreTrainedTokenizer></code></li> <li><a href="#module_processors.Processor+_call"><code>._call(input, ...args)</code></a> ⇒ <code>Promise.<any></code></li></ul></li> <li><em>static</em> <ul><li><a href="#module_processors.Processor.from_pretrained"><code>.from_pretrained(pretrained_model_name_or_path, options)</code></a> ⇒ <code>Promise.<Processor></code></li></ul></li></ul></li></ul> <hr> <a id="new_module_processors.Processor_new" class="group"></a> <h3 class="relative group"><a id="new-processorconfig-components-chattemplate" 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="#new-processorconfig-components-chattemplate"><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>new Processor(config, components, chat_template)</span></h3> <p data-svelte-h="svelte-rj7jmq">Creates a new Processor with the given components</p> <table data-svelte-h="svelte-vcpbmb"><thead><tr><th>Param</th><th>Type</th></tr></thead> <tbody><tr><td>config</td><td><code>Object</code></td> </tr><tr><td>components</td><td><code>Record.<string, Object></code></td> </tr><tr><td>chat_template</td><td><code>string</code></td></tr></tbody></table> <hr> <a id="module_processors.Processor+image_processor" class="group"></a> <h3 class="relative group"><a id="processorimageprocessor--imageprocessor--undefined" 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="#processorimageprocessor--imageprocessor--undefined"><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>processor.image_processor ⇒ ImageProcessor | undefined</span></h3> <p data-svelte-h="svelte-9ou6oh"><strong>Kind</strong>: instance property of <a href="#module_processors.Processor"><code>Processor</code></a><br> <strong>Returns</strong>: <code>ImageProcessor</code> | <code>undefined</code> - The image processor of the processor, if it exists.</p> <hr> <a id="module_processors.Processor+tokenizer" class="group"></a> <h3 class="relative group"><a id="processortokenizer--pretrainedtokenizer--undefined" 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="#processortokenizer--pretrainedtokenizer--undefined"><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>processor.tokenizer ⇒ PreTrainedTokenizer | undefined</span></h3> <p data-svelte-h="svelte-ao82kh"><strong>Kind</strong>: instance property of <a href="#module_processors.Processor"><code>Processor</code></a><br> <strong>Returns</strong>: <code>PreTrainedTokenizer</code> | <code>undefined</code> - The tokenizer of the processor, if it exists.</p> <hr> <a id="module_processors.Processor+feature_extractor" class="group"></a> <h3 class="relative group"><a id="processorfeatureextractor--featureextractor--undefined" 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="#processorfeatureextractor--featureextractor--undefined"><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>processor.feature_extractor ⇒ FeatureExtractor | undefined</span></h3> <p data-svelte-h="svelte-t8ycq7"><strong>Kind</strong>: instance property of <a href="#module_processors.Processor"><code>Processor</code></a><br> <strong>Returns</strong>: <a href="#FeatureExtractor"><code>FeatureExtractor</code></a> | <code>undefined</code> - The feature extractor of the processor, if it exists.</p> <hr> <a id="module_processors.Processor+apply_chat_template" class="group"></a> <h3 class="relative group"><a id="processorapplychattemplatemessages-options--returntype--pretrainedtokenizer-" 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="#processorapplychattemplatemessages-options--returntype--pretrainedtokenizer-"><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>processor.apply_chat_template(messages, options) ⇒ ReturnType. < PreTrainedTokenizer ></span></h3> <p data-svelte-h="svelte-jg083b"><strong>Kind</strong>: instance method of <a href="#module_processors.Processor"><code>Processor</code></a></p> <table data-svelte-h="svelte-q0loxa"><thead><tr><th>Param</th><th>Type</th></tr></thead> <tbody><tr><td>messages</td><td><code>Parameters</code></td> </tr><tr><td>options</td><td><code>Parameters</code></td></tr></tbody></table> <hr> <a id="module_processors.Processor+batch_decode" class="group"></a> <h3 class="relative group"><a id="processorbatchdecodeargs--returntype--pretrainedtokenizer-" 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="#processorbatchdecodeargs--returntype--pretrainedtokenizer-"><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>processor.batch_decode(...args) ⇒ ReturnType. < PreTrainedTokenizer ></span></h3> <p data-svelte-h="svelte-jg083b"><strong>Kind</strong>: instance method of <a href="#module_processors.Processor"><code>Processor</code></a></p> <table data-svelte-h="svelte-1gqg4mz"><thead><tr><th>Param</th><th>Type</th></tr></thead> <tbody><tr><td>...args</td><td><code>Parameters.<PreTrainedTokenizer></code></td></tr></tbody></table> <hr> <a id="module_processors.Processor+decode" class="group"></a> <h3 class="relative group"><a id="processordecodeargs--returntype--pretrainedtokenizer-" 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="#processordecodeargs--returntype--pretrainedtokenizer-"><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>processor.decode(...args) ⇒ ReturnType. < PreTrainedTokenizer ></span></h3> <p data-svelte-h="svelte-jg083b"><strong>Kind</strong>: instance method of <a href="#module_processors.Processor"><code>Processor</code></a></p> <table data-svelte-h="svelte-1gqg4mz"><thead><tr><th>Param</th><th>Type</th></tr></thead> <tbody><tr><td>...args</td><td><code>Parameters.<PreTrainedTokenizer></code></td></tr></tbody></table> <hr> <a id="module_processors.Processor+_call" class="group"></a> <h3 class="relative group"><a id="processorcallinput-args--promise--any-" 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="#processorcallinput-args--promise--any-"><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>processor._call(input, ...args) ⇒ Promise. < any ></span></h3> <p data-svelte-h="svelte-zbbm3j">Calls the feature_extractor function with the given input.</p> <p data-svelte-h="svelte-kflsb2"><strong>Kind</strong>: instance method of <a href="#module_processors.Processor"><code>Processor</code></a><br> <strong>Returns</strong>: <code>Promise.<any></code> - A Promise that resolves with the extracted features.</p> <table data-svelte-h="svelte-pm1u9z"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>input</td><td><code>any</code></td><td><p>The input to extract features from.</p></td> </tr><tr><td>...args</td><td><code>any</code></td><td><p>Additional arguments.</p></td></tr></tbody></table> <hr> <a id="module_processors.Processor.from_pretrained" class="group"></a> <h3 class="relative group"><a id="processorfrompretrainedpretrainedmodelnameorpath-options--promise--processor-" 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="#processorfrompretrainedpretrainedmodelnameorpath-options--promise--processor-"><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>Processor.from_pretrained(pretrained_model_name_or_path, options) ⇒ Promise. < Processor ></span></h3> <p data-svelte-h="svelte-jwfdp9">Instantiate one of the processor classes of the library from a pretrained model.</p> <p data-svelte-h="svelte-1l7cuz8">The processor class to instantiate is selected based on the <code>image_processor_type</code> (or <code>feature_extractor_type</code>; legacy) | |
| property of the config object (either passed as an argument or loaded from <code>pretrained_model_name_or_path</code> if possible)</p> <p data-svelte-h="svelte-vp40qx"><strong>Kind</strong>: static method of <a href="#module_processors.Processor"><code>Processor</code></a><br> <strong>Returns</strong>: <code>Promise.<Processor></code> - A new instance of the Processor class.</p> <table data-svelte-h="svelte-f3l1ud"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>pretrained_model_name_or_path</td><td><code>string</code></td><td><p>The name or path of the pretrained model. Can be either:</p> <ul><li>A string, the <em>model id</em> of a pretrained processor hosted inside a model repo on huggingface.co. | |
| Valid model ids can be located at the root-level, like <code>bert-base-uncased</code>, or namespaced under a | |
| user or organization name, like <code>dbmdz/bert-base-german-cased</code>.</li> <li>A path to a <em>directory</em> containing processor files, e.g., <code>./my_model_directory/</code>.</li></ul></td> </tr><tr><td>options</td><td><code><a href="#PretrainedProcessorOptions">PretrainedProcessorOptions</a></code></td><td><p>Additional options for loading the processor.</p></td></tr></tbody></table> <hr> <a id="module_processors..PreTrainedTokenizer" class="group"></a> <h2 class="relative group"><a id="processorspretrainedtokenizer--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="#processorspretrainedtokenizer--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>processors~PreTrainedTokenizer : Object</span></h2> <p data-svelte-h="svelte-ivm759">Additional processor-specific properties.</p> <p data-svelte-h="svelte-3xndnt"><strong>Kind</strong>: inner typedef of <a href="#module_processors"><code>processors</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/processors.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, 13], | |
| data, | |
| form: null, | |
| error: null | |
| }); | |
| }); | |
| } | |
| </script> | |
Xet Storage Details
- Size:
- 35.9 kB
- Xet hash:
- 83b76de59ef9676029fdea6df5c35e8fe15a94a3d1eb5103f50ac3b6706b2e4f
·
Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.