Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / transformers.js /pr_1649 /en /api /pipelines.html

HuggingFaceDocBuilder

27 days ago

download

raw

20.6 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"pipelines","local":"pipelines","sections":[{"title":"pipelines.pipeline(task, [model], [options]) ⇒ Promise. < AllTasks >","local":"pipelinespipelinetask-model-options--promise--alltasks-","sections":[{"title":"pipeline~files_loading : FilesLoadingMap","local":"pipelinefilesloading--filesloadingmap","sections":[],"depth":3},{"title":"pipeline~metadata : Array. < {exists: boolean, size: number, contentType: string, fromCache: boolean} >","local":"pipelinemetadata--array--exists-boolean-size-number-contenttype-string-fromcache-boolean-","sections":[],"depth":3}],"depth":2},{"title":"pipelines~AllTasks : string","local":"pipelinesalltasks--string","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/12.5595804a.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":"pipelines","local":"pipelines","sections":[{"title":"pipelines.pipeline(task, [model], [options]) ⇒ Promise. < AllTasks >","local":"pipelinespipelinetask-model-options--promise--alltasks-","sections":[{"title":"pipeline~files_loading : FilesLoadingMap","local":"pipelinefilesloading--filesloadingmap","sections":[],"depth":3},{"title":"pipeline~metadata : Array. < {exists: boolean, size: number, contentType: string, fromCache: boolean} >","local":"pipelinemetadata--array--exists-boolean-size-number-contenttype-string-fromcache-boolean-","sections":[],"depth":3}],"depth":2},{"title":"pipelines~AllTasks : string","local":"pipelinesalltasks--string","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <a id="module_pipelines" 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="pipelines" 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="#pipelines"><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>pipelines</span></h1> <p data-svelte-h="svelte-1inm2t9">Pipelines provide a high-level, easy to use, API for running machine learning models.</p> <p data-svelte-h="svelte-1pjech"><strong>Example:</strong> Instantiate pipeline using the <code>pipeline</code> function.</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> { pipeline } <span class="hljs-keyword">from</span> <span class="hljs-string">'@huggingface/transformers'</span>;

	<span class="hljs-keyword">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'sentiment-analysis'</span>);
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(<span class="hljs-string">'I love transformers!'</span>);
	<span class="hljs-comment">// [{'label': 'POSITIVE', 'score': 0.999817686}]</span><!-- HTML_TAG_END --></pre></div> <ul data-svelte-h="svelte-10revsx"><li><a href="#module_pipelines">pipelines</a> <ul><li><em>static</em> <ul><li><a href="#module_pipelines.pipeline"><code>.pipeline(task, [model], [options])</code></a> ⇒ <code>Promise.<AllTasks></code> <ul><li><a href="#module_pipelines.pipeline..files_loading"><code>~files_loading</code></a> : <code>FilesLoadingMap</code></li> <li><a href="#module_pipelines.pipeline..metadata"><code>~metadata</code></a> : <code>Array.<{exists: boolean, size: number, contentType: string, fromCache: boolean}></code></li></ul></li></ul></li> <li><em>inner</em> <ul><li><a href="#module_pipelines..AllTasks"><code>~AllTasks</code></a> : <code>string</code></li></ul></li></ul></li></ul> <hr> <a id="module_pipelines.pipeline" class="group"></a> <h2 class="relative group"><a id="pipelinespipelinetask-model-options--promise--alltasks-" 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="#pipelinespipelinetask-model-options--promise--alltasks-"><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>pipelines.pipeline(task, [model], [options]) ⇒ Promise. < AllTasks ></span></h2> <p data-svelte-h="svelte-1drpefn">Utility factory method to build a <code>Pipeline</code> object.</p> <p data-svelte-h="svelte-37wyo8"><strong>Kind</strong>: static method of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<AllTasks></code> - A Pipeline object for the specified task.<br> <strong>Throws</strong>:</p> <ul data-svelte-h="svelte-1qayj4p"><li><code>Error</code> If an unsupported pipeline is requested.</li></ul> <table data-svelte-h="svelte-1whyvks"><thead><tr><th>Param</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>task</td><td><code>T</code></td><td></td><td><p>The task defining which pipeline will be returned. Currently accepted tasks are:</p> <ul><li><code>"audio-classification"</code>: will return a <code>AudioClassificationPipeline</code>.</li> <li><code>"automatic-speech-recognition"</code>: will return a <code>AutomaticSpeechRecognitionPipeline</code>.</li> <li><code>"background-removal"</code>: will return a <code>BackgroundRemovalPipeline</code>.</li> <li><code>"depth-estimation"</code>: will return a <code>DepthEstimationPipeline</code>.</li> <li><code>"document-question-answering"</code>: will return a <code>DocumentQuestionAnsweringPipeline</code>.</li> <li><code>"feature-extraction"</code>: will return a <code>FeatureExtractionPipeline</code>.</li> <li><code>"fill-mask"</code>: will return a <code>FillMaskPipeline</code>.</li> <li><code>"image-classification"</code>: will return a <code>ImageClassificationPipeline</code>.</li> <li><code>"image-segmentation"</code>: will return a <code>ImageSegmentationPipeline</code>.</li> <li><code>"image-to-text"</code>: will return a <code>ImageToTextPipeline</code>.</li> <li><code>"object-detection"</code>: will return a <code>ObjectDetectionPipeline</code>.</li> <li><code>"question-answering"</code>: will return a <code>QuestionAnsweringPipeline</code>.</li> <li><code>"summarization"</code>: will return a <code>SummarizationPipeline</code>.</li> <li><code>"text2text-generation"</code>: will return a <code>Text2TextGenerationPipeline</code>.</li> <li><code>"text-classification"</code> (alias "sentiment-analysis" available): will return a <code>TextClassificationPipeline</code>.</li> <li><code>"text-generation"</code>: will return a <code>TextGenerationPipeline</code>.</li> <li><code>"token-classification"</code> (alias "ner" available): will return a <code>TokenClassificationPipeline</code>.</li> <li><code>"translation"</code>: will return a <code>TranslationPipeline</code>.</li> <li><code>"translation_xx_to_yy"</code>: will return a <code>TranslationPipeline</code>.</li> <li><code>"zero-shot-classification"</code>: will return a <code>ZeroShotClassificationPipeline</code>.</li> <li><code>"zero-shot-audio-classification"</code>: will return a <code>ZeroShotAudioClassificationPipeline</code>.</li> <li><code>"zero-shot-image-classification"</code>: will return a <code>ZeroShotImageClassificationPipeline</code>.</li> <li><code>"zero-shot-object-detection"</code>: will return a <code>ZeroShotObjectDetectionPipeline</code>.</li></ul></td> </tr><tr><td>[model]</td><td><code>string</code></td><td><code>null</code></td><td><p>The name of the pre-trained model to use. If not specified, the default model for the task will be used.</p></td> </tr><tr><td>[options]</td><td><code>PretrainedModelOptions</code></td><td></td><td><p>Optional parameters for the pipeline.</p></td></tr></tbody></table> <ul data-svelte-h="svelte-9ov4qi"><li><a href="#module_pipelines.pipeline"><code>.pipeline(task, [model], [options])</code></a> ⇒ <code>Promise.<AllTasks></code> <ul><li><a href="#module_pipelines.pipeline..files_loading"><code>~files_loading</code></a> : <code>FilesLoadingMap</code></li> <li><a href="#module_pipelines.pipeline..metadata"><code>~metadata</code></a> : <code>Array.<{exists: boolean, size: number, contentType: string, fromCache: boolean}></code></li></ul></li></ul> <hr> <a id="module_pipelines.pipeline..files_loading" class="group"></a> <h3 class="relative group"><a id="pipelinefilesloading--filesloadingmap" 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="#pipelinefilesloading--filesloadingmap"><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>pipeline~files_loading : FilesLoadingMap</span></h3> <p data-svelte-h="svelte-115ghui"><strong>Kind</strong>: inner property of <a href="#module_pipelines.pipeline"><code>pipeline</code></a></p> <hr> <a id="module_pipelines.pipeline..metadata" class="group"></a> <h3 class="relative group"><a id="pipelinemetadata--array--exists-boolean-size-number-contenttype-string-fromcache-boolean-" 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="#pipelinemetadata--array--exists-boolean-size-number-contenttype-string-fromcache-boolean-"><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>pipeline~metadata : Array. < {exists: boolean, size: number, contentType: string, fromCache: boolean} ></span></h3> <p data-svelte-h="svelte-mhgl2z"><strong>Kind</strong>: inner constant of <a href="#module_pipelines.pipeline"><code>pipeline</code></a></p> <hr> <a id="module_pipelines..AllTasks" class="group"></a> <h2 class="relative group"><a id="pipelinesalltasks--string" 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="#pipelinesalltasks--string"><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>pipelines~AllTasks : string</span></h2> <p data-svelte-h="svelte-1r368bj">All possible pipeline types.</p> <p data-svelte-h="svelte-1axcw5l"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</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/pipelines.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, 12],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 20.6 kB
Xet hash:: f450c0eaa355528bc92f1c23bb8ec01d8b8aab8c1816ebfecaf8a1fb3858f572

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.