Buckets:

hf-doc-build
/

doc-dev

Files

xet

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

rtrm

29 days ago

download

raw

425 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"pipelines","local":"pipelines","sections":[{"title":"pipelines.Pipeline","local":"pipelinespipeline","sections":[{"title":"new Pipeline(options)","local":"new-pipelineoptions","sections":[],"depth":3},{"title":"pipeline.dispose() : <code> DisposeType </code>","local":"pipelinedispose--code-disposetype-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TextClassificationPipeline","local":"pipelinestextclassificationpipeline","sections":[{"title":"new TextClassificationPipeline(options)","local":"new-textclassificationpipelineoptions","sections":[],"depth":3},{"title":"textClassificationPipeline._call() : <code> TextClassificationPipelineCallback </code>","local":"textclassificationpipelinecall--code-textclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TokenClassificationPipeline","local":"pipelinestokenclassificationpipeline","sections":[{"title":"new TokenClassificationPipeline(options)","local":"new-tokenclassificationpipelineoptions","sections":[],"depth":3},{"title":"tokenClassificationPipeline._call() : <code> TokenClassificationPipelineCallback </code>","local":"tokenclassificationpipelinecall--code-tokenclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.QuestionAnsweringPipeline","local":"pipelinesquestionansweringpipeline","sections":[{"title":"new QuestionAnsweringPipeline(options)","local":"new-questionansweringpipelineoptions","sections":[],"depth":3},{"title":"questionAnsweringPipeline._call() : <code> QuestionAnsweringPipelineCallback </code>","local":"questionansweringpipelinecall--code-questionansweringpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.FillMaskPipeline","local":"pipelinesfillmaskpipeline","sections":[{"title":"new FillMaskPipeline(options)","local":"new-fillmaskpipelineoptions","sections":[],"depth":3},{"title":"fillMaskPipeline._call() : <code> FillMaskPipelineCallback </code>","local":"fillmaskpipelinecall--code-fillmaskpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.Text2TextGenerationPipeline","local":"pipelinestext2textgenerationpipeline","sections":[{"title":"new Text2TextGenerationPipeline(options)","local":"new-text2textgenerationpipelineoptions","sections":[],"depth":3},{"title":"text2TextGenerationPipeline._key : <code> ’ generated_text ’ </code>","local":"text2textgenerationpipelinekey--code--generatedtext--code","sections":[],"depth":3},{"title":"text2TextGenerationPipeline._call() : <code> Text2TextGenerationPipelineCallback </code>","local":"text2textgenerationpipelinecall--code-text2textgenerationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.SummarizationPipeline","local":"pipelinessummarizationpipeline","sections":[{"title":"new SummarizationPipeline(options)","local":"new-summarizationpipelineoptions","sections":[],"depth":3},{"title":"summarizationPipeline._key : <code> ’ summary_text ’ </code>","local":"summarizationpipelinekey--code--summarytext--code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TranslationPipeline","local":"pipelinestranslationpipeline","sections":[{"title":"new TranslationPipeline(options)","local":"new-translationpipelineoptions","sections":[],"depth":3},{"title":"translationPipeline._key : <code> ’ translation_text ’ </code>","local":"translationpipelinekey--code--translationtext--code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TextGenerationPipeline","local":"pipelinestextgenerationpipeline","sections":[{"title":"new TextGenerationPipeline(options)","local":"new-textgenerationpipelineoptions","sections":[],"depth":3},{"title":"textGenerationPipeline._call() : <code> TextGenerationPipelineCallback </code>","local":"textgenerationpipelinecall--code-textgenerationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ZeroShotClassificationPipeline","local":"pipelineszeroshotclassificationpipeline","sections":[{"title":"new ZeroShotClassificationPipeline(options)","local":"new-zeroshotclassificationpipelineoptions","sections":[],"depth":3},{"title":"zeroShotClassificationPipeline.model : <code> any </code>","local":"zeroshotclassificationpipelinemodel--code-any-code","sections":[],"depth":3},{"title":"zeroShotClassificationPipeline._call() : <code> ZeroShotClassificationPipelineCallback </code>","local":"zeroshotclassificationpipelinecall--code-zeroshotclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.FeatureExtractionPipeline","local":"pipelinesfeatureextractionpipeline","sections":[{"title":"new FeatureExtractionPipeline(options)","local":"new-featureextractionpipelineoptions","sections":[],"depth":3},{"title":"featureExtractionPipeline._call() : <code> FeatureExtractionPipelineCallback </code>","local":"featureextractionpipelinecall--code-featureextractionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageFeatureExtractionPipeline","local":"pipelinesimagefeatureextractionpipeline","sections":[{"title":"new ImageFeatureExtractionPipeline(options)","local":"new-imagefeatureextractionpipelineoptions","sections":[],"depth":3},{"title":"imageFeatureExtractionPipeline._call() : <code> ImageFeatureExtractionPipelineCallback </code>","local":"imagefeatureextractionpipelinecall--code-imagefeatureextractionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.AudioClassificationPipeline","local":"pipelinesaudioclassificationpipeline","sections":[{"title":"new AudioClassificationPipeline(options)","local":"new-audioclassificationpipelineoptions","sections":[],"depth":3},{"title":"audioClassificationPipeline._call() : <code> AudioClassificationPipelineCallback </code>","local":"audioclassificationpipelinecall--code-audioclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ZeroShotAudioClassificationPipeline","local":"pipelineszeroshotaudioclassificationpipeline","sections":[{"title":"new ZeroShotAudioClassificationPipeline(options)","local":"new-zeroshotaudioclassificationpipelineoptions","sections":[],"depth":3},{"title":"zeroShotAudioClassificationPipeline._call() : <code> ZeroShotAudioClassificationPipelineCallback </code>","local":"zeroshotaudioclassificationpipelinecall--code-zeroshotaudioclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.AutomaticSpeechRecognitionPipeline","local":"pipelinesautomaticspeechrecognitionpipeline","sections":[{"title":"new AutomaticSpeechRecognitionPipeline(options)","local":"new-automaticspeechrecognitionpipelineoptions","sections":[],"depth":3},{"title":"automaticSpeechRecognitionPipeline._call() : <code> AutomaticSpeechRecognitionPipelineCallback </code>","local":"automaticspeechrecognitionpipelinecall--code-automaticspeechrecognitionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageToTextPipeline","local":"pipelinesimagetotextpipeline","sections":[{"title":"new ImageToTextPipeline(options)","local":"new-imagetotextpipelineoptions","sections":[],"depth":3},{"title":"imageToTextPipeline._call() : <code> ImageToTextPipelineCallback </code>","local":"imagetotextpipelinecall--code-imagetotextpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageClassificationPipeline","local":"pipelinesimageclassificationpipeline","sections":[{"title":"new ImageClassificationPipeline(options)","local":"new-imageclassificationpipelineoptions","sections":[],"depth":3},{"title":"imageClassificationPipeline._call() : <code> ImageClassificationPipelineCallback </code>","local":"imageclassificationpipelinecall--code-imageclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageSegmentationPipeline","local":"pipelinesimagesegmentationpipeline","sections":[{"title":"new ImageSegmentationPipeline(options)","local":"new-imagesegmentationpipelineoptions","sections":[],"depth":3},{"title":"imageSegmentationPipeline._call() : <code> ImageSegmentationPipelineCallback </code>","local":"imagesegmentationpipelinecall--code-imagesegmentationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ZeroShotImageClassificationPipeline","local":"pipelineszeroshotimageclassificationpipeline","sections":[{"title":"new ZeroShotImageClassificationPipeline(options)","local":"new-zeroshotimageclassificationpipelineoptions","sections":[],"depth":3},{"title":"zeroShotImageClassificationPipeline._call() : <code> ZeroShotImageClassificationPipelineCallback </code>","local":"zeroshotimageclassificationpipelinecall--code-zeroshotimageclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ObjectDetectionPipeline","local":"pipelinesobjectdetectionpipeline","sections":[{"title":"new ObjectDetectionPipeline(options)","local":"new-objectdetectionpipelineoptions","sections":[],"depth":3},{"title":"objectDetectionPipeline._call() : <code> ObjectDetectionPipelineCallback </code>","local":"objectdetectionpipelinecall--code-objectdetectionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ZeroShotObjectDetectionPipeline","local":"pipelineszeroshotobjectdetectionpipeline","sections":[{"title":"new ZeroShotObjectDetectionPipeline(options)","local":"new-zeroshotobjectdetectionpipelineoptions","sections":[],"depth":3},{"title":"zeroShotObjectDetectionPipeline._call() : <code> ZeroShotObjectDetectionPipelineCallback </code>","local":"zeroshotobjectdetectionpipelinecall--code-zeroshotobjectdetectionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.DocumentQuestionAnsweringPipeline","local":"pipelinesdocumentquestionansweringpipeline","sections":[{"title":"new DocumentQuestionAnsweringPipeline(options)","local":"new-documentquestionansweringpipelineoptions","sections":[],"depth":3},{"title":"documentQuestionAnsweringPipeline._call() : <code> DocumentQuestionAnsweringPipelineCallback </code>","local":"documentquestionansweringpipelinecall--code-documentquestionansweringpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TextToAudioPipeline","local":"pipelinestexttoaudiopipeline","sections":[{"title":"new TextToAudioPipeline(options)","local":"new-texttoaudiopipelineoptions","sections":[],"depth":3},{"title":"textToAudioPipeline._call() : <code> TextToAudioPipelineCallback </code>","local":"texttoaudiopipelinecall--code-texttoaudiopipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageToImagePipeline","local":"pipelinesimagetoimagepipeline","sections":[{"title":"new ImageToImagePipeline(options)","local":"new-imagetoimagepipelineoptions","sections":[],"depth":3},{"title":"imageToImagePipeline._call() : <code> ImageToImagePipelineCallback </code>","local":"imagetoimagepipelinecall--code-imagetoimagepipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.DepthEstimationPipeline","local":"pipelinesdepthestimationpipeline","sections":[{"title":"new DepthEstimationPipeline(options)","local":"new-depthestimationpipelineoptions","sections":[],"depth":3},{"title":"depthEstimationPipeline._call() : <code> DepthEstimationPipelineCallback </code>","local":"depthestimationpipelinecall--code-depthestimationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.pipeline(task, [model], [options]) ⇒ <code> * </code>","local":"pipelinespipelinetask-model-options--code--code","sections":[],"depth":2},{"title":"pipelines~ImagePipelineInputs : <code> string </code> \| <code> RawImage </code> \| <code> URL </code>","local":"pipelinesimagepipelineinputs--code-string-code--code-rawimage-code--code-url-code","sections":[],"depth":2},{"title":"pipelines~AudioPipelineInputs : <code> string </code> \| <code> URL </code> \| <code> Float32Array </code> \| <code> Float64Array </code>","local":"pipelinesaudiopipelineinputs--code-string-code--code-url-code--code-float32array-code--code-float64array-code","sections":[],"depth":2},{"title":"pipelines~BoundingBox : <code> Object </code>","local":"pipelinesboundingbox--code-object-code","sections":[],"depth":2},{"title":"pipelines~Disposable ⇒ <code> Promise. < void > </code>","local":"pipelinesdisposable--code-promise--void--code","sections":[],"depth":2},{"title":"pipelines~TextPipelineConstructorArgs : <code> Object </code>","local":"pipelinestextpipelineconstructorargs--code-object-code","sections":[],"depth":2},{"title":"pipelines~ImagePipelineConstructorArgs : <code> Object </code>","local":"pipelinesimagepipelineconstructorargs--code-object-code","sections":[],"depth":2},{"title":"pipelines~TextImagePipelineConstructorArgs : <code> Object </code>","local":"pipelinestextimagepipelineconstructorargs--code-object-code","sections":[],"depth":2},{"title":"pipelines~TextClassificationPipelineType ⇒ <code> Promise. < (TextClassificationOutput\|Array < TextClassificationOutput > ) > </code>","local":"pipelinestextclassificationpipelinetype--code-promise--textclassificationoutputarray--textclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~TokenClassificationPipelineType ⇒ <code> Promise. < (TokenClassificationOutput\|Array < TokenClassificationOutput > ) > </code>","local":"pipelinestokenclassificationpipelinetype--code-promise--tokenclassificationoutputarray--tokenclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~QuestionAnsweringPipelineType ⇒ <code> Promise. < (QuestionAnsweringOutput\|Array < QuestionAnsweringOutput > ) > </code>","local":"pipelinesquestionansweringpipelinetype--code-promise--questionansweringoutputarray--questionansweringoutput----code","sections":[],"depth":2},{"title":"pipelines~FillMaskPipelineType ⇒ <code> Promise. < (FillMaskOutput\|Array < FillMaskOutput > ) > </code>","local":"pipelinesfillmaskpipelinetype--code-promise--fillmaskoutputarray--fillmaskoutput----code","sections":[],"depth":2},{"title":"pipelines~Text2TextGenerationPipelineType ⇒ <code> Promise. < (Text2TextGenerationOutput\|Array < Text2TextGenerationOutput > ) > </code>","local":"pipelinestext2textgenerationpipelinetype--code-promise--text2textgenerationoutputarray--text2textgenerationoutput----code","sections":[],"depth":2},{"title":"pipelines~SummarizationPipelineType ⇒ <code> Promise. < (SummarizationOutput\|Array < SummarizationOutput > ) > </code>","local":"pipelinessummarizationpipelinetype--code-promise--summarizationoutputarray--summarizationoutput----code","sections":[],"depth":2},{"title":"pipelines~TranslationPipelineType ⇒ <code> Promise. < (TranslationOutput\|Array < TranslationOutput > ) > </code>","local":"pipelinestranslationpipelinetype--code-promise--translationoutputarray--translationoutput----code","sections":[],"depth":2},{"title":"pipelines~TextGenerationPipelineType ⇒ <code> Promise. < (TextGenerationOutput\|Array < TextGenerationOutput > ) > </code>","local":"pipelinestextgenerationpipelinetype--code-promise--textgenerationoutputarray--textgenerationoutput----code","sections":[],"depth":2},{"title":"pipelines~ZeroShotClassificationPipelineType ⇒ <code> Promise. < (ZeroShotClassificationOutput\|Array < ZeroShotClassificationOutput > ) > </code>","local":"pipelineszeroshotclassificationpipelinetype--code-promise--zeroshotclassificationoutputarray--zeroshotclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~FeatureExtractionPipelineType ⇒ <code> Promise. < Tensor > </code>","local":"pipelinesfeatureextractionpipelinetype--code-promise--tensor--code","sections":[],"depth":2},{"title":"pipelines~ImageFeatureExtractionPipelineType ⇒ <code> Promise. < Tensor > </code>","local":"pipelinesimagefeatureextractionpipelinetype--code-promise--tensor--code","sections":[],"depth":2},{"title":"pipelines~AudioClassificationPipelineType ⇒ <code> Promise. < (AudioClassificationOutput\|Array < AudioClassificationOutput > ) > </code>","local":"pipelinesaudioclassificationpipelinetype--code-promise--audioclassificationoutputarray--audioclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~ZeroShotAudioClassificationPipelineType ⇒ <code> Promise. < (Array < ZeroShotAudioClassificationOutput > \|Array < Array < ZeroShotAudioClassificationOutput > > ) > </code>","local":"pipelineszeroshotaudioclassificationpipelinetype--code-promise--array--zeroshotaudioclassificationoutput--array--array--zeroshotaudioclassificationoutput-----code","sections":[],"depth":2},{"title":"pipelines~Chunk : <code> Object </code>","local":"pipelineschunk--code-object-code","sections":[],"depth":2},{"title":"pipelines~AutomaticSpeechRecognitionPipelineType ⇒ <code> Promise. < (AutomaticSpeechRecognitionOutput\|Array < AutomaticSpeechRecognitionOutput > ) > </code>","local":"pipelinesautomaticspeechrecognitionpipelinetype--code-promise--automaticspeechrecognitionoutputarray--automaticspeechrecognitionoutput----code","sections":[],"depth":2},{"title":"pipelines~ImageToTextPipelineType ⇒ <code> Promise. < (ImageToTextOutput\|Array < ImageToTextOutput > ) > </code>","local":"pipelinesimagetotextpipelinetype--code-promise--imagetotextoutputarray--imagetotextoutput----code","sections":[],"depth":2},{"title":"pipelines~ImageClassificationPipelineType ⇒ <code> Promise. < (ImageClassificationOutput\|Array < ImageClassificationOutput > ) > </code>","local":"pipelinesimageclassificationpipelinetype--code-promise--imageclassificationoutputarray--imageclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~ImageSegmentationPipelineType ⇒ <code> Promise. < Array < ImageSegmentationPipelineOutput > > </code>","local":"pipelinesimagesegmentationpipelinetype--code-promise--array--imagesegmentationpipelineoutput---code","sections":[],"depth":2},{"title":"pipelines~ZeroShotImageClassificationPipelineType ⇒ <code> Promise. < (Array < ZeroShotImageClassificationOutput > \|Array < Array < ZeroShotImageClassificationOutput > > ) > </code>","local":"pipelineszeroshotimageclassificationpipelinetype--code-promise--array--zeroshotimageclassificationoutput--array--array--zeroshotimageclassificationoutput-----code","sections":[],"depth":2},{"title":"pipelines~ObjectDetectionPipelineType ⇒ <code> Promise. < (ObjectDetectionPipelineOutput\|Array < ObjectDetectionPipelineOutput > ) > </code>","local":"pipelinesobjectdetectionpipelinetype--code-promise--objectdetectionpipelineoutputarray--objectdetectionpipelineoutput----code","sections":[],"depth":2},{"title":"pipelines~ZeroShotObjectDetectionPipelineType ⇒ <code> Promise. < (Array < ZeroShotObjectDetectionOutput > \|Array < Array < ZeroShotObjectDetectionOutput > > ) > </code>","local":"pipelineszeroshotobjectdetectionpipelinetype--code-promise--array--zeroshotobjectdetectionoutput--array--array--zeroshotobjectdetectionoutput-----code","sections":[],"depth":2},{"title":"pipelines~DocumentQuestionAnsweringPipelineType ⇒ <code> Promise. < (DocumentQuestionAnsweringOutput\|Array < DocumentQuestionAnsweringOutput > ) > </code>","local":"pipelinesdocumentquestionansweringpipelinetype--code-promise--documentquestionansweringoutputarray--documentquestionansweringoutput----code","sections":[],"depth":2},{"title":"pipelines~TextToAudioPipelineConstructorArgs : <code> Object </code>","local":"pipelinestexttoaudiopipelineconstructorargs--code-object-code","sections":[],"depth":2},{"title":"pipelines~TextToAudioPipelineType ⇒ <code> Promise. < TextToAudioOutput > </code>","local":"pipelinestexttoaudiopipelinetype--code-promise--texttoaudiooutput--code","sections":[],"depth":2},{"title":"pipelines~ImageToImagePipelineType ⇒ <code> Promise. < (RawImage\|Array < RawImage > ) > </code>","local":"pipelinesimagetoimagepipelinetype--code-promise--rawimagearray--rawimage----code","sections":[],"depth":2},{"title":"pipelines~DepthEstimationPipelineType ⇒ <code> Promise. < (DepthEstimationPipelineOutput\|Array < DepthEstimationPipelineOutput > ) > </code>","local":"pipelinesdepthestimationpipelinetype--code-promise--depthestimationpipelineoutputarray--depthestimationpipelineoutput----code","sections":[],"depth":2},{"title":"pipelines~AllTasks : <code> * </code>","local":"pipelinesalltasks--code--code","sections":[],"depth":2}],"depth":1}">
	<link href="/docs/transformers.js/pr_1113/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/entry/start.88a6e140.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/chunks/scheduler.0219f8bd.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/chunks/singletons.c59c6d8d.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/chunks/paths.8e090985.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/entry/app.0003020d.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/chunks/index.f61edf3b.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/nodes/0.25c65ab2.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/nodes/12.5fe58804.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/chunks/CodeBlock.38e566ae.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1113/en/_app/immutable/chunks/EditOnGithub.48fa589f.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"pipelines","local":"pipelines","sections":[{"title":"pipelines.Pipeline","local":"pipelinespipeline","sections":[{"title":"new Pipeline(options)","local":"new-pipelineoptions","sections":[],"depth":3},{"title":"pipeline.dispose() : <code> DisposeType </code>","local":"pipelinedispose--code-disposetype-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TextClassificationPipeline","local":"pipelinestextclassificationpipeline","sections":[{"title":"new TextClassificationPipeline(options)","local":"new-textclassificationpipelineoptions","sections":[],"depth":3},{"title":"textClassificationPipeline._call() : <code> TextClassificationPipelineCallback </code>","local":"textclassificationpipelinecall--code-textclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TokenClassificationPipeline","local":"pipelinestokenclassificationpipeline","sections":[{"title":"new TokenClassificationPipeline(options)","local":"new-tokenclassificationpipelineoptions","sections":[],"depth":3},{"title":"tokenClassificationPipeline._call() : <code> TokenClassificationPipelineCallback </code>","local":"tokenclassificationpipelinecall--code-tokenclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.QuestionAnsweringPipeline","local":"pipelinesquestionansweringpipeline","sections":[{"title":"new QuestionAnsweringPipeline(options)","local":"new-questionansweringpipelineoptions","sections":[],"depth":3},{"title":"questionAnsweringPipeline._call() : <code> QuestionAnsweringPipelineCallback </code>","local":"questionansweringpipelinecall--code-questionansweringpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.FillMaskPipeline","local":"pipelinesfillmaskpipeline","sections":[{"title":"new FillMaskPipeline(options)","local":"new-fillmaskpipelineoptions","sections":[],"depth":3},{"title":"fillMaskPipeline._call() : <code> FillMaskPipelineCallback </code>","local":"fillmaskpipelinecall--code-fillmaskpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.Text2TextGenerationPipeline","local":"pipelinestext2textgenerationpipeline","sections":[{"title":"new Text2TextGenerationPipeline(options)","local":"new-text2textgenerationpipelineoptions","sections":[],"depth":3},{"title":"text2TextGenerationPipeline._key : <code> ’ generated_text ’ </code>","local":"text2textgenerationpipelinekey--code--generatedtext--code","sections":[],"depth":3},{"title":"text2TextGenerationPipeline._call() : <code> Text2TextGenerationPipelineCallback </code>","local":"text2textgenerationpipelinecall--code-text2textgenerationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.SummarizationPipeline","local":"pipelinessummarizationpipeline","sections":[{"title":"new SummarizationPipeline(options)","local":"new-summarizationpipelineoptions","sections":[],"depth":3},{"title":"summarizationPipeline._key : <code> ’ summary_text ’ </code>","local":"summarizationpipelinekey--code--summarytext--code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TranslationPipeline","local":"pipelinestranslationpipeline","sections":[{"title":"new TranslationPipeline(options)","local":"new-translationpipelineoptions","sections":[],"depth":3},{"title":"translationPipeline._key : <code> ’ translation_text ’ </code>","local":"translationpipelinekey--code--translationtext--code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TextGenerationPipeline","local":"pipelinestextgenerationpipeline","sections":[{"title":"new TextGenerationPipeline(options)","local":"new-textgenerationpipelineoptions","sections":[],"depth":3},{"title":"textGenerationPipeline._call() : <code> TextGenerationPipelineCallback </code>","local":"textgenerationpipelinecall--code-textgenerationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ZeroShotClassificationPipeline","local":"pipelineszeroshotclassificationpipeline","sections":[{"title":"new ZeroShotClassificationPipeline(options)","local":"new-zeroshotclassificationpipelineoptions","sections":[],"depth":3},{"title":"zeroShotClassificationPipeline.model : <code> any </code>","local":"zeroshotclassificationpipelinemodel--code-any-code","sections":[],"depth":3},{"title":"zeroShotClassificationPipeline._call() : <code> ZeroShotClassificationPipelineCallback </code>","local":"zeroshotclassificationpipelinecall--code-zeroshotclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.FeatureExtractionPipeline","local":"pipelinesfeatureextractionpipeline","sections":[{"title":"new FeatureExtractionPipeline(options)","local":"new-featureextractionpipelineoptions","sections":[],"depth":3},{"title":"featureExtractionPipeline._call() : <code> FeatureExtractionPipelineCallback </code>","local":"featureextractionpipelinecall--code-featureextractionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageFeatureExtractionPipeline","local":"pipelinesimagefeatureextractionpipeline","sections":[{"title":"new ImageFeatureExtractionPipeline(options)","local":"new-imagefeatureextractionpipelineoptions","sections":[],"depth":3},{"title":"imageFeatureExtractionPipeline._call() : <code> ImageFeatureExtractionPipelineCallback </code>","local":"imagefeatureextractionpipelinecall--code-imagefeatureextractionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.AudioClassificationPipeline","local":"pipelinesaudioclassificationpipeline","sections":[{"title":"new AudioClassificationPipeline(options)","local":"new-audioclassificationpipelineoptions","sections":[],"depth":3},{"title":"audioClassificationPipeline._call() : <code> AudioClassificationPipelineCallback </code>","local":"audioclassificationpipelinecall--code-audioclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ZeroShotAudioClassificationPipeline","local":"pipelineszeroshotaudioclassificationpipeline","sections":[{"title":"new ZeroShotAudioClassificationPipeline(options)","local":"new-zeroshotaudioclassificationpipelineoptions","sections":[],"depth":3},{"title":"zeroShotAudioClassificationPipeline._call() : <code> ZeroShotAudioClassificationPipelineCallback </code>","local":"zeroshotaudioclassificationpipelinecall--code-zeroshotaudioclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.AutomaticSpeechRecognitionPipeline","local":"pipelinesautomaticspeechrecognitionpipeline","sections":[{"title":"new AutomaticSpeechRecognitionPipeline(options)","local":"new-automaticspeechrecognitionpipelineoptions","sections":[],"depth":3},{"title":"automaticSpeechRecognitionPipeline._call() : <code> AutomaticSpeechRecognitionPipelineCallback </code>","local":"automaticspeechrecognitionpipelinecall--code-automaticspeechrecognitionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageToTextPipeline","local":"pipelinesimagetotextpipeline","sections":[{"title":"new ImageToTextPipeline(options)","local":"new-imagetotextpipelineoptions","sections":[],"depth":3},{"title":"imageToTextPipeline._call() : <code> ImageToTextPipelineCallback </code>","local":"imagetotextpipelinecall--code-imagetotextpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageClassificationPipeline","local":"pipelinesimageclassificationpipeline","sections":[{"title":"new ImageClassificationPipeline(options)","local":"new-imageclassificationpipelineoptions","sections":[],"depth":3},{"title":"imageClassificationPipeline._call() : <code> ImageClassificationPipelineCallback </code>","local":"imageclassificationpipelinecall--code-imageclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageSegmentationPipeline","local":"pipelinesimagesegmentationpipeline","sections":[{"title":"new ImageSegmentationPipeline(options)","local":"new-imagesegmentationpipelineoptions","sections":[],"depth":3},{"title":"imageSegmentationPipeline._call() : <code> ImageSegmentationPipelineCallback </code>","local":"imagesegmentationpipelinecall--code-imagesegmentationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ZeroShotImageClassificationPipeline","local":"pipelineszeroshotimageclassificationpipeline","sections":[{"title":"new ZeroShotImageClassificationPipeline(options)","local":"new-zeroshotimageclassificationpipelineoptions","sections":[],"depth":3},{"title":"zeroShotImageClassificationPipeline._call() : <code> ZeroShotImageClassificationPipelineCallback </code>","local":"zeroshotimageclassificationpipelinecall--code-zeroshotimageclassificationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ObjectDetectionPipeline","local":"pipelinesobjectdetectionpipeline","sections":[{"title":"new ObjectDetectionPipeline(options)","local":"new-objectdetectionpipelineoptions","sections":[],"depth":3},{"title":"objectDetectionPipeline._call() : <code> ObjectDetectionPipelineCallback </code>","local":"objectdetectionpipelinecall--code-objectdetectionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ZeroShotObjectDetectionPipeline","local":"pipelineszeroshotobjectdetectionpipeline","sections":[{"title":"new ZeroShotObjectDetectionPipeline(options)","local":"new-zeroshotobjectdetectionpipelineoptions","sections":[],"depth":3},{"title":"zeroShotObjectDetectionPipeline._call() : <code> ZeroShotObjectDetectionPipelineCallback </code>","local":"zeroshotobjectdetectionpipelinecall--code-zeroshotobjectdetectionpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.DocumentQuestionAnsweringPipeline","local":"pipelinesdocumentquestionansweringpipeline","sections":[{"title":"new DocumentQuestionAnsweringPipeline(options)","local":"new-documentquestionansweringpipelineoptions","sections":[],"depth":3},{"title":"documentQuestionAnsweringPipeline._call() : <code> DocumentQuestionAnsweringPipelineCallback </code>","local":"documentquestionansweringpipelinecall--code-documentquestionansweringpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.TextToAudioPipeline","local":"pipelinestexttoaudiopipeline","sections":[{"title":"new TextToAudioPipeline(options)","local":"new-texttoaudiopipelineoptions","sections":[],"depth":3},{"title":"textToAudioPipeline._call() : <code> TextToAudioPipelineCallback </code>","local":"texttoaudiopipelinecall--code-texttoaudiopipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.ImageToImagePipeline","local":"pipelinesimagetoimagepipeline","sections":[{"title":"new ImageToImagePipeline(options)","local":"new-imagetoimagepipelineoptions","sections":[],"depth":3},{"title":"imageToImagePipeline._call() : <code> ImageToImagePipelineCallback </code>","local":"imagetoimagepipelinecall--code-imagetoimagepipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.DepthEstimationPipeline","local":"pipelinesdepthestimationpipeline","sections":[{"title":"new DepthEstimationPipeline(options)","local":"new-depthestimationpipelineoptions","sections":[],"depth":3},{"title":"depthEstimationPipeline._call() : <code> DepthEstimationPipelineCallback </code>","local":"depthestimationpipelinecall--code-depthestimationpipelinecallback-code","sections":[],"depth":3}],"depth":2},{"title":"pipelines.pipeline(task, [model], [options]) ⇒ <code> * </code>","local":"pipelinespipelinetask-model-options--code--code","sections":[],"depth":2},{"title":"pipelines~ImagePipelineInputs : <code> string </code> \| <code> RawImage </code> \| <code> URL </code>","local":"pipelinesimagepipelineinputs--code-string-code--code-rawimage-code--code-url-code","sections":[],"depth":2},{"title":"pipelines~AudioPipelineInputs : <code> string </code> \| <code> URL </code> \| <code> Float32Array </code> \| <code> Float64Array </code>","local":"pipelinesaudiopipelineinputs--code-string-code--code-url-code--code-float32array-code--code-float64array-code","sections":[],"depth":2},{"title":"pipelines~BoundingBox : <code> Object </code>","local":"pipelinesboundingbox--code-object-code","sections":[],"depth":2},{"title":"pipelines~Disposable ⇒ <code> Promise. < void > </code>","local":"pipelinesdisposable--code-promise--void--code","sections":[],"depth":2},{"title":"pipelines~TextPipelineConstructorArgs : <code> Object </code>","local":"pipelinestextpipelineconstructorargs--code-object-code","sections":[],"depth":2},{"title":"pipelines~ImagePipelineConstructorArgs : <code> Object </code>","local":"pipelinesimagepipelineconstructorargs--code-object-code","sections":[],"depth":2},{"title":"pipelines~TextImagePipelineConstructorArgs : <code> Object </code>","local":"pipelinestextimagepipelineconstructorargs--code-object-code","sections":[],"depth":2},{"title":"pipelines~TextClassificationPipelineType ⇒ <code> Promise. < (TextClassificationOutput\|Array < TextClassificationOutput > ) > </code>","local":"pipelinestextclassificationpipelinetype--code-promise--textclassificationoutputarray--textclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~TokenClassificationPipelineType ⇒ <code> Promise. < (TokenClassificationOutput\|Array < TokenClassificationOutput > ) > </code>","local":"pipelinestokenclassificationpipelinetype--code-promise--tokenclassificationoutputarray--tokenclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~QuestionAnsweringPipelineType ⇒ <code> Promise. < (QuestionAnsweringOutput\|Array < QuestionAnsweringOutput > ) > </code>","local":"pipelinesquestionansweringpipelinetype--code-promise--questionansweringoutputarray--questionansweringoutput----code","sections":[],"depth":2},{"title":"pipelines~FillMaskPipelineType ⇒ <code> Promise. < (FillMaskOutput\|Array < FillMaskOutput > ) > </code>","local":"pipelinesfillmaskpipelinetype--code-promise--fillmaskoutputarray--fillmaskoutput----code","sections":[],"depth":2},{"title":"pipelines~Text2TextGenerationPipelineType ⇒ <code> Promise. < (Text2TextGenerationOutput\|Array < Text2TextGenerationOutput > ) > </code>","local":"pipelinestext2textgenerationpipelinetype--code-promise--text2textgenerationoutputarray--text2textgenerationoutput----code","sections":[],"depth":2},{"title":"pipelines~SummarizationPipelineType ⇒ <code> Promise. < (SummarizationOutput\|Array < SummarizationOutput > ) > </code>","local":"pipelinessummarizationpipelinetype--code-promise--summarizationoutputarray--summarizationoutput----code","sections":[],"depth":2},{"title":"pipelines~TranslationPipelineType ⇒ <code> Promise. < (TranslationOutput\|Array < TranslationOutput > ) > </code>","local":"pipelinestranslationpipelinetype--code-promise--translationoutputarray--translationoutput----code","sections":[],"depth":2},{"title":"pipelines~TextGenerationPipelineType ⇒ <code> Promise. < (TextGenerationOutput\|Array < TextGenerationOutput > ) > </code>","local":"pipelinestextgenerationpipelinetype--code-promise--textgenerationoutputarray--textgenerationoutput----code","sections":[],"depth":2},{"title":"pipelines~ZeroShotClassificationPipelineType ⇒ <code> Promise. < (ZeroShotClassificationOutput\|Array < ZeroShotClassificationOutput > ) > </code>","local":"pipelineszeroshotclassificationpipelinetype--code-promise--zeroshotclassificationoutputarray--zeroshotclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~FeatureExtractionPipelineType ⇒ <code> Promise. < Tensor > </code>","local":"pipelinesfeatureextractionpipelinetype--code-promise--tensor--code","sections":[],"depth":2},{"title":"pipelines~ImageFeatureExtractionPipelineType ⇒ <code> Promise. < Tensor > </code>","local":"pipelinesimagefeatureextractionpipelinetype--code-promise--tensor--code","sections":[],"depth":2},{"title":"pipelines~AudioClassificationPipelineType ⇒ <code> Promise. < (AudioClassificationOutput\|Array < AudioClassificationOutput > ) > </code>","local":"pipelinesaudioclassificationpipelinetype--code-promise--audioclassificationoutputarray--audioclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~ZeroShotAudioClassificationPipelineType ⇒ <code> Promise. < (Array < ZeroShotAudioClassificationOutput > \|Array < Array < ZeroShotAudioClassificationOutput > > ) > </code>","local":"pipelineszeroshotaudioclassificationpipelinetype--code-promise--array--zeroshotaudioclassificationoutput--array--array--zeroshotaudioclassificationoutput-----code","sections":[],"depth":2},{"title":"pipelines~Chunk : <code> Object </code>","local":"pipelineschunk--code-object-code","sections":[],"depth":2},{"title":"pipelines~AutomaticSpeechRecognitionPipelineType ⇒ <code> Promise. < (AutomaticSpeechRecognitionOutput\|Array < AutomaticSpeechRecognitionOutput > ) > </code>","local":"pipelinesautomaticspeechrecognitionpipelinetype--code-promise--automaticspeechrecognitionoutputarray--automaticspeechrecognitionoutput----code","sections":[],"depth":2},{"title":"pipelines~ImageToTextPipelineType ⇒ <code> Promise. < (ImageToTextOutput\|Array < ImageToTextOutput > ) > </code>","local":"pipelinesimagetotextpipelinetype--code-promise--imagetotextoutputarray--imagetotextoutput----code","sections":[],"depth":2},{"title":"pipelines~ImageClassificationPipelineType ⇒ <code> Promise. < (ImageClassificationOutput\|Array < ImageClassificationOutput > ) > </code>","local":"pipelinesimageclassificationpipelinetype--code-promise--imageclassificationoutputarray--imageclassificationoutput----code","sections":[],"depth":2},{"title":"pipelines~ImageSegmentationPipelineType ⇒ <code> Promise. < Array < ImageSegmentationPipelineOutput > > </code>","local":"pipelinesimagesegmentationpipelinetype--code-promise--array--imagesegmentationpipelineoutput---code","sections":[],"depth":2},{"title":"pipelines~ZeroShotImageClassificationPipelineType ⇒ <code> Promise. < (Array < ZeroShotImageClassificationOutput > \|Array < Array < ZeroShotImageClassificationOutput > > ) > </code>","local":"pipelineszeroshotimageclassificationpipelinetype--code-promise--array--zeroshotimageclassificationoutput--array--array--zeroshotimageclassificationoutput-----code","sections":[],"depth":2},{"title":"pipelines~ObjectDetectionPipelineType ⇒ <code> Promise. < (ObjectDetectionPipelineOutput\|Array < ObjectDetectionPipelineOutput > ) > </code>","local":"pipelinesobjectdetectionpipelinetype--code-promise--objectdetectionpipelineoutputarray--objectdetectionpipelineoutput----code","sections":[],"depth":2},{"title":"pipelines~ZeroShotObjectDetectionPipelineType ⇒ <code> Promise. < (Array < ZeroShotObjectDetectionOutput > \|Array < Array < ZeroShotObjectDetectionOutput > > ) > </code>","local":"pipelineszeroshotobjectdetectionpipelinetype--code-promise--array--zeroshotobjectdetectionoutput--array--array--zeroshotobjectdetectionoutput-----code","sections":[],"depth":2},{"title":"pipelines~DocumentQuestionAnsweringPipelineType ⇒ <code> Promise. < (DocumentQuestionAnsweringOutput\|Array < DocumentQuestionAnsweringOutput > ) > </code>","local":"pipelinesdocumentquestionansweringpipelinetype--code-promise--documentquestionansweringoutputarray--documentquestionansweringoutput----code","sections":[],"depth":2},{"title":"pipelines~TextToAudioPipelineConstructorArgs : <code> Object </code>","local":"pipelinestexttoaudiopipelineconstructorargs--code-object-code","sections":[],"depth":2},{"title":"pipelines~TextToAudioPipelineType ⇒ <code> Promise. < TextToAudioOutput > </code>","local":"pipelinestexttoaudiopipelinetype--code-promise--texttoaudiooutput--code","sections":[],"depth":2},{"title":"pipelines~ImageToImagePipelineType ⇒ <code> Promise. < (RawImage\|Array < RawImage > ) > </code>","local":"pipelinesimagetoimagepipelinetype--code-promise--rawimagearray--rawimage----code","sections":[],"depth":2},{"title":"pipelines~DepthEstimationPipelineType ⇒ <code> Promise. < (DepthEstimationPipelineOutput\|Array < DepthEstimationPipelineOutput > ) > </code>","local":"pipelinesdepthestimationpipelinetype--code-promise--depthestimationpipelineoutputarray--depthestimationpipelineoutput----code","sections":[],"depth":2},{"title":"pipelines~AllTasks : <code> * </code>","local":"pipelinesalltasks--code--code","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <a id="module_pipelines" class="group"></a> <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-g9u9bb"><li><a href="#module_pipelines">pipelines</a><ul><li><em>static</em><ul><li><a href="#module_pipelines.Pipeline">.Pipeline</a><ul><li><a href="#new_module_pipelines.Pipeline_new"><code>new Pipeline(options)</code></a></li> <li><a href="#module_pipelines.Pipeline+dispose"><code>.dispose()</code></a> : <code>DisposeType</code></li></ul></li> <li><a href="#module_pipelines.TextClassificationPipeline">.TextClassificationPipeline</a><ul><li><a href="#new_module_pipelines.TextClassificationPipeline_new"><code>new TextClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.TextClassificationPipeline+_call"><code>._call()</code></a> : <code>TextClassificationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.TokenClassificationPipeline">.TokenClassificationPipeline</a><ul><li><a href="#new_module_pipelines.TokenClassificationPipeline_new"><code>new TokenClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.TokenClassificationPipeline+_call"><code>._call()</code></a> : <code>TokenClassificationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.QuestionAnsweringPipeline">.QuestionAnsweringPipeline</a><ul><li><a href="#new_module_pipelines.QuestionAnsweringPipeline_new"><code>new QuestionAnsweringPipeline(options)</code></a></li> <li><a href="#module_pipelines.QuestionAnsweringPipeline+_call"><code>._call()</code></a> : <code>QuestionAnsweringPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.FillMaskPipeline">.FillMaskPipeline</a><ul><li><a href="#new_module_pipelines.FillMaskPipeline_new"><code>new FillMaskPipeline(options)</code></a></li> <li><a href="#module_pipelines.FillMaskPipeline+_call"><code>._call()</code></a> : <code>FillMaskPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.Text2TextGenerationPipeline">.Text2TextGenerationPipeline</a><ul><li><a href="#new_module_pipelines.Text2TextGenerationPipeline_new"><code>new Text2TextGenerationPipeline(options)</code></a></li> <li><a href="#module_pipelines.Text2TextGenerationPipeline+_key"><code>._key</code></a> : <code>’generated_text’</code></li> <li><a href="#module_pipelines.Text2TextGenerationPipeline+_call"><code>._call()</code></a> : <code>Text2TextGenerationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.SummarizationPipeline">.SummarizationPipeline</a><ul><li><a href="#new_module_pipelines.SummarizationPipeline_new"><code>new SummarizationPipeline(options)</code></a></li> <li><a href="#module_pipelines.SummarizationPipeline+_key"><code>._key</code></a> : <code>’summary_text’</code></li></ul></li> <li><a href="#module_pipelines.TranslationPipeline">.TranslationPipeline</a><ul><li><a href="#new_module_pipelines.TranslationPipeline_new"><code>new TranslationPipeline(options)</code></a></li> <li><a href="#module_pipelines.TranslationPipeline+_key"><code>._key</code></a> : <code>’translation_text’</code></li></ul></li> <li><a href="#module_pipelines.TextGenerationPipeline">.TextGenerationPipeline</a><ul><li><a href="#new_module_pipelines.TextGenerationPipeline_new"><code>new TextGenerationPipeline(options)</code></a></li> <li><a href="#module_pipelines.TextGenerationPipeline+_call"><code>._call()</code></a> : <code>TextGenerationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ZeroShotClassificationPipeline">.ZeroShotClassificationPipeline</a><ul><li><a href="#new_module_pipelines.ZeroShotClassificationPipeline_new"><code>new ZeroShotClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ZeroShotClassificationPipeline+model"><code>.model</code></a> : <code>any</code></li> <li><a href="#module_pipelines.ZeroShotClassificationPipeline+_call"><code>._call()</code></a> : <code>ZeroShotClassificationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.FeatureExtractionPipeline">.FeatureExtractionPipeline</a><ul><li><a href="#new_module_pipelines.FeatureExtractionPipeline_new"><code>new FeatureExtractionPipeline(options)</code></a></li> <li><a href="#module_pipelines.FeatureExtractionPipeline+_call"><code>._call()</code></a> : <code>FeatureExtractionPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ImageFeatureExtractionPipeline">.ImageFeatureExtractionPipeline</a><ul><li><a href="#new_module_pipelines.ImageFeatureExtractionPipeline_new"><code>new ImageFeatureExtractionPipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageFeatureExtractionPipeline+_call"><code>._call()</code></a> : <code>ImageFeatureExtractionPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.AudioClassificationPipeline">.AudioClassificationPipeline</a><ul><li><a href="#new_module_pipelines.AudioClassificationPipeline_new"><code>new AudioClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.AudioClassificationPipeline+_call"><code>._call()</code></a> : <code>AudioClassificationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ZeroShotAudioClassificationPipeline">.ZeroShotAudioClassificationPipeline</a><ul><li><a href="#new_module_pipelines.ZeroShotAudioClassificationPipeline_new"><code>new ZeroShotAudioClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ZeroShotAudioClassificationPipeline+_call"><code>._call()</code></a> : <code>ZeroShotAudioClassificationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.AutomaticSpeechRecognitionPipeline">.AutomaticSpeechRecognitionPipeline</a><ul><li><a href="#new_module_pipelines.AutomaticSpeechRecognitionPipeline_new"><code>new AutomaticSpeechRecognitionPipeline(options)</code></a></li> <li><a href="#module_pipelines.AutomaticSpeechRecognitionPipeline+_call"><code>._call()</code></a> : <code>AutomaticSpeechRecognitionPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ImageToTextPipeline">.ImageToTextPipeline</a><ul><li><a href="#new_module_pipelines.ImageToTextPipeline_new"><code>new ImageToTextPipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageToTextPipeline+_call"><code>._call()</code></a> : <code>ImageToTextPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ImageClassificationPipeline">.ImageClassificationPipeline</a><ul><li><a href="#new_module_pipelines.ImageClassificationPipeline_new"><code>new ImageClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageClassificationPipeline+_call"><code>._call()</code></a> : <code>ImageClassificationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ImageSegmentationPipeline">.ImageSegmentationPipeline</a><ul><li><a href="#new_module_pipelines.ImageSegmentationPipeline_new"><code>new ImageSegmentationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageSegmentationPipeline+_call"><code>._call()</code></a> : <code>ImageSegmentationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ZeroShotImageClassificationPipeline">.ZeroShotImageClassificationPipeline</a><ul><li><a href="#new_module_pipelines.ZeroShotImageClassificationPipeline_new"><code>new ZeroShotImageClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ZeroShotImageClassificationPipeline+_call"><code>._call()</code></a> : <code>ZeroShotImageClassificationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ObjectDetectionPipeline">.ObjectDetectionPipeline</a><ul><li><a href="#new_module_pipelines.ObjectDetectionPipeline_new"><code>new ObjectDetectionPipeline(options)</code></a></li> <li><a href="#module_pipelines.ObjectDetectionPipeline+_call"><code>._call()</code></a> : <code>ObjectDetectionPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ZeroShotObjectDetectionPipeline">.ZeroShotObjectDetectionPipeline</a><ul><li><a href="#new_module_pipelines.ZeroShotObjectDetectionPipeline_new"><code>new ZeroShotObjectDetectionPipeline(options)</code></a></li> <li><a href="#module_pipelines.ZeroShotObjectDetectionPipeline+_call"><code>._call()</code></a> : <code>ZeroShotObjectDetectionPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.DocumentQuestionAnsweringPipeline">.DocumentQuestionAnsweringPipeline</a><ul><li><a href="#new_module_pipelines.DocumentQuestionAnsweringPipeline_new"><code>new DocumentQuestionAnsweringPipeline(options)</code></a></li> <li><a href="#module_pipelines.DocumentQuestionAnsweringPipeline+_call"><code>._call()</code></a> : <code>DocumentQuestionAnsweringPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.TextToAudioPipeline">.TextToAudioPipeline</a><ul><li><a href="#new_module_pipelines.TextToAudioPipeline_new"><code>new TextToAudioPipeline(options)</code></a></li> <li><a href="#module_pipelines.TextToAudioPipeline+_call"><code>._call()</code></a> : <code>TextToAudioPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.ImageToImagePipeline">.ImageToImagePipeline</a><ul><li><a href="#new_module_pipelines.ImageToImagePipeline_new"><code>new ImageToImagePipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageToImagePipeline+_call"><code>._call()</code></a> : <code>ImageToImagePipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.DepthEstimationPipeline">.DepthEstimationPipeline</a><ul><li><a href="#new_module_pipelines.DepthEstimationPipeline_new"><code>new DepthEstimationPipeline(options)</code></a></li> <li><a href="#module_pipelines.DepthEstimationPipeline+_call"><code>._call()</code></a> : <code>DepthEstimationPipelineCallback</code></li></ul></li> <li><a href="#module_pipelines.pipeline"><code>.pipeline(task, [model], [options])</code></a> ⇒ <code></code></li></ul></li> <li><em>inner</em><ul><li><a href="#module_pipelines..ImagePipelineInputs"><code>~ImagePipelineInputs</code></a> : <code>string</code> \| <a href="#RawImage"><code>RawImage</code></a> \| <code>URL</code></li> <li><a href="#module_pipelines..AudioPipelineInputs"><code>~AudioPipelineInputs</code></a> : <code>string</code> \| <code>URL</code> \| <code>Float32Array</code> \| <code>Float64Array</code></li> <li><a href="#module_pipelines..BoundingBox"><code>~BoundingBox</code></a> : <code>Object</code></li> <li><a href="#module_pipelines..Disposable"><code>~Disposable</code></a> ⇒ <code>Promise.<void></code></li> <li><a href="#module_pipelines..TextPipelineConstructorArgs"><code>~TextPipelineConstructorArgs</code></a> : <code>Object</code></li> <li><a href="#module_pipelines..ImagePipelineConstructorArgs"><code>~ImagePipelineConstructorArgs</code></a> : <code>Object</code></li> <li><a href="#module_pipelines..TextImagePipelineConstructorArgs"><code>~TextImagePipelineConstructorArgs</code></a> : <code>Object</code></li> <li><a href="#module_pipelines..TextClassificationPipelineType"><code>~TextClassificationPipelineType</code></a> ⇒ <code>Promise.<(TextClassificationOutput\|Array<TextClassificationOutput>)></code></li> <li><a href="#module_pipelines..TokenClassificationPipelineType"><code>~TokenClassificationPipelineType</code></a> ⇒ <code>Promise.<(TokenClassificationOutput\|Array<TokenClassificationOutput>)></code></li> <li><a href="#module_pipelines..QuestionAnsweringPipelineType"><code>~QuestionAnsweringPipelineType</code></a> ⇒ <code>Promise.<(QuestionAnsweringOutput\|Array<QuestionAnsweringOutput>)></code></li> <li><a href="#module_pipelines..FillMaskPipelineType"><code>~FillMaskPipelineType</code></a> ⇒ <code>Promise.<(FillMaskOutput\|Array<FillMaskOutput>)></code></li> <li><a href="#module_pipelines..Text2TextGenerationPipelineType"><code>~Text2TextGenerationPipelineType</code></a> ⇒ <code>Promise.<(Text2TextGenerationOutput\|Array<Text2TextGenerationOutput>)></code></li> <li><a href="#module_pipelines..SummarizationPipelineType"><code>~SummarizationPipelineType</code></a> ⇒ <code>Promise.<(SummarizationOutput\|Array<SummarizationOutput>)></code></li> <li><a href="#module_pipelines..TranslationPipelineType"><code>~TranslationPipelineType</code></a> ⇒ <code>Promise.<(TranslationOutput\|Array<TranslationOutput>)></code></li> <li><a href="#module_pipelines..TextGenerationPipelineType"><code>~TextGenerationPipelineType</code></a> ⇒ <code>Promise.<(TextGenerationOutput\|Array<TextGenerationOutput>)></code></li> <li><a href="#module_pipelines..ZeroShotClassificationPipelineType"><code>~ZeroShotClassificationPipelineType</code></a> ⇒ <code>Promise.<(ZeroShotClassificationOutput\|Array<ZeroShotClassificationOutput>)></code></li> <li><a href="#module_pipelines..FeatureExtractionPipelineType"><code>~FeatureExtractionPipelineType</code></a> ⇒ <a href="#Tensor"><code>Promise.<Tensor></code></a></li> <li><a href="#module_pipelines..ImageFeatureExtractionPipelineType"><code>~ImageFeatureExtractionPipelineType</code></a> ⇒ <a href="#Tensor"><code>Promise.<Tensor></code></a></li> <li><a href="#module_pipelines..AudioClassificationPipelineType"><code>~AudioClassificationPipelineType</code></a> ⇒ <code>Promise.<(AudioClassificationOutput\|Array<AudioClassificationOutput>)></code></li> <li><a href="#module_pipelines..ZeroShotAudioClassificationPipelineType"><code>~ZeroShotAudioClassificationPipelineType</code></a> ⇒ <code>Promise.<(Array<ZeroShotAudioClassificationOutput>\|Array<Array<ZeroShotAudioClassificationOutput>>)></code></li> <li><a href="#module_pipelines..Chunk"><code>~Chunk</code></a> : <code>Object</code></li> <li><a href="#module_pipelines..AutomaticSpeechRecognitionPipelineType"><code>~AutomaticSpeechRecognitionPipelineType</code></a> ⇒ <code>Promise.<(AutomaticSpeechRecognitionOutput\|Array<AutomaticSpeechRecognitionOutput>)></code></li> <li><a href="#module_pipelines..ImageToTextPipelineType"><code>~ImageToTextPipelineType</code></a> ⇒ <code>Promise.<(ImageToTextOutput\|Array<ImageToTextOutput>)></code></li> <li><a href="#module_pipelines..ImageClassificationPipelineType"><code>~ImageClassificationPipelineType</code></a> ⇒ <code>Promise.<(ImageClassificationOutput\|Array<ImageClassificationOutput>)></code></li> <li><a href="#module_pipelines..ImageSegmentationPipelineType"><code>~ImageSegmentationPipelineType</code></a> ⇒ <code>Promise.<Array<ImageSegmentationPipelineOutput>></code></li> <li><a href="#module_pipelines..ZeroShotImageClassificationPipelineType"><code>~ZeroShotImageClassificationPipelineType</code></a> ⇒ <code>Promise.<(Array<ZeroShotImageClassificationOutput>\|Array<Array<ZeroShotImageClassificationOutput>>)></code></li> <li><a href="#module_pipelines..ObjectDetectionPipelineType"><code>~ObjectDetectionPipelineType</code></a> ⇒ <code>Promise.<(ObjectDetectionPipelineOutput\|Array<ObjectDetectionPipelineOutput>)></code></li> <li><a href="#module_pipelines..ZeroShotObjectDetectionPipelineType"><code>~ZeroShotObjectDetectionPipelineType</code></a> ⇒ <code>Promise.<(Array<ZeroShotObjectDetectionOutput>\|Array<Array<ZeroShotObjectDetectionOutput>>)></code></li> <li><a href="#module_pipelines..DocumentQuestionAnsweringPipelineType"><code>~DocumentQuestionAnsweringPipelineType</code></a> ⇒ <code>Promise.<(DocumentQuestionAnsweringOutput\|Array<DocumentQuestionAnsweringOutput>)></code></li> <li><a href="#module_pipelines..TextToAudioPipelineConstructorArgs"><code>~TextToAudioPipelineConstructorArgs</code></a> : <code>Object</code></li> <li><a href="#module_pipelines..TextToAudioPipelineType"><code>~TextToAudioPipelineType</code></a> ⇒ <code>Promise.<TextToAudioOutput></code></li> <li><a href="#module_pipelines..ImageToImagePipelineType"><code>~ImageToImagePipelineType</code></a> ⇒ <code>Promise.<(RawImage\|Array<RawImage>)></code></li> <li><a href="#module_pipelines..DepthEstimationPipelineType"><code>~DepthEstimationPipelineType</code></a> ⇒ <code>Promise.<(DepthEstimationPipelineOutput\|Array<DepthEstimationPipelineOutput>)></code></li> <li><a href="#module_pipelines..AllTasks"><code>~AllTasks</code></a> : <code></code></li></ul></li></ul></li></ul> <hr> <a id="module_pipelines.Pipeline" class="group"></a> <h2 class="relative group"><a id="pipelinespipeline" 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="#pipelinespipeline"><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</span></h2> <p data-svelte-h="svelte-16ix8v2">The Pipeline class is the class from which all pipelines inherit.
	Refer to this class for methods shared across different pipelines.</p> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-1va89g7"><li><a href="#module_pipelines.Pipeline">.Pipeline</a><ul><li><a href="#new_module_pipelines.Pipeline_new"><code>new Pipeline(options)</code></a></li> <li><a href="#module_pipelines.Pipeline+dispose"><code>.dispose()</code></a> : <code>DisposeType</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.Pipeline_new" class="group"></a> <h3 class="relative group"><a id="new-pipelineoptions" 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-pipelineoptions"><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 Pipeline(options)</span></h3> <p data-svelte-h="svelte-10jkwj">Create a new Pipeline.</p> <table data-svelte-h="svelte-z7lv5w"><thead><tr><th>Param</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>Object</code></td><td></td><td><p>An object containing the following properties:</p></td> </tr><tr><td>[options.task]</td><td><code>string</code></td><td></td><td><p>The task of the pipeline. Useful for specifying subtasks.</p></td> </tr><tr><td>[options.model]</td><td><code>PreTrainedModel</code></td><td></td><td><p>The model used by the pipeline.</p></td> </tr><tr><td>[options.tokenizer]</td><td><code>PreTrainedTokenizer</code></td><td><code></code></td><td><p>The tokenizer used by the pipeline (if any).</p></td> </tr><tr><td>[options.processor]</td><td><code>Processor</code></td><td><code></code></td><td><p>The processor used by the pipeline (if any).</p></td></tr></tbody></table> <hr> <a id="module_pipelines.Pipeline+dispose" class="group"></a> <h3 class="relative group"><a id="pipelinedispose--code-disposetype-code" 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="#pipelinedispose--code-disposetype-code"><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.dispose() : <code> DisposeType </code></span></h3> <p data-svelte-h="svelte-hhwo7"><strong>Kind</strong>: instance method of <a href="#module_pipelines.Pipeline"><code>Pipeline</code></a></p> <hr> <a id="module_pipelines.TextClassificationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinestextclassificationpipeline" 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="#pipelinestextclassificationpipeline"><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.TextClassificationPipeline</span></h2> <p data-svelte-h="svelte-1aega0x">Text classification pipeline using any <code>ModelForSequenceClassification</code>.</p> <p data-svelte-h="svelte-twv4w2"><strong>Example:</strong> Sentiment-analysis w/ <code>Xenova/distilbert-base-uncased-finetuned-sst-2-english</code>.</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">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-string">'Xenova/distilbert-base-uncased-finetuned-sst-2-english'</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.999788761138916 }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-9l8wqs"><strong>Example:</strong> Multilingual sentiment-analysis w/ <code>Xenova/bert-base-multilingual-uncased-sentiment</code> (and return top 5 classes).</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">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-string">'Xenova/bert-base-multilingual-uncased-sentiment'</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">'Le meilleur film de tous les temps.'</span>, { <span class="hljs-attr">top_k</span>: <span class="hljs-number">5</span> });
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { label: '5 stars', score: 0.9610759615898132 },</span>
	<span class="hljs-comment">// { label: '4 stars', score: 0.03323351591825485 },</span>
	<span class="hljs-comment">// { label: '3 stars', score: 0.0036155181005597115 },</span>
	<span class="hljs-comment">// { label: '1 star', score: 0.0011325967498123646 },</span>
	<span class="hljs-comment">// { label: '2 stars', score: 0.0009423971059732139 }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-63pkoo"><strong>Example:</strong> Toxic comment classification w/ <code>Xenova/toxic-bert</code> (and return all classes).</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'text-classification'</span>, <span class="hljs-string">'Xenova/toxic-bert'</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 hate you!'</span>, { <span class="hljs-attr">top_k</span>: <span class="hljs-literal">null</span> });
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { label: 'toxic', score: 0.9593140482902527 },</span>
	<span class="hljs-comment">// { label: 'insult', score: 0.16187334060668945 },</span>
	<span class="hljs-comment">// { label: 'obscene', score: 0.03452680632472038 },</span>
	<span class="hljs-comment">// { label: 'identity_hate', score: 0.0223250575363636 },</span>
	<span class="hljs-comment">// { label: 'threat', score: 0.019197041168808937 },</span>
	<span class="hljs-comment">// { label: 'severe_toxic', score: 0.005651099607348442 }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-pm72j5"><li><a href="#module_pipelines.TextClassificationPipeline">.TextClassificationPipeline</a><ul><li><a href="#new_module_pipelines.TextClassificationPipeline_new"><code>new TextClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.TextClassificationPipeline+_call"><code>._call()</code></a> : <code>TextClassificationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.TextClassificationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-textclassificationpipelineoptions" 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-textclassificationpipelineoptions"><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 TextClassificationPipeline(options)</span></h3> <p data-svelte-h="svelte-i7tdq8">Create a new TextClassificationPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.TextClassificationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="textclassificationpipelinecall--code-textclassificationpipelinecallback-code" 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="#textclassificationpipelinecall--code-textclassificationpipelinecallback-code"><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>textClassificationPipeline._call() : <code> TextClassificationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-10suosj"><strong>Kind</strong>: instance method of <a href="#module_pipelines.TextClassificationPipeline"><code>TextClassificationPipeline</code></a></p> <hr> <a id="module_pipelines.TokenClassificationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinestokenclassificationpipeline" 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="#pipelinestokenclassificationpipeline"><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.TokenClassificationPipeline</span></h2> <p data-svelte-h="svelte-199l8oj">Named Entity Recognition pipeline using any <code>ModelForTokenClassification</code>.</p> <p data-svelte-h="svelte-3ojewp"><strong>Example:</strong> Perform named entity recognition with <code>Xenova/bert-base-NER</code>.</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'token-classification'</span>, <span class="hljs-string">'Xenova/bert-base-NER'</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">'My name is Sarah and I live in London'</span>);
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { entity: 'B-PER', score: 0.9980202913284302, index: 4, word: 'Sarah' },</span>
	<span class="hljs-comment">// { entity: 'B-LOC', score: 0.9994474053382874, index: 9, word: 'London' }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1ln7q61"><strong>Example:</strong> Perform named entity recognition with <code>Xenova/bert-base-NER</code> (and return all labels).</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'token-classification'</span>, <span class="hljs-string">'Xenova/bert-base-NER'</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">'Sarah lives in the United States of America'</span>, { <span class="hljs-attr">ignore_labels</span>: [] });
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { entity: 'B-PER', score: 0.9966587424278259, index: 1, word: 'Sarah' },</span>
	<span class="hljs-comment">// { entity: 'O', score: 0.9987385869026184, index: 2, word: 'lives' },</span>
	<span class="hljs-comment">// { entity: 'O', score: 0.9990072846412659, index: 3, word: 'in' },</span>
	<span class="hljs-comment">// { entity: 'O', score: 0.9988298416137695, index: 4, word: 'the' },</span>
	<span class="hljs-comment">// { entity: 'B-LOC', score: 0.9995510578155518, index: 5, word: 'United' },</span>
	<span class="hljs-comment">// { entity: 'I-LOC', score: 0.9990395307540894, index: 6, word: 'States' },</span>
	<span class="hljs-comment">// { entity: 'I-LOC', score: 0.9986724853515625, index: 7, word: 'of' },</span>
	<span class="hljs-comment">// { entity: 'I-LOC', score: 0.9975294470787048, index: 8, word: 'America' }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-m3wy8r"><li><a href="#module_pipelines.TokenClassificationPipeline">.TokenClassificationPipeline</a><ul><li><a href="#new_module_pipelines.TokenClassificationPipeline_new"><code>new TokenClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.TokenClassificationPipeline+_call"><code>._call()</code></a> : <code>TokenClassificationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.TokenClassificationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-tokenclassificationpipelineoptions" 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-tokenclassificationpipelineoptions"><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 TokenClassificationPipeline(options)</span></h3> <p data-svelte-h="svelte-1qyf5iw">Create a new TokenClassificationPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.TokenClassificationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="tokenclassificationpipelinecall--code-tokenclassificationpipelinecallback-code" 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="#tokenclassificationpipelinecall--code-tokenclassificationpipelinecallback-code"><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>tokenClassificationPipeline._call() : <code> TokenClassificationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-1fnwy8z"><strong>Kind</strong>: instance method of <a href="#module_pipelines.TokenClassificationPipeline"><code>TokenClassificationPipeline</code></a></p> <hr> <a id="module_pipelines.QuestionAnsweringPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesquestionansweringpipeline" 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="#pipelinesquestionansweringpipeline"><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.QuestionAnsweringPipeline</span></h2> <p data-svelte-h="svelte-14f3xkz">Question Answering pipeline using any <code>ModelForQuestionAnswering</code>.</p> <p data-svelte-h="svelte-o2pgcr"><strong>Example:</strong> Run question answering with <code>Xenova/distilbert-base-uncased-distilled-squad</code>.</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">const</span> answerer = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'question-answering'</span>, <span class="hljs-string">'Xenova/distilbert-base-uncased-distilled-squad'</span>);
	<span class="hljs-keyword">const</span> question = <span class="hljs-string">'Who was Jim Henson?'</span>;
	<span class="hljs-keyword">const</span> context = <span class="hljs-string">'Jim Henson was a nice puppet.'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">answerer</span>(question, context);
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// answer: "a nice puppet",</span>
	<span class="hljs-comment">// score: 0.5768911502526741</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-ryq6lj"><li><a href="#module_pipelines.QuestionAnsweringPipeline">.QuestionAnsweringPipeline</a><ul><li><a href="#new_module_pipelines.QuestionAnsweringPipeline_new"><code>new QuestionAnsweringPipeline(options)</code></a></li> <li><a href="#module_pipelines.QuestionAnsweringPipeline+_call"><code>._call()</code></a> : <code>QuestionAnsweringPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.QuestionAnsweringPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-questionansweringpipelineoptions" 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-questionansweringpipelineoptions"><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 QuestionAnsweringPipeline(options)</span></h3> <p data-svelte-h="svelte-neuqt1">Create a new QuestionAnsweringPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.QuestionAnsweringPipeline+_call" class="group"></a> <h3 class="relative group"><a id="questionansweringpipelinecall--code-questionansweringpipelinecallback-code" 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="#questionansweringpipelinecall--code-questionansweringpipelinecallback-code"><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>questionAnsweringPipeline._call() : <code> QuestionAnsweringPipelineCallback </code></span></h3> <p data-svelte-h="svelte-1xqr0u1"><strong>Kind</strong>: instance method of <a href="#module_pipelines.QuestionAnsweringPipeline"><code>QuestionAnsweringPipeline</code></a></p> <hr> <a id="module_pipelines.FillMaskPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesfillmaskpipeline" 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="#pipelinesfillmaskpipeline"><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.FillMaskPipeline</span></h2> <p data-svelte-h="svelte-nzjx48">Masked language modeling prediction pipeline using any <code>ModelWithLMHead</code>.</p> <p data-svelte-h="svelte-1xict4f"><strong>Example:</strong> Perform masked language modelling (a.k.a. “fill-mask”) with <code>Xenova/bert-base-uncased</code>.</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">const</span> unmasker = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'fill-mask'</span>, <span class="hljs-string">'Xenova/bert-base-cased'</span>);
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">unmasker</span>(<span class="hljs-string">'The goal of life is [MASK].'</span>);
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { token_str: 'survival', score: 0.06137419492006302, token: 8115, sequence: 'The goal of life is survival.' },</span>
	<span class="hljs-comment">// { token_str: 'love', score: 0.03902450203895569, token: 1567, sequence: 'The goal of life is love.' },</span>
	<span class="hljs-comment">// { token_str: 'happiness', score: 0.03253183513879776, token: 9266, sequence: 'The goal of life is happiness.' },</span>
	<span class="hljs-comment">// { token_str: 'freedom', score: 0.018736306577920914, token: 4438, sequence: 'The goal of life is freedom.' },</span>
	<span class="hljs-comment">// { token_str: 'life', score: 0.01859794743359089, token: 1297, sequence: 'The goal of life is life.' }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1sz7ava"><strong>Example:</strong> Perform masked language modelling (a.k.a. “fill-mask”) with <code>Xenova/bert-base-cased</code> (and return top result).</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">const</span> unmasker = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'fill-mask'</span>, <span class="hljs-string">'Xenova/bert-base-cased'</span>);
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">unmasker</span>(<span class="hljs-string">'The Milky Way is a [MASK] galaxy.'</span>, { <span class="hljs-attr">top_k</span>: <span class="hljs-number">1</span> });
	<span class="hljs-comment">// [{ token_str: 'spiral', score: 0.6299987435340881, token: 14061, sequence: 'The Milky Way is a spiral galaxy.' }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-13j9xod"><li><a href="#module_pipelines.FillMaskPipeline">.FillMaskPipeline</a><ul><li><a href="#new_module_pipelines.FillMaskPipeline_new"><code>new FillMaskPipeline(options)</code></a></li> <li><a href="#module_pipelines.FillMaskPipeline+_call"><code>._call()</code></a> : <code>FillMaskPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.FillMaskPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-fillmaskpipelineoptions" 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-fillmaskpipelineoptions"><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 FillMaskPipeline(options)</span></h3> <p data-svelte-h="svelte-1wfo17y">Create a new FillMaskPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.FillMaskPipeline+_call" class="group"></a> <h3 class="relative group"><a id="fillmaskpipelinecall--code-fillmaskpipelinecallback-code" 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="#fillmaskpipelinecall--code-fillmaskpipelinecallback-code"><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>fillMaskPipeline._call() : <code> FillMaskPipelineCallback </code></span></h3> <p data-svelte-h="svelte-nplbor"><strong>Kind</strong>: instance method of <a href="#module_pipelines.FillMaskPipeline"><code>FillMaskPipeline</code></a></p> <hr> <a id="module_pipelines.Text2TextGenerationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinestext2textgenerationpipeline" 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="#pipelinestext2textgenerationpipeline"><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.Text2TextGenerationPipeline</span></h2> <p data-svelte-h="svelte-e2spcq">Text2TextGenerationPipeline class for generating text using a model that performs text-to-text generation tasks.</p> <p data-svelte-h="svelte-j4hwgn"><strong>Example:</strong> Text-to-text generation w/ <code>Xenova/LaMini-Flan-T5-783M</code>.</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">const</span> generator = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'text2text-generation'</span>, <span class="hljs-string">'Xenova/LaMini-Flan-T5-783M'</span>);
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">generator</span>(<span class="hljs-string">'how can I become more healthy?'</span>, {
	<span class="hljs-attr">max_new_tokens</span>: <span class="hljs-number">100</span>,
	});
	<span class="hljs-comment">// [{ generated_text: "To become more healthy, you can: 1. Eat a balanced diet with plenty of fruits, vegetables, whole grains, lean proteins, and healthy fats. 2. Stay hydrated by drinking plenty of water. 3. Get enough sleep and manage stress levels. 4. Avoid smoking and excessive alcohol consumption. 5. Regularly exercise and maintain a healthy weight. 6. Practice good hygiene and sanitation. 7. Seek medical attention if you experience any health issues." }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-11x3uau"><li><a href="#module_pipelines.Text2TextGenerationPipeline">.Text2TextGenerationPipeline</a><ul><li><a href="#new_module_pipelines.Text2TextGenerationPipeline_new"><code>new Text2TextGenerationPipeline(options)</code></a></li> <li><a href="#module_pipelines.Text2TextGenerationPipeline+_key"><code>._key</code></a> : <code>’generated_text’</code></li> <li><a href="#module_pipelines.Text2TextGenerationPipeline+_call"><code>._call()</code></a> : <code>Text2TextGenerationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.Text2TextGenerationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-text2textgenerationpipelineoptions" 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-text2textgenerationpipelineoptions"><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 Text2TextGenerationPipeline(options)</span></h3> <p data-svelte-h="svelte-1cz796d">Create a new Text2TextGenerationPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.Text2TextGenerationPipeline+_key" class="group"></a> <h3 class="relative group"><a id="text2textgenerationpipelinekey--code--generatedtext--code" 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="#text2textgenerationpipelinekey--code--generatedtext--code"><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>text2TextGenerationPipeline._key : <code> ’ generated_text ’ </code></span></h3> <p data-svelte-h="svelte-1k77yex"><strong>Kind</strong>: instance property of <a href="#module_pipelines.Text2TextGenerationPipeline"><code>Text2TextGenerationPipeline</code></a></p> <hr> <a id="module_pipelines.Text2TextGenerationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="text2textgenerationpipelinecall--code-text2textgenerationpipelinecallback-code" 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="#text2textgenerationpipelinecall--code-text2textgenerationpipelinecallback-code"><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>text2TextGenerationPipeline._call() : <code> Text2TextGenerationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-1gl4q1t"><strong>Kind</strong>: instance method of <a href="#module_pipelines.Text2TextGenerationPipeline"><code>Text2TextGenerationPipeline</code></a></p> <hr> <a id="module_pipelines.SummarizationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinessummarizationpipeline" 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="#pipelinessummarizationpipeline"><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.SummarizationPipeline</span></h2> <p data-svelte-h="svelte-1axdht2">A pipeline for summarization tasks, inheriting from Text2TextGenerationPipeline.</p> <p data-svelte-h="svelte-1416cqx"><strong>Example:</strong> Summarization w/ <code>Xenova/distilbart-cnn-6-6</code>.</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">const</span> generator = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'summarization'</span>, <span class="hljs-string">'Xenova/distilbart-cnn-6-6'</span>);
	<span class="hljs-keyword">const</span> text = <span class="hljs-string">'The tower is 324 metres (1,063 ft) tall, about the same height as an 81-storey building, '</span> +
	<span class="hljs-string">'and the tallest structure in Paris. Its base is square, measuring 125 metres (410 ft) on each side. '</span> +
	<span class="hljs-string">'During its construction, the Eiffel Tower surpassed the Washington Monument to become the tallest '</span> +
	<span class="hljs-string">'man-made structure in the world, a title it held for 41 years until the Chrysler Building in New '</span> +
	<span class="hljs-string">'York City was finished in 1930. It was the first structure to reach a height of 300 metres. Due to '</span> +
	<span class="hljs-string">'the addition of a broadcasting aerial at the top of the tower in 1957, it is now taller than the '</span> +
	<span class="hljs-string">'Chrysler Building by 5.2 metres (17 ft). Excluding transmitters, the Eiffel Tower is the second '</span> +
	<span class="hljs-string">'tallest free-standing structure in France after the Millau Viaduct.'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">generator</span>(text, {
	<span class="hljs-attr">max_new_tokens</span>: <span class="hljs-number">100</span>,
	});
	<span class="hljs-comment">// [{ summary_text: ' The Eiffel Tower is about the same height as an 81-storey building and the tallest structure in Paris. It is the second tallest free-standing structure in France after the Millau Viaduct.' }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-p21410"><li><a href="#module_pipelines.SummarizationPipeline">.SummarizationPipeline</a><ul><li><a href="#new_module_pipelines.SummarizationPipeline_new"><code>new SummarizationPipeline(options)</code></a></li> <li><a href="#module_pipelines.SummarizationPipeline+_key"><code>._key</code></a> : <code>’summary_text’</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.SummarizationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-summarizationpipelineoptions" 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-summarizationpipelineoptions"><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 SummarizationPipeline(options)</span></h3> <p data-svelte-h="svelte-10um6eq">Create a new SummarizationPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.SummarizationPipeline+_key" class="group"></a> <h3 class="relative group"><a id="summarizationpipelinekey--code--summarytext--code" 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="#summarizationpipelinekey--code--summarytext--code"><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>summarizationPipeline._key : <code> ’ summary_text ’ </code></span></h3> <p data-svelte-h="svelte-gx6clz"><strong>Kind</strong>: instance property of <a href="#module_pipelines.SummarizationPipeline"><code>SummarizationPipeline</code></a></p> <hr> <a id="module_pipelines.TranslationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinestranslationpipeline" 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="#pipelinestranslationpipeline"><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.TranslationPipeline</span></h2> <p data-svelte-h="svelte-3abd20">Translates text from one language to another.</p> <p data-svelte-h="svelte-1ut0vme"><strong>Example:</strong> Multilingual translation w/ <code>Xenova/nllb-200-distilled-600M</code>.</p> <p data-svelte-h="svelte-dr1wsd">See <a href="https://github.com/facebookresearch/flores/blob/main/flores200/README.md#languages-in-flores-200" rel="nofollow">here</a>
	for the full list of languages and their corresponding codes.</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">const</span> translator = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'translation'</span>, <span class="hljs-string">'Xenova/nllb-200-distilled-600M'</span>);
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">translator</span>(<span class="hljs-string">'जीवन एक चॉकलेट बॉक्स की तरह है।'</span>, {
	<span class="hljs-attr">src_lang</span>: <span class="hljs-string">'hin_Deva'</span>, <span class="hljs-comment">// Hindi</span>
	<span class="hljs-attr">tgt_lang</span>: <span class="hljs-string">'fra_Latn'</span>, <span class="hljs-comment">// French</span>
	});
	<span class="hljs-comment">// [{ translation_text: 'La vie est comme une boîte à chocolat.' }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-mqh15a"><strong>Example:</strong> Multilingual translation w/ <code>Xenova/m2m100_418M</code>.</p> <p data-svelte-h="svelte-zf4dht">See <a href="https://huggingface.co/facebook/m2m100_418M#languages-covered" rel="nofollow">here</a>
	for the full list of languages and their corresponding codes.</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">const</span> translator = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'translation'</span>, <span class="hljs-string">'Xenova/m2m100_418M'</span>);
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">translator</span>(<span class="hljs-string">'生活就像一盒巧克力。'</span>, {
	<span class="hljs-attr">src_lang</span>: <span class="hljs-string">'zh'</span>, <span class="hljs-comment">// Chinese</span>
	<span class="hljs-attr">tgt_lang</span>: <span class="hljs-string">'en'</span>, <span class="hljs-comment">// English</span>
	});
	<span class="hljs-comment">// [{ translation_text: 'Life is like a box of chocolate.' }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1877ohf"><strong>Example:</strong> Multilingual translation w/ <code>Xenova/mbart-large-50-many-to-many-mmt</code>.</p> <p data-svelte-h="svelte-1ox1juk">See <a href="https://huggingface.co/facebook/mbart-large-50-many-to-many-mmt#languages-covered" rel="nofollow">here</a>
	for the full list of languages and their corresponding codes.</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">const</span> translator = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'translation'</span>, <span class="hljs-string">'Xenova/mbart-large-50-many-to-many-mmt'</span>);
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">translator</span>(<span class="hljs-string">'संयुक्त राष्ट्र के प्रमुख का कहना है कि सीरिया में कोई सैन्य समाधान नहीं है'</span>, {
	<span class="hljs-attr">src_lang</span>: <span class="hljs-string">'hi_IN'</span>, <span class="hljs-comment">// Hindi</span>
	<span class="hljs-attr">tgt_lang</span>: <span class="hljs-string">'fr_XX'</span>, <span class="hljs-comment">// French</span>
	});
	<span class="hljs-comment">// [{ translation_text: 'Le chef des Nations affirme qu 'il n 'y a military solution in Syria.' }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-e4lxrd"><li><a href="#module_pipelines.TranslationPipeline">.TranslationPipeline</a><ul><li><a href="#new_module_pipelines.TranslationPipeline_new"><code>new TranslationPipeline(options)</code></a></li> <li><a href="#module_pipelines.TranslationPipeline+_key"><code>._key</code></a> : <code>’translation_text’</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.TranslationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-translationpipelineoptions" 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-translationpipelineoptions"><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 TranslationPipeline(options)</span></h3> <p data-svelte-h="svelte-6vg3da">Create a new TranslationPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.TranslationPipeline+_key" class="group"></a> <h3 class="relative group"><a id="translationpipelinekey--code--translationtext--code" 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="#translationpipelinekey--code--translationtext--code"><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>translationPipeline._key : <code> ’ translation_text ’ </code></span></h3> <p data-svelte-h="svelte-btu0vj"><strong>Kind</strong>: instance property of <a href="#module_pipelines.TranslationPipeline"><code>TranslationPipeline</code></a></p> <hr> <a id="module_pipelines.TextGenerationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinestextgenerationpipeline" 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="#pipelinestextgenerationpipeline"><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.TextGenerationPipeline</span></h2> <p data-svelte-h="svelte-1yek3op">Language generation pipeline using any <code>ModelWithLMHead</code> or <code>ModelForCausalLM</code>.
	This pipeline predicts the words that will follow a specified text prompt.
	NOTE: For the full list of generation parameters, see <a href="./utils/generation#module_utils/generation.GenerationConfig"><code>GenerationConfig</code></a>.</p> <p data-svelte-h="svelte-11p32pq"><strong>Example:</strong> Text generation with <code>Xenova/distilgpt2</code> (default settings).</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">const</span> generator = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'text-generation'</span>, <span class="hljs-string">'Xenova/distilgpt2'</span>);
	<span class="hljs-keyword">const</span> text = <span class="hljs-string">'I enjoy walking with my cute dog,'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">generator</span>(text);
	<span class="hljs-comment">// [{ generated_text: "I enjoy walking with my cute dog, and I love to play with the other dogs." }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1uqom1e"><strong>Example:</strong> Text generation with <code>Xenova/distilgpt2</code> (custom settings).</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">const</span> generator = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'text-generation'</span>, <span class="hljs-string">'Xenova/distilgpt2'</span>);
	<span class="hljs-keyword">const</span> text = <span class="hljs-string">'Once upon a time, there was'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">generator</span>(text, {
	<span class="hljs-attr">temperature</span>: <span class="hljs-number">2</span>,
	<span class="hljs-attr">max_new_tokens</span>: <span class="hljs-number">10</span>,
	<span class="hljs-attr">repetition_penalty</span>: <span class="hljs-number">1.5</span>,
	<span class="hljs-attr">no_repeat_ngram_size</span>: <span class="hljs-number">2</span>,
	<span class="hljs-attr">num_beams</span>: <span class="hljs-number">2</span>,
	<span class="hljs-attr">num_return_sequences</span>: <span class="hljs-number">2</span>,
	});
	<span class="hljs-comment">// [{</span>
	<span class="hljs-comment">// "generated_text": "Once upon a time, there was an abundance of information about the history and activities that"</span>
	<span class="hljs-comment">// }, {</span>
	<span class="hljs-comment">// "generated_text": "Once upon a time, there was an abundance of information about the most important and influential"</span>
	<span class="hljs-comment">// }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1a7k67n"><strong>Example:</strong> Run code generation with <code>Xenova/codegen-350M-mono</code>.</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">const</span> generator = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'text-generation'</span>, <span class="hljs-string">'Xenova/codegen-350M-mono'</span>);
	<span class="hljs-keyword">const</span> text = <span class="hljs-string">'def fib(n):'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">generator</span>(text, {
	<span class="hljs-attr">max_new_tokens</span>: <span class="hljs-number">44</span>,
	});
	<span class="hljs-comment">// [{</span>
	<span class="hljs-comment">// generated_text: 'def fib(n):\n' +</span>
	<span class="hljs-comment">// ' if n == 0:\n' +</span>
	<span class="hljs-comment">// ' return 0\n' +</span>
	<span class="hljs-comment">// ' elif n == 1:\n' +</span>
	<span class="hljs-comment">// ' return 1\n' +</span>
	<span class="hljs-comment">// ' else:\n' +</span>
	<span class="hljs-comment">// ' return fib(n-1) + fib(n-2)\n'</span>
	<span class="hljs-comment">// }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-62eu9p"><li><a href="#module_pipelines.TextGenerationPipeline">.TextGenerationPipeline</a><ul><li><a href="#new_module_pipelines.TextGenerationPipeline_new"><code>new TextGenerationPipeline(options)</code></a></li> <li><a href="#module_pipelines.TextGenerationPipeline+_call"><code>._call()</code></a> : <code>TextGenerationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.TextGenerationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-textgenerationpipelineoptions" 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-textgenerationpipelineoptions"><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 TextGenerationPipeline(options)</span></h3> <p data-svelte-h="svelte-xkrmr2">Create a new TextGenerationPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.TextGenerationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="textgenerationpipelinecall--code-textgenerationpipelinecallback-code" 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="#textgenerationpipelinecall--code-textgenerationpipelinecallback-code"><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>textGenerationPipeline._call() : <code> TextGenerationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-mbcfab"><strong>Kind</strong>: instance method of <a href="#module_pipelines.TextGenerationPipeline"><code>TextGenerationPipeline</code></a></p> <hr> <a id="module_pipelines.ZeroShotClassificationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelineszeroshotclassificationpipeline" 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="#pipelineszeroshotclassificationpipeline"><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.ZeroShotClassificationPipeline</span></h2> <p data-svelte-h="svelte-104v5zf">NLI-based zero-shot classification pipeline using a <code>ModelForSequenceClassification</code>
	trained on NLI (natural language inference) tasks. Equivalent of <code>text-classification</code>
	pipelines, but these models don’t require a hardcoded number of potential classes, they
	can be chosen at runtime. It usually means it’s slower but it is <strong>much</strong> more flexible.</p> <p data-svelte-h="svelte-17n9q32"><strong>Example:</strong> Zero shot classification with <code>Xenova/mobilebert-uncased-mnli</code>.</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'zero-shot-classification'</span>, <span class="hljs-string">'Xenova/mobilebert-uncased-mnli'</span>);
	<span class="hljs-keyword">const</span> text = <span class="hljs-string">'Last week I upgraded my iOS version and ever since then my phone has been overheating whenever I use your app.'</span>;
	<span class="hljs-keyword">const</span> labels = [ <span class="hljs-string">'mobile'</span>, <span class="hljs-string">'billing'</span>, <span class="hljs-string">'website'</span>, <span class="hljs-string">'account access'</span> ];
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(text, labels);
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// sequence: 'Last week I upgraded my iOS version and ever since then my phone has been overheating whenever I use your app.',</span>
	<span class="hljs-comment">// labels: [ 'mobile', 'website', 'billing', 'account access' ],</span>
	<span class="hljs-comment">// scores: [ 0.5562091040482018, 0.1843621307860853, 0.13942646639336376, 0.12000229877234923 ]</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-v99qry"><strong>Example:</strong> Zero shot classification with <code>Xenova/nli-deberta-v3-xsmall</code> (multi-label).</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'zero-shot-classification'</span>, <span class="hljs-string">'Xenova/nli-deberta-v3-xsmall'</span>);
	<span class="hljs-keyword">const</span> text = <span class="hljs-string">'I have a problem with my iphone that needs to be resolved asap!'</span>;
	<span class="hljs-keyword">const</span> labels = [ <span class="hljs-string">'urgent'</span>, <span class="hljs-string">'not urgent'</span>, <span class="hljs-string">'phone'</span>, <span class="hljs-string">'tablet'</span>, <span class="hljs-string">'computer'</span> ];
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(text, labels, { <span class="hljs-attr">multi_label</span>: <span class="hljs-literal">true</span> });
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// sequence: 'I have a problem with my iphone that needs to be resolved asap!',</span>
	<span class="hljs-comment">// labels: [ 'urgent', 'phone', 'computer', 'tablet', 'not urgent' ],</span>
	<span class="hljs-comment">// scores: [ 0.9958870956360275, 0.9923963400697035, 0.002333537946160235, 0.0015134138567598765, 0.0010699384208377163 ]</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-19ik76h"><li><a href="#module_pipelines.ZeroShotClassificationPipeline">.ZeroShotClassificationPipeline</a><ul><li><a href="#new_module_pipelines.ZeroShotClassificationPipeline_new"><code>new ZeroShotClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ZeroShotClassificationPipeline+model"><code>.model</code></a> : <code>any</code></li> <li><a href="#module_pipelines.ZeroShotClassificationPipeline+_call"><code>._call()</code></a> : <code>ZeroShotClassificationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ZeroShotClassificationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-zeroshotclassificationpipelineoptions" 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-zeroshotclassificationpipelineoptions"><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 ZeroShotClassificationPipeline(options)</span></h3> <p data-svelte-h="svelte-1n1xlcl">Create a new ZeroShotClassificationPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ZeroShotClassificationPipeline+model" class="group"></a> <h3 class="relative group"><a id="zeroshotclassificationpipelinemodel--code-any-code" 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="#zeroshotclassificationpipelinemodel--code-any-code"><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>zeroShotClassificationPipeline.model : <code> any </code></span></h3> <p data-svelte-h="svelte-u37gsd"><strong>Kind</strong>: instance property of <a href="#module_pipelines.ZeroShotClassificationPipeline"><code>ZeroShotClassificationPipeline</code></a></p> <hr> <a id="module_pipelines.ZeroShotClassificationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="zeroshotclassificationpipelinecall--code-zeroshotclassificationpipelinecallback-code" 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="#zeroshotclassificationpipelinecall--code-zeroshotclassificationpipelinecallback-code"><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>zeroShotClassificationPipeline._call() : <code> ZeroShotClassificationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-1ud8h4r"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ZeroShotClassificationPipeline"><code>ZeroShotClassificationPipeline</code></a></p> <hr> <a id="module_pipelines.FeatureExtractionPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesfeatureextractionpipeline" 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="#pipelinesfeatureextractionpipeline"><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.FeatureExtractionPipeline</span></h2> <p data-svelte-h="svelte-tzucv0">Feature extraction pipeline using no model head. This pipeline extracts the hidden
	states from the base transformer, which can be used as features in downstream tasks.</p> <p data-svelte-h="svelte-zrdgvs"><strong>Example:</strong> Run feature extraction with <code>bert-base-uncased</code> (without pooling/normalization).</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">const</span> extractor = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'feature-extraction'</span>, <span class="hljs-string">'Xenova/bert-base-uncased'</span>, { <span class="hljs-attr">revision</span>: <span class="hljs-string">'default'</span> });
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">extractor</span>(<span class="hljs-string">'This is a simple test.'</span>);
	<span class="hljs-comment">// Tensor {</span>
	<span class="hljs-comment">// type: 'float32',</span>
	<span class="hljs-comment">// data: Float32Array [0.05939924716949463, 0.021655935794115067, ...],</span>
	<span class="hljs-comment">// dims: [1, 8, 768]</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-et9i9m"><strong>Example:</strong> Run feature extraction with <code>bert-base-uncased</code> (with pooling/normalization).</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">const</span> extractor = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'feature-extraction'</span>, <span class="hljs-string">'Xenova/bert-base-uncased'</span>, { <span class="hljs-attr">revision</span>: <span class="hljs-string">'default'</span> });
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">extractor</span>(<span class="hljs-string">'This is a simple test.'</span>, { <span class="hljs-attr">pooling</span>: <span class="hljs-string">'mean'</span>, <span class="hljs-attr">normalize</span>: <span class="hljs-literal">true</span> });
	<span class="hljs-comment">// Tensor {</span>
	<span class="hljs-comment">// type: 'float32',</span>
	<span class="hljs-comment">// data: Float32Array [0.03373778983950615, -0.010106077417731285, ...],</span>
	<span class="hljs-comment">// dims: [1, 768]</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-162t9ct"><strong>Example:</strong> Calculating embeddings with <code>sentence-transformers</code> models.</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">const</span> extractor = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'feature-extraction'</span>, <span class="hljs-string">'Xenova/all-MiniLM-L6-v2'</span>);
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">extractor</span>(<span class="hljs-string">'This is a simple test.'</span>, { <span class="hljs-attr">pooling</span>: <span class="hljs-string">'mean'</span>, <span class="hljs-attr">normalize</span>: <span class="hljs-literal">true</span> });
	<span class="hljs-comment">// Tensor {</span>
	<span class="hljs-comment">// type: 'float32',</span>
	<span class="hljs-comment">// data: Float32Array [0.09094982594251633, -0.014774246141314507, ...],</span>
	<span class="hljs-comment">// dims: [1, 384]</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1kus3j4"><strong>Example:</strong> Calculating binary embeddings with <code>sentence-transformers</code> models.</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">const</span> extractor = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'feature-extraction'</span>, <span class="hljs-string">'Xenova/all-MiniLM-L6-v2'</span>);
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">extractor</span>(<span class="hljs-string">'This is a simple test.'</span>, { <span class="hljs-attr">pooling</span>: <span class="hljs-string">'mean'</span>, <span class="hljs-attr">quantize</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">precision</span>: <span class="hljs-string">'binary'</span> });
	<span class="hljs-comment">// Tensor {</span>
	<span class="hljs-comment">// type: 'int8',</span>
	<span class="hljs-comment">// data: Int8Array [49, 108, 24, ...],</span>
	<span class="hljs-comment">// dims: [1, 48]</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-10y93z3"><li><a href="#module_pipelines.FeatureExtractionPipeline">.FeatureExtractionPipeline</a><ul><li><a href="#new_module_pipelines.FeatureExtractionPipeline_new"><code>new FeatureExtractionPipeline(options)</code></a></li> <li><a href="#module_pipelines.FeatureExtractionPipeline+_call"><code>._call()</code></a> : <code>FeatureExtractionPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.FeatureExtractionPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-featureextractionpipelineoptions" 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-featureextractionpipelineoptions"><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 FeatureExtractionPipeline(options)</span></h3> <p data-svelte-h="svelte-8oqlmq">Create a new FeatureExtractionPipeline.</p> <table data-svelte-h="svelte-1iu6wl4"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.FeatureExtractionPipeline+_call" class="group"></a> <h3 class="relative group"><a id="featureextractionpipelinecall--code-featureextractionpipelinecallback-code" 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="#featureextractionpipelinecall--code-featureextractionpipelinecallback-code"><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>featureExtractionPipeline._call() : <code> FeatureExtractionPipelineCallback </code></span></h3> <p data-svelte-h="svelte-s9g0sr"><strong>Kind</strong>: instance method of <a href="#module_pipelines.FeatureExtractionPipeline"><code>FeatureExtractionPipeline</code></a></p> <hr> <a id="module_pipelines.ImageFeatureExtractionPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesimagefeatureextractionpipeline" 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="#pipelinesimagefeatureextractionpipeline"><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.ImageFeatureExtractionPipeline</span></h2> <p data-svelte-h="svelte-z5i7j9">Image feature extraction pipeline using no model head. This pipeline extracts the hidden
	states from the base transformer, which can be used as features in downstream tasks.</p> <p data-svelte-h="svelte-n063y1"><strong>Example:</strong> Perform image feature extraction with <code>Xenova/vit-base-patch16-224-in21k</code>.</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">const</span> image_feature_extractor = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'image-feature-extraction'</span>, <span class="hljs-string">'Xenova/vit-base-patch16-224-in21k'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/cats.png'</span>;
	<span class="hljs-keyword">const</span> features = <span class="hljs-keyword">await</span> <span class="hljs-title function_">image_feature_extractor</span>(url);
	<span class="hljs-comment">// Tensor {</span>
	<span class="hljs-comment">// dims: [ 1, 197, 768 ],</span>
	<span class="hljs-comment">// type: 'float32',</span>
	<span class="hljs-comment">// data: Float32Array(151296) [ ... ],</span>
	<span class="hljs-comment">// size: 151296</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-49jj6i"><strong>Example:</strong> Compute image embeddings with <code>Xenova/clip-vit-base-patch32</code>.</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">const</span> image_feature_extractor = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'image-feature-extraction'</span>, <span class="hljs-string">'Xenova/clip-vit-base-patch32'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/cats.png'</span>;
	<span class="hljs-keyword">const</span> features = <span class="hljs-keyword">await</span> <span class="hljs-title function_">image_feature_extractor</span>(url);
	<span class="hljs-comment">// Tensor {</span>
	<span class="hljs-comment">// dims: [ 1, 512 ],</span>
	<span class="hljs-comment">// type: 'float32',</span>
	<span class="hljs-comment">// data: Float32Array(512) [ ... ],</span>
	<span class="hljs-comment">// size: 512</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-1x41tbl"><li><a href="#module_pipelines.ImageFeatureExtractionPipeline">.ImageFeatureExtractionPipeline</a><ul><li><a href="#new_module_pipelines.ImageFeatureExtractionPipeline_new"><code>new ImageFeatureExtractionPipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageFeatureExtractionPipeline+_call"><code>._call()</code></a> : <code>ImageFeatureExtractionPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ImageFeatureExtractionPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-imagefeatureextractionpipelineoptions" 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-imagefeatureextractionpipelineoptions"><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 ImageFeatureExtractionPipeline(options)</span></h3> <p data-svelte-h="svelte-1vowjv7">Create a new ImageFeatureExtractionPipeline.</p> <table data-svelte-h="svelte-uwryka"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>ImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ImageFeatureExtractionPipeline+_call" class="group"></a> <h3 class="relative group"><a id="imagefeatureextractionpipelinecall--code-imagefeatureextractionpipelinecallback-code" 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="#imagefeatureextractionpipelinecall--code-imagefeatureextractionpipelinecallback-code"><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>imageFeatureExtractionPipeline._call() : <code> ImageFeatureExtractionPipelineCallback </code></span></h3> <p data-svelte-h="svelte-1m120x7"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ImageFeatureExtractionPipeline"><code>ImageFeatureExtractionPipeline</code></a></p> <hr> <a id="module_pipelines.AudioClassificationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesaudioclassificationpipeline" 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="#pipelinesaudioclassificationpipeline"><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.AudioClassificationPipeline</span></h2> <p data-svelte-h="svelte-9xhkxa">Audio classification pipeline using any <code>AutoModelForAudioClassification</code>.
	This pipeline predicts the class of a raw waveform or an audio file.</p> <p data-svelte-h="svelte-11cz03b"><strong>Example:</strong> Perform audio classification with <code>Xenova/wav2vec2-large-xlsr-53-gender-recognition-librispeech</code>.</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'audio-classification'</span>, <span class="hljs-string">'Xenova/wav2vec2-large-xlsr-53-gender-recognition-librispeech'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/jfk.wav'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(url);
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { label: 'male', score: 0.9981542229652405 },</span>
	<span class="hljs-comment">// { label: 'female', score: 0.001845747814513743 }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1mkx6vp"><strong>Example:</strong> Perform audio classification with <code>Xenova/ast-finetuned-audioset-10-10-0.4593</code> and return top 4 results.</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'audio-classification'</span>, <span class="hljs-string">'Xenova/ast-finetuned-audioset-10-10-0.4593'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/cat_meow.wav'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(url, { <span class="hljs-attr">top_k</span>: <span class="hljs-number">4</span> });
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { label: 'Meow', score: 0.5617874264717102 },</span>
	<span class="hljs-comment">// { label: 'Cat', score: 0.22365376353263855 },</span>
	<span class="hljs-comment">// { label: 'Domestic animals, pets', score: 0.1141069084405899 },</span>
	<span class="hljs-comment">// { label: 'Animal', score: 0.08985692262649536 },</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-7knu0l"><li><a href="#module_pipelines.AudioClassificationPipeline">.AudioClassificationPipeline</a><ul><li><a href="#new_module_pipelines.AudioClassificationPipeline_new"><code>new AudioClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.AudioClassificationPipeline+_call"><code>._call()</code></a> : <code>AudioClassificationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.AudioClassificationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-audioclassificationpipelineoptions" 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-audioclassificationpipelineoptions"><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 AudioClassificationPipeline(options)</span></h3> <p data-svelte-h="svelte-1enract">Create a new AudioClassificationPipeline.</p> <table data-svelte-h="svelte-1u0ywjh"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>AudioPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.AudioClassificationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="audioclassificationpipelinecall--code-audioclassificationpipelinecallback-code" 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="#audioclassificationpipelinecall--code-audioclassificationpipelinecallback-code"><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>audioClassificationPipeline._call() : <code> AudioClassificationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-di1dc5"><strong>Kind</strong>: instance method of <a href="#module_pipelines.AudioClassificationPipeline"><code>AudioClassificationPipeline</code></a></p> <hr> <a id="module_pipelines.ZeroShotAudioClassificationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelineszeroshotaudioclassificationpipeline" 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="#pipelineszeroshotaudioclassificationpipeline"><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.ZeroShotAudioClassificationPipeline</span></h2> <p data-svelte-h="svelte-tmg4zt">Zero shot audio classification pipeline using <code>ClapModel</code>. This pipeline predicts the class of an audio when you
	provide an audio and a set of <code>candidate_labels</code>.</p> <p data-svelte-h="svelte-em947q"><strong>Example</strong>: Perform zero-shot audio classification with <code>Xenova/clap-htsat-unfused</code>.</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'zero-shot-audio-classification'</span>, <span class="hljs-string">'Xenova/clap-htsat-unfused'</span>);
	<span class="hljs-keyword">const</span> audio = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/dog_barking.wav'</span>;
	<span class="hljs-keyword">const</span> candidate_labels = [<span class="hljs-string">'dog'</span>, <span class="hljs-string">'vaccum cleaner'</span>];
	<span class="hljs-keyword">const</span> scores = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(audio, candidate_labels);
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { score: 0.9993992447853088, label: 'dog' },</span>
	<span class="hljs-comment">// { score: 0.0006007603369653225, label: 'vaccum cleaner' }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-1qhhd61"><li><a href="#module_pipelines.ZeroShotAudioClassificationPipeline">.ZeroShotAudioClassificationPipeline</a><ul><li><a href="#new_module_pipelines.ZeroShotAudioClassificationPipeline_new"><code>new ZeroShotAudioClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ZeroShotAudioClassificationPipeline+_call"><code>._call()</code></a> : <code>ZeroShotAudioClassificationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ZeroShotAudioClassificationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-zeroshotaudioclassificationpipelineoptions" 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-zeroshotaudioclassificationpipelineoptions"><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 ZeroShotAudioClassificationPipeline(options)</span></h3> <p data-svelte-h="svelte-1edlvjn">Create a new ZeroShotAudioClassificationPipeline.</p> <table data-svelte-h="svelte-t7irm8"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextAudioPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ZeroShotAudioClassificationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="zeroshotaudioclassificationpipelinecall--code-zeroshotaudioclassificationpipelinecallback-code" 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="#zeroshotaudioclassificationpipelinecall--code-zeroshotaudioclassificationpipelinecallback-code"><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>zeroShotAudioClassificationPipeline._call() : <code> ZeroShotAudioClassificationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-1cetnsf"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ZeroShotAudioClassificationPipeline"><code>ZeroShotAudioClassificationPipeline</code></a></p> <hr> <a id="module_pipelines.AutomaticSpeechRecognitionPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesautomaticspeechrecognitionpipeline" 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="#pipelinesautomaticspeechrecognitionpipeline"><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.AutomaticSpeechRecognitionPipeline</span></h2> <p data-svelte-h="svelte-vm8asa">Pipeline that aims at extracting spoken text contained within some audio.</p> <p data-svelte-h="svelte-p9nqmy"><strong>Example:</strong> Transcribe English.</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">const</span> transcriber = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'automatic-speech-recognition'</span>, <span class="hljs-string">'Xenova/whisper-tiny.en'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/jfk.wav'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">transcriber</span>(url);
	<span class="hljs-comment">// { text: " And so my fellow Americans ask not what your country can do for you, ask what you can do for your country." }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1xb4yln"><strong>Example:</strong> Transcribe English w/ timestamps.</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">const</span> transcriber = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'automatic-speech-recognition'</span>, <span class="hljs-string">'Xenova/whisper-tiny.en'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/jfk.wav'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">transcriber</span>(url, { <span class="hljs-attr">return_timestamps</span>: <span class="hljs-literal">true</span> });
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// text: " And so my fellow Americans ask not what your country can do for you, ask what you can do for your country."</span>
	<span class="hljs-comment">// chunks: [</span>
	<span class="hljs-comment">// { timestamp: [0, 8], text: " And so my fellow Americans ask not what your country can do for you" }</span>
	<span class="hljs-comment">// { timestamp: [8, 11], text: " ask what you can do for your country." }</span>
	<span class="hljs-comment">// ]</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-aly754"><strong>Example:</strong> Transcribe English w/ word-level timestamps.</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">const</span> transcriber = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'automatic-speech-recognition'</span>, <span class="hljs-string">'Xenova/whisper-tiny.en'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/jfk.wav'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">transcriber</span>(url, { <span class="hljs-attr">return_timestamps</span>: <span class="hljs-string">'word'</span> });
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// "text": " And so my fellow Americans ask not what your country can do for you ask what you can do for your country.",</span>
	<span class="hljs-comment">// "chunks": [</span>
	<span class="hljs-comment">// { "text": " And", "timestamp": [0, 0.78] },</span>
	<span class="hljs-comment">// { "text": " so", "timestamp": [0.78, 1.06] },</span>
	<span class="hljs-comment">// { "text": " my", "timestamp": [1.06, 1.46] },</span>
	<span class="hljs-comment">// ...</span>
	<span class="hljs-comment">// { "text": " for", "timestamp": [9.72, 9.92] },</span>
	<span class="hljs-comment">// { "text": " your", "timestamp": [9.92, 10.22] },</span>
	<span class="hljs-comment">// { "text": " country.", "timestamp": [10.22, 13.5] }</span>
	<span class="hljs-comment">// ]</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-127z1r2"><strong>Example:</strong> Transcribe French.</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">const</span> transcriber = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'automatic-speech-recognition'</span>, <span class="hljs-string">'Xenova/whisper-small'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/french-audio.mp3'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">transcriber</span>(url, { <span class="hljs-attr">language</span>: <span class="hljs-string">'french'</span>, <span class="hljs-attr">task</span>: <span class="hljs-string">'transcribe'</span> });
	<span class="hljs-comment">// { text: " J'adore, j'aime, je n'aime pas, je déteste." }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-5ad2vc"><strong>Example:</strong> Translate French to English.</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">const</span> transcriber = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'automatic-speech-recognition'</span>, <span class="hljs-string">'Xenova/whisper-small'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/french-audio.mp3'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">transcriber</span>(url, { <span class="hljs-attr">language</span>: <span class="hljs-string">'french'</span>, <span class="hljs-attr">task</span>: <span class="hljs-string">'translate'</span> });
	<span class="hljs-comment">// { text: " I love, I like, I don't like, I hate." }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1ybp4y9"><strong>Example:</strong> Transcribe/translate audio longer than 30 seconds.</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">const</span> transcriber = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'automatic-speech-recognition'</span>, <span class="hljs-string">'Xenova/whisper-tiny.en'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/ted_60.wav'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">transcriber</span>(url, { <span class="hljs-attr">chunk_length_s</span>: <span class="hljs-number">30</span>, <span class="hljs-attr">stride_length_s</span>: <span class="hljs-number">5</span> });
	<span class="hljs-comment">// { text: " So in college, I was a government major, which means [...] So I'd start off light and I'd bump it up" }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-257cyp"><li><a href="#module_pipelines.AutomaticSpeechRecognitionPipeline">.AutomaticSpeechRecognitionPipeline</a><ul><li><a href="#new_module_pipelines.AutomaticSpeechRecognitionPipeline_new"><code>new AutomaticSpeechRecognitionPipeline(options)</code></a></li> <li><a href="#module_pipelines.AutomaticSpeechRecognitionPipeline+_call"><code>._call()</code></a> : <code>AutomaticSpeechRecognitionPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.AutomaticSpeechRecognitionPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-automaticspeechrecognitionpipelineoptions" 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-automaticspeechrecognitionpipelineoptions"><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 AutomaticSpeechRecognitionPipeline(options)</span></h3> <p data-svelte-h="svelte-1kkefov">Create a new AutomaticSpeechRecognitionPipeline.</p> <table data-svelte-h="svelte-t7irm8"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextAudioPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.AutomaticSpeechRecognitionPipeline+_call" class="group"></a> <h3 class="relative group"><a id="automaticspeechrecognitionpipelinecall--code-automaticspeechrecognitionpipelinecallback-code" 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="#automaticspeechrecognitionpipelinecall--code-automaticspeechrecognitionpipelinecallback-code"><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>automaticSpeechRecognitionPipeline._call() : <code> AutomaticSpeechRecognitionPipelineCallback </code></span></h3> <p data-svelte-h="svelte-i1526d"><strong>Kind</strong>: instance method of <a href="#module_pipelines.AutomaticSpeechRecognitionPipeline"><code>AutomaticSpeechRecognitionPipeline</code></a></p> <hr> <a id="module_pipelines.ImageToTextPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesimagetotextpipeline" 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="#pipelinesimagetotextpipeline"><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.ImageToTextPipeline</span></h2> <p data-svelte-h="svelte-yuzbfo">Image To Text pipeline using a <code>AutoModelForVision2Seq</code>. This pipeline predicts a caption for a given image.</p> <p data-svelte-h="svelte-gwolyd"><strong>Example:</strong> Generate a caption for an image w/ <code>Xenova/vit-gpt2-image-captioning</code>.</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">const</span> captioner = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'image-to-text'</span>, <span class="hljs-string">'Xenova/vit-gpt2-image-captioning'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/cats.jpg'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">captioner</span>(url);
	<span class="hljs-comment">// [{ generated_text: 'a cat laying on a couch with another cat' }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-vvjehq"><strong>Example:</strong> Optical Character Recognition (OCR) w/ <code>Xenova/trocr-small-handwritten</code>.</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">const</span> captioner = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'image-to-text'</span>, <span class="hljs-string">'Xenova/trocr-small-handwritten'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/handwriting.jpg'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">captioner</span>(url);
	<span class="hljs-comment">// [{ generated_text: 'Mr. Brown commented icily.' }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-14lg7tf"><li><a href="#module_pipelines.ImageToTextPipeline">.ImageToTextPipeline</a><ul><li><a href="#new_module_pipelines.ImageToTextPipeline_new"><code>new ImageToTextPipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageToTextPipeline+_call"><code>._call()</code></a> : <code>ImageToTextPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ImageToTextPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-imagetotextpipelineoptions" 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-imagetotextpipelineoptions"><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 ImageToTextPipeline(options)</span></h3> <p data-svelte-h="svelte-10qze5e">Create a new ImageToTextPipeline.</p> <table data-svelte-h="svelte-1r7ciun"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ImageToTextPipeline+_call" class="group"></a> <h3 class="relative group"><a id="imagetotextpipelinecall--code-imagetotextpipelinecallback-code" 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="#imagetotextpipelinecall--code-imagetotextpipelinecallback-code"><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>imageToTextPipeline._call() : <code> ImageToTextPipelineCallback </code></span></h3> <p data-svelte-h="svelte-tnura3"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ImageToTextPipeline"><code>ImageToTextPipeline</code></a></p> <hr> <a id="module_pipelines.ImageClassificationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesimageclassificationpipeline" 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="#pipelinesimageclassificationpipeline"><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.ImageClassificationPipeline</span></h2> <p data-svelte-h="svelte-w5osnc">Image classification pipeline using any <code>AutoModelForImageClassification</code>.
	This pipeline predicts the class of an image.</p> <p data-svelte-h="svelte-1h4310j"><strong>Example:</strong> Classify an image.</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'image-classification'</span>, <span class="hljs-string">'Xenova/vit-base-patch16-224'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/tiger.jpg'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(url);
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { label: 'tiger, Panthera tigris', score: 0.632695734500885 },</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-xv6hak"><strong>Example:</strong> Classify an image and return top <code>n</code> classes.</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'image-classification'</span>, <span class="hljs-string">'Xenova/vit-base-patch16-224'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/tiger.jpg'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(url, { <span class="hljs-attr">top_k</span>: <span class="hljs-number">3</span> });
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { label: 'tiger, Panthera tigris', score: 0.632695734500885 },</span>
	<span class="hljs-comment">// { label: 'tiger cat', score: 0.3634825646877289 },</span>
	<span class="hljs-comment">// { label: 'lion, king of beasts, Panthera leo', score: 0.00045060308184474707 },</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1ids6l"><strong>Example:</strong> Classify an image and return all classes.</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'image-classification'</span>, <span class="hljs-string">'Xenova/vit-base-patch16-224'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/tiger.jpg'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(url, { <span class="hljs-attr">top_k</span>: <span class="hljs-number">0</span> });
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { label: 'tiger, Panthera tigris', score: 0.632695734500885 },</span>
	<span class="hljs-comment">// { label: 'tiger cat', score: 0.3634825646877289 },</span>
	<span class="hljs-comment">// { label: 'lion, king of beasts, Panthera leo', score: 0.00045060308184474707 },</span>
	<span class="hljs-comment">// { label: 'jaguar, panther, Panthera onca, Felis onca', score: 0.00035465499968267977 },</span>
	<span class="hljs-comment">// ...</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-1xz2p9v"><li><a href="#module_pipelines.ImageClassificationPipeline">.ImageClassificationPipeline</a><ul><li><a href="#new_module_pipelines.ImageClassificationPipeline_new"><code>new ImageClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageClassificationPipeline+_call"><code>._call()</code></a> : <code>ImageClassificationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ImageClassificationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-imageclassificationpipelineoptions" 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-imageclassificationpipelineoptions"><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 ImageClassificationPipeline(options)</span></h3> <p data-svelte-h="svelte-71b02w">Create a new ImageClassificationPipeline.</p> <table data-svelte-h="svelte-uwryka"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>ImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ImageClassificationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="imageclassificationpipelinecall--code-imageclassificationpipelinecallback-code" 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="#imageclassificationpipelinecall--code-imageclassificationpipelinecallback-code"><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>imageClassificationPipeline._call() : <code> ImageClassificationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-1jslpvf"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ImageClassificationPipeline"><code>ImageClassificationPipeline</code></a></p> <hr> <a id="module_pipelines.ImageSegmentationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesimagesegmentationpipeline" 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="#pipelinesimagesegmentationpipeline"><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.ImageSegmentationPipeline</span></h2> <p data-svelte-h="svelte-1rwi35s">Image segmentation pipeline using any <code>AutoModelForXXXSegmentation</code>.
	This pipeline predicts masks of objects and their classes.</p> <p data-svelte-h="svelte-1tpbwb6"><strong>Example:</strong> Perform image segmentation with <code>Xenova/detr-resnet-50-panoptic</code>.</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">const</span> segmenter = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'image-segmentation'</span>, <span class="hljs-string">'Xenova/detr-resnet-50-panoptic'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/cats.jpg'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">segmenter</span>(url);
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { label: 'remote', score: 0.9984649419784546, mask: RawImage { ... } },</span>
	<span class="hljs-comment">// { label: 'cat', score: 0.9994316101074219, mask: RawImage { ... } }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-1rarq13"><li><a href="#module_pipelines.ImageSegmentationPipeline">.ImageSegmentationPipeline</a><ul><li><a href="#new_module_pipelines.ImageSegmentationPipeline_new"><code>new ImageSegmentationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageSegmentationPipeline+_call"><code>._call()</code></a> : <code>ImageSegmentationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ImageSegmentationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-imagesegmentationpipelineoptions" 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-imagesegmentationpipelineoptions"><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 ImageSegmentationPipeline(options)</span></h3> <p data-svelte-h="svelte-1ctgtyq">Create a new ImageSegmentationPipeline.</p> <table data-svelte-h="svelte-uwryka"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>ImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ImageSegmentationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="imagesegmentationpipelinecall--code-imagesegmentationpipelinecallback-code" 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="#imagesegmentationpipelinecall--code-imagesegmentationpipelinecallback-code"><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>imageSegmentationPipeline._call() : <code> ImageSegmentationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-1ql34f7"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ImageSegmentationPipeline"><code>ImageSegmentationPipeline</code></a></p> <hr> <a id="module_pipelines.ZeroShotImageClassificationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelineszeroshotimageclassificationpipeline" 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="#pipelineszeroshotimageclassificationpipeline"><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.ZeroShotImageClassificationPipeline</span></h2> <p data-svelte-h="svelte-20dgme">Zero shot image classification pipeline. This pipeline predicts the class of
	an image when you provide an image and a set of <code>candidate_labels</code>.</p> <p data-svelte-h="svelte-eob2i5"><strong>Example:</strong> Zero shot image classification w/ <code>Xenova/clip-vit-base-patch32</code>.</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">const</span> classifier = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'zero-shot-image-classification'</span>, <span class="hljs-string">'Xenova/clip-vit-base-patch32'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/tiger.jpg'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">classifier</span>(url, [<span class="hljs-string">'tiger'</span>, <span class="hljs-string">'horse'</span>, <span class="hljs-string">'dog'</span>]);
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// { score: 0.9993917942047119, label: 'tiger' },</span>
	<span class="hljs-comment">// { score: 0.0003519294841680676, label: 'horse' },</span>
	<span class="hljs-comment">// { score: 0.0002562698791734874, label: 'dog' }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-ej6a5r"><li><a href="#module_pipelines.ZeroShotImageClassificationPipeline">.ZeroShotImageClassificationPipeline</a><ul><li><a href="#new_module_pipelines.ZeroShotImageClassificationPipeline_new"><code>new ZeroShotImageClassificationPipeline(options)</code></a></li> <li><a href="#module_pipelines.ZeroShotImageClassificationPipeline+_call"><code>._call()</code></a> : <code>ZeroShotImageClassificationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ZeroShotImageClassificationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-zeroshotimageclassificationpipelineoptions" 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-zeroshotimageclassificationpipelineoptions"><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 ZeroShotImageClassificationPipeline(options)</span></h3> <p data-svelte-h="svelte-3wys82">Create a new ZeroShotImageClassificationPipeline.</p> <table data-svelte-h="svelte-1r7ciun"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ZeroShotImageClassificationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="zeroshotimageclassificationpipelinecall--code-zeroshotimageclassificationpipelinecallback-code" 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="#zeroshotimageclassificationpipelinecall--code-zeroshotimageclassificationpipelinecallback-code"><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>zeroShotImageClassificationPipeline._call() : <code> ZeroShotImageClassificationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-2y0z4b"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ZeroShotImageClassificationPipeline"><code>ZeroShotImageClassificationPipeline</code></a></p> <hr> <a id="module_pipelines.ObjectDetectionPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesobjectdetectionpipeline" 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="#pipelinesobjectdetectionpipeline"><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.ObjectDetectionPipeline</span></h2> <p data-svelte-h="svelte-11wm84h">Object detection pipeline using any <code>AutoModelForObjectDetection</code>.
	This pipeline predicts bounding boxes of objects and their classes.</p> <p data-svelte-h="svelte-tf175f"><strong>Example:</strong> Run object-detection with <code>Xenova/detr-resnet-50</code>.</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">const</span> detector = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'object-detection'</span>, <span class="hljs-string">'Xenova/detr-resnet-50'</span>);
	<span class="hljs-keyword">const</span> img = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/cats.jpg'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">detector</span>(img, { <span class="hljs-attr">threshold</span>: <span class="hljs-number">0.9</span> });
	<span class="hljs-comment">// [{</span>
	<span class="hljs-comment">// score: 0.9976370930671692,</span>
	<span class="hljs-comment">// label: "remote",</span>
	<span class="hljs-comment">// box: { xmin: 31, ymin: 68, xmax: 190, ymax: 118 }</span>
	<span class="hljs-comment">// },</span>
	<span class="hljs-comment">// ...</span>
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// score: 0.9984092116355896,</span>
	<span class="hljs-comment">// label: "cat",</span>
	<span class="hljs-comment">// box: { xmin: 331, ymin: 19, xmax: 649, ymax: 371 }</span>
	<span class="hljs-comment">// }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-b3ue47"><li><a href="#module_pipelines.ObjectDetectionPipeline">.ObjectDetectionPipeline</a><ul><li><a href="#new_module_pipelines.ObjectDetectionPipeline_new"><code>new ObjectDetectionPipeline(options)</code></a></li> <li><a href="#module_pipelines.ObjectDetectionPipeline+_call"><code>._call()</code></a> : <code>ObjectDetectionPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ObjectDetectionPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-objectdetectionpipelineoptions" 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-objectdetectionpipelineoptions"><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 ObjectDetectionPipeline(options)</span></h3> <p data-svelte-h="svelte-1la8w69">Create a new ObjectDetectionPipeline.</p> <table data-svelte-h="svelte-uwryka"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>ImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ObjectDetectionPipeline+_call" class="group"></a> <h3 class="relative group"><a id="objectdetectionpipelinecall--code-objectdetectionpipelinecallback-code" 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="#objectdetectionpipelinecall--code-objectdetectionpipelinecallback-code"><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>objectDetectionPipeline._call() : <code> ObjectDetectionPipelineCallback </code></span></h3> <p data-svelte-h="svelte-i9mudt"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ObjectDetectionPipeline"><code>ObjectDetectionPipeline</code></a></p> <hr> <a id="module_pipelines.ZeroShotObjectDetectionPipeline" class="group"></a> <h2 class="relative group"><a id="pipelineszeroshotobjectdetectionpipeline" 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="#pipelineszeroshotobjectdetectionpipeline"><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.ZeroShotObjectDetectionPipeline</span></h2> <p data-svelte-h="svelte-1hdoc64">Zero-shot object detection pipeline. This pipeline predicts bounding boxes of
	objects when you provide an image and a set of <code>candidate_labels</code>.</p> <p data-svelte-h="svelte-yw3rra"><strong>Example:</strong> Zero-shot object detection w/ <code>Xenova/owlvit-base-patch32</code>.</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">const</span> detector = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'zero-shot-object-detection'</span>, <span class="hljs-string">'Xenova/owlvit-base-patch32'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/astronaut.png'</span>;
	<span class="hljs-keyword">const</span> candidate_labels = [<span class="hljs-string">'human face'</span>, <span class="hljs-string">'rocket'</span>, <span class="hljs-string">'helmet'</span>, <span class="hljs-string">'american flag'</span>];
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">detector</span>(url, candidate_labels);
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// score: 0.24392342567443848,</span>
	<span class="hljs-comment">// label: 'human face',</span>
	<span class="hljs-comment">// box: { xmin: 180, ymin: 67, xmax: 274, ymax: 175 }</span>
	<span class="hljs-comment">// },</span>
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// score: 0.15129457414150238,</span>
	<span class="hljs-comment">// label: 'american flag',</span>
	<span class="hljs-comment">// box: { xmin: 0, ymin: 4, xmax: 106, ymax: 513 }</span>
	<span class="hljs-comment">// },</span>
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// score: 0.13649864494800568,</span>
	<span class="hljs-comment">// label: 'helmet',</span>
	<span class="hljs-comment">// box: { xmin: 277, ymin: 337, xmax: 511, ymax: 511 }</span>
	<span class="hljs-comment">// },</span>
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// score: 0.10262022167444229,</span>
	<span class="hljs-comment">// label: 'rocket',</span>
	<span class="hljs-comment">// box: { xmin: 352, ymin: -1, xmax: 463, ymax: 287 }</span>
	<span class="hljs-comment">// }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1kny7rm"><strong>Example:</strong> Zero-shot object detection w/ <code>Xenova/owlvit-base-patch32</code> (returning top 4 matches and setting a threshold).</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">const</span> detector = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'zero-shot-object-detection'</span>, <span class="hljs-string">'Xenova/owlvit-base-patch32'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/beach.png'</span>;
	<span class="hljs-keyword">const</span> candidate_labels = [<span class="hljs-string">'hat'</span>, <span class="hljs-string">'book'</span>, <span class="hljs-string">'sunglasses'</span>, <span class="hljs-string">'camera'</span>];
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">detector</span>(url, candidate_labels, { <span class="hljs-attr">top_k</span>: <span class="hljs-number">4</span>, <span class="hljs-attr">threshold</span>: <span class="hljs-number">0.05</span> });
	<span class="hljs-comment">// [</span>
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// score: 0.1606510728597641,</span>
	<span class="hljs-comment">// label: 'sunglasses',</span>
	<span class="hljs-comment">// box: { xmin: 347, ymin: 229, xmax: 429, ymax: 264 }</span>
	<span class="hljs-comment">// },</span>
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// score: 0.08935828506946564,</span>
	<span class="hljs-comment">// label: 'hat',</span>
	<span class="hljs-comment">// box: { xmin: 38, ymin: 174, xmax: 258, ymax: 364 }</span>
	<span class="hljs-comment">// },</span>
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// score: 0.08530698716640472,</span>
	<span class="hljs-comment">// label: 'camera',</span>
	<span class="hljs-comment">// box: { xmin: 187, ymin: 350, xmax: 260, ymax: 411 }</span>
	<span class="hljs-comment">// },</span>
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// score: 0.08349756896495819,</span>
	<span class="hljs-comment">// label: 'book',</span>
	<span class="hljs-comment">// box: { xmin: 261, ymin: 280, xmax: 494, ymax: 425 }</span>
	<span class="hljs-comment">// }</span>
	<span class="hljs-comment">// ]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-1sje1nx"><li><a href="#module_pipelines.ZeroShotObjectDetectionPipeline">.ZeroShotObjectDetectionPipeline</a><ul><li><a href="#new_module_pipelines.ZeroShotObjectDetectionPipeline_new"><code>new ZeroShotObjectDetectionPipeline(options)</code></a></li> <li><a href="#module_pipelines.ZeroShotObjectDetectionPipeline+_call"><code>._call()</code></a> : <code>ZeroShotObjectDetectionPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ZeroShotObjectDetectionPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-zeroshotobjectdetectionpipelineoptions" 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-zeroshotobjectdetectionpipelineoptions"><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 ZeroShotObjectDetectionPipeline(options)</span></h3> <p data-svelte-h="svelte-t69287">Create a new ZeroShotObjectDetectionPipeline.</p> <table data-svelte-h="svelte-1r7ciun"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ZeroShotObjectDetectionPipeline+_call" class="group"></a> <h3 class="relative group"><a id="zeroshotobjectdetectionpipelinecall--code-zeroshotobjectdetectionpipelinecallback-code" 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="#zeroshotobjectdetectionpipelinecall--code-zeroshotobjectdetectionpipelinecallback-code"><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>zeroShotObjectDetectionPipeline._call() : <code> ZeroShotObjectDetectionPipelineCallback </code></span></h3> <p data-svelte-h="svelte-voaoyf"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ZeroShotObjectDetectionPipeline"><code>ZeroShotObjectDetectionPipeline</code></a></p> <hr> <a id="module_pipelines.DocumentQuestionAnsweringPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesdocumentquestionansweringpipeline" 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="#pipelinesdocumentquestionansweringpipeline"><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.DocumentQuestionAnsweringPipeline</span></h2> <p data-svelte-h="svelte-iv1c6p">Document Question Answering pipeline using any <code>AutoModelForDocumentQuestionAnswering</code>.
	The inputs/outputs are similar to the (extractive) question answering pipeline; however,
	the pipeline takes an image (and optional OCR’d words/boxes) as input instead of text context.</p> <p data-svelte-h="svelte-1mtx2cy"><strong>Example:</strong> Answer questions about a document with <code>Xenova/donut-base-finetuned-docvqa</code>.</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">const</span> qa_pipeline = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'document-question-answering'</span>, <span class="hljs-string">'Xenova/donut-base-finetuned-docvqa'</span>);
	<span class="hljs-keyword">const</span> image = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/invoice.png'</span>;
	<span class="hljs-keyword">const</span> question = <span class="hljs-string">'What is the invoice number?'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">qa_pipeline</span>(image, question);
	<span class="hljs-comment">// [{ answer: 'us-001' }]</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-1vh9slr"><li><a href="#module_pipelines.DocumentQuestionAnsweringPipeline">.DocumentQuestionAnsweringPipeline</a><ul><li><a href="#new_module_pipelines.DocumentQuestionAnsweringPipeline_new"><code>new DocumentQuestionAnsweringPipeline(options)</code></a></li> <li><a href="#module_pipelines.DocumentQuestionAnsweringPipeline+_call"><code>._call()</code></a> : <code>DocumentQuestionAnsweringPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.DocumentQuestionAnsweringPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-documentquestionansweringpipelineoptions" 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-documentquestionansweringpipelineoptions"><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 DocumentQuestionAnsweringPipeline(options)</span></h3> <p data-svelte-h="svelte-at8fug">Create a new DocumentQuestionAnsweringPipeline.</p> <table data-svelte-h="svelte-1r7ciun"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.DocumentQuestionAnsweringPipeline+_call" class="group"></a> <h3 class="relative group"><a id="documentquestionansweringpipelinecall--code-documentquestionansweringpipelinecallback-code" 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="#documentquestionansweringpipelinecall--code-documentquestionansweringpipelinecallback-code"><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>documentQuestionAnsweringPipeline._call() : <code> DocumentQuestionAnsweringPipelineCallback </code></span></h3> <p data-svelte-h="svelte-pvyv43"><strong>Kind</strong>: instance method of <a href="#module_pipelines.DocumentQuestionAnsweringPipeline"><code>DocumentQuestionAnsweringPipeline</code></a></p> <hr> <a id="module_pipelines.TextToAudioPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinestexttoaudiopipeline" 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="#pipelinestexttoaudiopipeline"><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.TextToAudioPipeline</span></h2> <p data-svelte-h="svelte-1nzvfes">Text-to-audio generation pipeline using any <code>AutoModelForTextToWaveform</code> or <code>AutoModelForTextToSpectrogram</code>.
	This pipeline generates an audio file from an input text and optional other conditional inputs.</p> <p data-svelte-h="svelte-1qq0cp9"><strong>Example:</strong> Generate audio from text with <code>Xenova/speecht5_tts</code>.</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">const</span> synthesizer = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'text-to-speech'</span>, <span class="hljs-string">'Xenova/speecht5_tts'</span>, { <span class="hljs-attr">quantized</span>: <span class="hljs-literal">false</span> });
	<span class="hljs-keyword">const</span> speaker_embeddings = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/speaker_embeddings.bin'</span>;
	<span class="hljs-keyword">const</span> out = <span class="hljs-keyword">await</span> <span class="hljs-title function_">synthesizer</span>(<span class="hljs-string">'Hello, my dog is cute'</span>, { speaker_embeddings });
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// audio: Float32Array(26112) [-0.00005657337896991521, 0.00020583874720614403, ...],</span>
	<span class="hljs-comment">// sampling_rate: 16000</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1mslt41">You can then save the audio to a .wav file with the <code>wavefile</code> package:</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> wavefile <span class="hljs-keyword">from</span> <span class="hljs-string">'wavefile'</span>;
	<span class="hljs-keyword">import</span> fs <span class="hljs-keyword">from</span> <span class="hljs-string">'fs'</span>;

	<span class="hljs-keyword">const</span> wav = <span class="hljs-keyword">new</span> wavefile.<span class="hljs-title class_">WaveFile</span>();
	wav.<span class="hljs-title function_">fromScratch</span>(<span class="hljs-number">1</span>, out.<span class="hljs-property">sampling_rate</span>, <span class="hljs-string">'32f'</span>, out.<span class="hljs-property">audio</span>);
	fs.<span class="hljs-title function_">writeFileSync</span>(<span class="hljs-string">'out.wav'</span>, wav.<span class="hljs-title function_">toBuffer</span>());<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-dehksg"><strong>Example:</strong> Multilingual speech generation with <code>Xenova/mms-tts-fra</code>. See <a href="https://huggingface.co/models?pipeline_tag=text-to-speech&other=vits&sort=trending" rel="nofollow">here</a> for the full list of available languages (1107).</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">const</span> synthesizer = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'text-to-speech'</span>, <span class="hljs-string">'Xenova/mms-tts-fra'</span>);
	<span class="hljs-keyword">const</span> out = <span class="hljs-keyword">await</span> <span class="hljs-title function_">synthesizer</span>(<span class="hljs-string">'Bonjour'</span>);
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// audio: Float32Array(23808) [-0.00037693005288019776, 0.0003325853613205254, ...],</span>
	<span class="hljs-comment">// sampling_rate: 16000</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-1jpp8cv"><li><a href="#module_pipelines.TextToAudioPipeline">.TextToAudioPipeline</a><ul><li><a href="#new_module_pipelines.TextToAudioPipeline_new"><code>new TextToAudioPipeline(options)</code></a></li> <li><a href="#module_pipelines.TextToAudioPipeline+_call"><code>._call()</code></a> : <code>TextToAudioPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.TextToAudioPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-texttoaudiopipelineoptions" 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-texttoaudiopipelineoptions"><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 TextToAudioPipeline(options)</span></h3> <p data-svelte-h="svelte-ipwl63">Create a new TextToAudioPipeline.</p> <table data-svelte-h="svelte-asell3"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>TextToAudioPipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.TextToAudioPipeline+_call" class="group"></a> <h3 class="relative group"><a id="texttoaudiopipelinecall--code-texttoaudiopipelinecallback-code" 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="#texttoaudiopipelinecall--code-texttoaudiopipelinecallback-code"><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>textToAudioPipeline._call() : <code> TextToAudioPipelineCallback </code></span></h3> <p data-svelte-h="svelte-1e762tl"><strong>Kind</strong>: instance method of <a href="#module_pipelines.TextToAudioPipeline"><code>TextToAudioPipeline</code></a></p> <hr> <a id="module_pipelines.ImageToImagePipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesimagetoimagepipeline" 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="#pipelinesimagetoimagepipeline"><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.ImageToImagePipeline</span></h2> <p data-svelte-h="svelte-1y1a6n">Image to Image pipeline using any <code>AutoModelForImageToImage</code>. This pipeline generates an image based on a previous image input.</p> <p data-svelte-h="svelte-el75jg"><strong>Example:</strong> Super-resolution w/ <code>Xenova/swin2SR-classical-sr-x2-64</code></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">const</span> upscaler = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'image-to-image'</span>, <span class="hljs-string">'Xenova/swin2SR-classical-sr-x2-64'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/butterfly.jpg'</span>;
	<span class="hljs-keyword">const</span> output = <span class="hljs-keyword">await</span> <span class="hljs-title function_">upscaler</span>(url);
	<span class="hljs-comment">// RawImage {</span>
	<span class="hljs-comment">// data: Uint8Array(786432) [ 41, 31, 24, 43, ... ],</span>
	<span class="hljs-comment">// width: 512,</span>
	<span class="hljs-comment">// height: 512,</span>
	<span class="hljs-comment">// channels: 3</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-1hvigd"><li><a href="#module_pipelines.ImageToImagePipeline">.ImageToImagePipeline</a><ul><li><a href="#new_module_pipelines.ImageToImagePipeline_new"><code>new ImageToImagePipeline(options)</code></a></li> <li><a href="#module_pipelines.ImageToImagePipeline+_call"><code>._call()</code></a> : <code>ImageToImagePipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.ImageToImagePipeline_new" class="group"></a> <h3 class="relative group"><a id="new-imagetoimagepipelineoptions" 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-imagetoimagepipelineoptions"><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 ImageToImagePipeline(options)</span></h3> <p data-svelte-h="svelte-dhr5hm">Create a new ImageToImagePipeline.</p> <table data-svelte-h="svelte-uwryka"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>ImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.ImageToImagePipeline+_call" class="group"></a> <h3 class="relative group"><a id="imagetoimagepipelinecall--code-imagetoimagepipelinecallback-code" 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="#imagetoimagepipelinecall--code-imagetoimagepipelinecallback-code"><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>imageToImagePipeline._call() : <code> ImageToImagePipelineCallback </code></span></h3> <p data-svelte-h="svelte-diiw1n"><strong>Kind</strong>: instance method of <a href="#module_pipelines.ImageToImagePipeline"><code>ImageToImagePipeline</code></a></p> <hr> <a id="module_pipelines.DepthEstimationPipeline" class="group"></a> <h2 class="relative group"><a id="pipelinesdepthestimationpipeline" 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="#pipelinesdepthestimationpipeline"><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.DepthEstimationPipeline</span></h2> <p data-svelte-h="svelte-cmozej">Depth estimation pipeline using any <code>AutoModelForDepthEstimation</code>. This pipeline predicts the depth of an image.</p> <p data-svelte-h="svelte-10zf5uq"><strong>Example:</strong> Depth estimation w/ <code>Xenova/dpt-hybrid-midas</code></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">const</span> depth_estimator = <span class="hljs-keyword">await</span> <span class="hljs-title function_">pipeline</span>(<span class="hljs-string">'depth-estimation'</span>, <span class="hljs-string">'Xenova/dpt-hybrid-midas'</span>);
	<span class="hljs-keyword">const</span> url = <span class="hljs-string">'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/cats.jpg'</span>;
	<span class="hljs-keyword">const</span> out = <span class="hljs-keyword">await</span> <span class="hljs-title function_">depth_estimator</span>(url);
	<span class="hljs-comment">// {</span>
	<span class="hljs-comment">// predicted_depth: Tensor {</span>
	<span class="hljs-comment">// dims: [ 384, 384 ],</span>
	<span class="hljs-comment">// type: 'float32',</span>
	<span class="hljs-comment">// data: Float32Array(147456) [ 542.859130859375, 545.2833862304688, 546.1649169921875, ... ],</span>
	<span class="hljs-comment">// size: 147456</span>
	<span class="hljs-comment">// },</span>
	<span class="hljs-comment">// depth: RawImage {</span>
	<span class="hljs-comment">// data: Uint8Array(307200) [ 86, 86, 86, ... ],</span>
	<span class="hljs-comment">// width: 640,</span>
	<span class="hljs-comment">// height: 480,</span>
	<span class="hljs-comment">// channels: 1</span>
	<span class="hljs-comment">// }</span>
	<span class="hljs-comment">// }</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-s10qq4"><strong>Kind</strong>: static class of <a href="#module_pipelines"><code>pipelines</code></a></p> <ul data-svelte-h="svelte-l45353"><li><a href="#module_pipelines.DepthEstimationPipeline">.DepthEstimationPipeline</a><ul><li><a href="#new_module_pipelines.DepthEstimationPipeline_new"><code>new DepthEstimationPipeline(options)</code></a></li> <li><a href="#module_pipelines.DepthEstimationPipeline+_call"><code>._call()</code></a> : <code>DepthEstimationPipelineCallback</code></li></ul></li></ul> <hr> <a id="new_module_pipelines.DepthEstimationPipeline_new" class="group"></a> <h3 class="relative group"><a id="new-depthestimationpipelineoptions" 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-depthestimationpipelineoptions"><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 DepthEstimationPipeline(options)</span></h3> <p data-svelte-h="svelte-h6i1s9">Create a new DepthEstimationPipeline.</p> <table data-svelte-h="svelte-uwryka"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>options</td><td><code>ImagePipelineConstructorArgs</code></td><td><p>An object used to instantiate the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines.DepthEstimationPipeline+_call" class="group"></a> <h3 class="relative group"><a id="depthestimationpipelinecall--code-depthestimationpipelinecallback-code" 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="#depthestimationpipelinecall--code-depthestimationpipelinecallback-code"><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>depthEstimationPipeline._call() : <code> DepthEstimationPipelineCallback </code></span></h3> <p data-svelte-h="svelte-k6swrx"><strong>Kind</strong>: instance method of <a href="#module_pipelines.DepthEstimationPipeline"><code>DepthEstimationPipeline</code></a></p> <hr> <a id="module_pipelines.pipeline" class="group"></a> <h2 class="relative group"><a id="pipelinespipelinetask-model-options--code--code" 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--code--code"><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]) ⇒ <code> * </code></span></h2> <p data-svelte-h="svelte-1drpefn">Utility factory method to build a <code>Pipeline</code> object.</p> <p data-svelte-h="svelte-gbcntq"><strong>Kind</strong>: static method of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code></code> - A Pipeline object for the specified task.<br> <strong>Throws</strong>:</p> <ul data-svelte-h="svelte-wk6owh"><li><code>Error</code> If an unsupported pipeline is requested.</li></ul> <table data-svelte-h="svelte-1j0rydw"><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>"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></code></td><td></td><td><p>Optional parameters for the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ImagePipelineInputs" class="group"></a> <h2 class="relative group"><a id="pipelinesimagepipelineinputs--code-string-code--code-rawimage-code--code-url-code" 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="#pipelinesimagepipelineinputs--code-string-code--code-rawimage-code--code-url-code"><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~ImagePipelineInputs : <code> string </code> \| <code> RawImage </code> \| <code> URL </code></span></h2> <p data-svelte-h="svelte-1axcw5l"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a></p> <hr> <a id="module_pipelines..AudioPipelineInputs" class="group"></a> <h2 class="relative group"><a id="pipelinesaudiopipelineinputs--code-string-code--code-url-code--code-float32array-code--code-float64array-code" 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="#pipelinesaudiopipelineinputs--code-string-code--code-url-code--code-float32array-code--code-float64array-code"><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~AudioPipelineInputs : <code> string </code> \| <code> URL </code> \| <code> Float32Array </code> \| <code> Float64Array </code></span></h2> <p data-svelte-h="svelte-1axcw5l"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a></p> <hr> <a id="module_pipelines..BoundingBox" class="group"></a> <h2 class="relative group"><a id="pipelinesboundingbox--code-object-code" 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="#pipelinesboundingbox--code-object-code"><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~BoundingBox : <code> Object </code></span></h2> <p data-svelte-h="svelte-ptv3i7"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Properties</strong></p> <table data-svelte-h="svelte-1ggz2h3"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>xmin</td><td><code>number</code></td><td><p>The minimum x coordinate of the bounding box.</p></td> </tr><tr><td>ymin</td><td><code>number</code></td><td><p>The minimum y coordinate of the bounding box.</p></td> </tr><tr><td>xmax</td><td><code>number</code></td><td><p>The maximum x coordinate of the bounding box.</p></td> </tr><tr><td>ymax</td><td><code>number</code></td><td><p>The maximum y coordinate of the bounding box.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..Disposable" class="group"></a> <h2 class="relative group"><a id="pipelinesdisposable--code-promise--void--code" 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="#pipelinesdisposable--code-promise--void--code"><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~Disposable ⇒ <code> Promise. < void > </code></span></h2> <p data-svelte-h="svelte-1u62ns5"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<void></code> - A promise that resolves when the item has been disposed.<br> <strong>Properties</strong></p> <table data-svelte-h="svelte-rk1slv"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>dispose</td><td><code>DisposeType</code></td><td><p>A promise that resolves when the pipeline has been disposed.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..TextPipelineConstructorArgs" class="group"></a> <h2 class="relative group"><a id="pipelinestextpipelineconstructorargs--code-object-code" 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="#pipelinestextpipelineconstructorargs--code-object-code"><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~TextPipelineConstructorArgs : <code> Object </code></span></h2> <p data-svelte-h="svelte-34syj8">An object used to instantiate a text-based pipeline.</p> <p data-svelte-h="svelte-ptv3i7"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Properties</strong></p> <table data-svelte-h="svelte-1fvmgx7"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>task</td><td><code>string</code></td><td><p>The task of the pipeline. Useful for specifying subtasks.</p></td> </tr><tr><td>model</td><td><code>PreTrainedModel</code></td><td><p>The model used by the pipeline.</p></td> </tr><tr><td>tokenizer</td><td><code>PreTrainedTokenizer</code></td><td><p>The tokenizer used by the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ImagePipelineConstructorArgs" class="group"></a> <h2 class="relative group"><a id="pipelinesimagepipelineconstructorargs--code-object-code" 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="#pipelinesimagepipelineconstructorargs--code-object-code"><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~ImagePipelineConstructorArgs : <code> Object </code></span></h2> <p data-svelte-h="svelte-1mr04yh">An object used to instantiate an audio-based pipeline.</p> <p data-svelte-h="svelte-ptv3i7"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Properties</strong></p> <table data-svelte-h="svelte-1agpzvo"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>task</td><td><code>string</code></td><td><p>The task of the pipeline. Useful for specifying subtasks.</p></td> </tr><tr><td>model</td><td><code>PreTrainedModel</code></td><td><p>The model used by the pipeline.</p></td> </tr><tr><td>processor</td><td><code>Processor</code></td><td><p>The processor used by the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..TextImagePipelineConstructorArgs" class="group"></a> <h2 class="relative group"><a id="pipelinestextimagepipelineconstructorargs--code-object-code" 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="#pipelinestextimagepipelineconstructorargs--code-object-code"><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~TextImagePipelineConstructorArgs : <code> Object </code></span></h2> <p data-svelte-h="svelte-6hgc2w">An object used to instantiate a text- and audio-based pipeline.</p> <p data-svelte-h="svelte-ptv3i7"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Properties</strong></p> <table data-svelte-h="svelte-10ghpzh"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>task</td><td><code>string</code></td><td><p>The task of the pipeline. Useful for specifying subtasks.</p></td> </tr><tr><td>model</td><td><code>PreTrainedModel</code></td><td><p>The model used by the pipeline.</p></td> </tr><tr><td>tokenizer</td><td><code>PreTrainedTokenizer</code></td><td><p>The tokenizer used by the pipeline.</p></td> </tr><tr><td>processor</td><td><code>Processor</code></td><td><p>The processor used by the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..TextClassificationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinestextclassificationpipelinetype--code-promise--textclassificationoutputarray--textclassificationoutput----code" 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="#pipelinestextclassificationpipelinetype--code-promise--textclassificationoutputarray--textclassificationoutput----code"><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~TextClassificationPipelineType ⇒ <code> Promise. < (TextClassificationOutput\|Array < TextClassificationOutput > ) > </code></span></h2> <p data-svelte-h="svelte-5irp67">Parameters specific to text classification pipelines.</p> <p data-svelte-h="svelte-1q1ef1c"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(TextClassificationOutput\|Array<TextClassificationOutput>)></code> - An array or object containing the predicted labels and scores.</p> <table data-svelte-h="svelte-1n7bxpl"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code></td><td><p>The input text(s) to be classified.</p></td> </tr><tr><td>[options]</td><td><code>TextClassificationPipelineOptions</code></td><td><p>The options to use for text classification.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-1jphmrz"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>label</td><td><code>string</code></td><td></td><td><p>The label predicted.</p></td> </tr><tr><td>score</td><td><code>number</code></td><td></td><td><p>The corresponding probability.</p></td> </tr><tr><td>[top_k]</td><td><code>number</code></td><td><code>1</code></td><td><p>The number of top predictions to be returned.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..TokenClassificationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinestokenclassificationpipelinetype--code-promise--tokenclassificationoutputarray--tokenclassificationoutput----code" 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="#pipelinestokenclassificationpipelinetype--code-promise--tokenclassificationoutputarray--tokenclassificationoutput----code"><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~TokenClassificationPipelineType ⇒ <code> Promise. < (TokenClassificationOutput\|Array < TokenClassificationOutput > ) > </code></span></h2> <p data-svelte-h="svelte-e99ya5">Parameters specific to token classification pipelines.</p> <p data-svelte-h="svelte-1bsoqra"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(TokenClassificationOutput\|Array<TokenClassificationOutput>)></code> - The result.</p> <table data-svelte-h="svelte-wkggw2"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code></td><td><p>One or several texts (or one list of texts) for token classification.</p></td> </tr><tr><td>[options]</td><td><code>TokenClassificationPipelineOptions</code></td><td><p>The options to use for token classification.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-11kx8qp"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>word</td><td><code>string</code></td><td><p>The token/word classified. This is obtained by decoding the selected tokens.</p></td> </tr><tr><td>score</td><td><code>number</code></td><td><p>The corresponding probability for <code>entity</code>.</p></td> </tr><tr><td>entity</td><td><code>string</code></td><td><p>The entity predicted for that token/word.</p></td> </tr><tr><td>index</td><td><code>number</code></td><td><p>The index of the corresponding token in the sentence.</p></td> </tr><tr><td>[start]</td><td><code>number</code></td><td><p>The index of the start of the corresponding entity in the sentence.</p></td> </tr><tr><td>[end]</td><td><code>number</code></td><td><p>The index of the end of the corresponding entity in the sentence.</p></td> </tr><tr><td>[ignore_labels]</td><td><code>Array.<string></code></td><td><p>A list of labels to ignore.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..QuestionAnsweringPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesquestionansweringpipelinetype--code-promise--questionansweringoutputarray--questionansweringoutput----code" 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="#pipelinesquestionansweringpipelinetype--code-promise--questionansweringoutputarray--questionansweringoutput----code"><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~QuestionAnsweringPipelineType ⇒ <code> Promise. < (QuestionAnsweringOutput\|Array < QuestionAnsweringOutput > ) > </code></span></h2> <p data-svelte-h="svelte-1vedd0s">Parameters specific to question answering pipelines.</p> <p data-svelte-h="svelte-2lvzw0"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(QuestionAnsweringOutput\|Array<QuestionAnsweringOutput>)></code> - An array or object containing the predicted answers and scores.</p> <table data-svelte-h="svelte-1bpmr33"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>question</td><td><code>string</code> \| <code>Array<string></code></td><td><p>One or several question(s) (must be used in conjunction with the <code>context</code> argument).</p></td> </tr><tr><td>context</td><td><code>string</code> \| <code>Array<string></code></td><td><p>One or several context(s) associated with the question(s) (must be used in conjunction with the <code>question</code> argument).</p></td> </tr><tr><td>[options]</td><td><code>QuestionAnsweringPipelineOptions</code></td><td><p>The options to use for question answering.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-1era92"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>score</td><td><code>number</code></td><td></td><td><p>The probability associated to the answer.</p></td> </tr><tr><td>[start]</td><td><code>number</code></td><td></td><td><p>The character start index of the answer (in the tokenized version of the input).</p></td> </tr><tr><td>[end]</td><td><code>number</code></td><td></td><td><p>The character end index of the answer (in the tokenized version of the input).</p></td> </tr><tr><td>answer</td><td><code>string</code></td><td></td><td><p>The answer to the question.</p></td> </tr><tr><td>[top_k]</td><td><code>number</code></td><td><code>1</code></td><td><p>The number of top answer predictions to be returned.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..FillMaskPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesfillmaskpipelinetype--code-promise--fillmaskoutputarray--fillmaskoutput----code" 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="#pipelinesfillmaskpipelinetype--code-promise--fillmaskoutputarray--fillmaskoutput----code"><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~FillMaskPipelineType ⇒ <code> Promise. < (FillMaskOutput\|Array < FillMaskOutput > ) > </code></span></h2> <p data-svelte-h="svelte-c20v7t">Parameters specific to fill mask pipelines.</p> <p data-svelte-h="svelte-hjcayz"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(FillMaskOutput\|Array<FillMaskOutput>)></code> - An array of objects containing the score, predicted token, predicted token string,
	and the sequence with the predicted token filled in, or an array of such arrays (one for each input text).
	If only one input text is given, the output will be an array of objects.<br> <strong>Throws</strong>:</p> <ul data-svelte-h="svelte-wmzf9w"><li><code>Error</code> When the mask token is not found in the input text.</li></ul> <table data-svelte-h="svelte-10st3qn"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code></td><td><p>One or several texts (or one list of prompts) with masked tokens.</p></td> </tr><tr><td>[options]</td><td><code>FillMaskPipelineOptions</code></td><td><p>The options to use for masked language modelling.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-1isqyy1"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>sequence</td><td><code>string</code></td><td></td><td><p>The corresponding input with the mask token prediction.</p></td> </tr><tr><td>score</td><td><code>number</code></td><td></td><td><p>The corresponding probability.</p></td> </tr><tr><td>token</td><td><code>number</code></td><td></td><td><p>The predicted token id (to replace the masked one).</p></td> </tr><tr><td>token_str</td><td><code>string</code></td><td></td><td><p>The predicted token (to replace the masked one).</p></td> </tr><tr><td>[top_k]</td><td><code>number</code></td><td><code>5</code></td><td><p>When passed, overrides the number of predictions to return.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..Text2TextGenerationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinestext2textgenerationpipelinetype--code-promise--text2textgenerationoutputarray--text2textgenerationoutput----code" 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="#pipelinestext2textgenerationpipelinetype--code-promise--text2textgenerationoutputarray--text2textgenerationoutput----code"><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~Text2TextGenerationPipelineType ⇒ <code> Promise. < (Text2TextGenerationOutput\|Array < Text2TextGenerationOutput > ) > </code></span></h2> <p data-svelte-h="svelte-1axcw5l"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a></p> <table data-svelte-h="svelte-wdzz5f"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code></td><td><p>Input text for the encoder.</p></td> </tr><tr><td>[options]</td><td><code></code></td><td><p>Additional keyword arguments to pass along to the generate method of the model.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-jpm10y"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>generated_text</td><td><code>string</code></td><td><p>The generated text.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..SummarizationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinessummarizationpipelinetype--code-promise--summarizationoutputarray--summarizationoutput----code" 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="#pipelinessummarizationpipelinetype--code-promise--summarizationoutputarray--summarizationoutput----code"><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~SummarizationPipelineType ⇒ <code> Promise. < (SummarizationOutput\|Array < SummarizationOutput > ) > </code></span></h2> <p data-svelte-h="svelte-1axcw5l"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a></p> <table data-svelte-h="svelte-um34lc"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code></td><td><p>One or several articles (or one list of articles) to summarize.</p></td> </tr><tr><td>[options]</td><td><code></code></td><td><p>Additional keyword arguments to pass along to the generate method of the model.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-12o7o6m"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>summary_text</td><td><code>string</code></td><td><p>The summary text.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..TranslationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinestranslationpipelinetype--code-promise--translationoutputarray--translationoutput----code" 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="#pipelinestranslationpipelinetype--code-promise--translationoutputarray--translationoutput----code"><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~TranslationPipelineType ⇒ <code> Promise. < (TranslationOutput\|Array < TranslationOutput > ) > </code></span></h2> <p data-svelte-h="svelte-1axcw5l"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a></p> <table data-svelte-h="svelte-2zn3c2"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code></td><td><p>Texts to be translated.</p></td> </tr><tr><td>[options]</td><td><code>*</code></td><td><p>Additional keyword arguments to pass along to the generate method of the model.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-14fnfzf"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>translation_text</td><td><code>string</code></td><td><p>The translated text.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..TextGenerationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinestextgenerationpipelinetype--code-promise--textgenerationoutputarray--textgenerationoutput----code" 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="#pipelinestextgenerationpipelinetype--code-promise--textgenerationoutputarray--textgenerationoutput----code"><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~TextGenerationPipelineType ⇒ <code> Promise. < (TextGenerationOutput\|Array < TextGenerationOutput > ) > </code></span></h2> <p data-svelte-h="svelte-1iiqv80">Parameters specific to text-generation pipelines.</p> <p data-svelte-h="svelte-127plg"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(TextGenerationOutput\|Array<TextGenerationOutput>)></code> - An array or object containing the generated texts.</p> <table data-svelte-h="svelte-zz9utp"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code> \| <code>Chat</code> \| <code>Array<Chat></code></td><td><p>One or several prompts (or one list of prompts) to complete.</p></td> </tr><tr><td>[options]</td><td><code>Partial.<TextGenerationConfig></code></td><td><p>Additional keyword arguments to pass along to the generate method of the model.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-fwioke"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>generated_text</td><td><code>string</code> \| <code>Chat</code></td><td></td><td><p>The generated text.</p></td> </tr><tr><td>[add_special_tokens]</td><td><code>boolean</code></td><td></td><td><p>Whether or not to add special tokens when tokenizing the sequences.</p></td> </tr><tr><td>[return_full_text]</td><td><code>boolean</code></td><td><code>true</code></td><td><p>If set to <code>false</code> only added text is returned, otherwise the full text is returned.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ZeroShotClassificationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelineszeroshotclassificationpipelinetype--code-promise--zeroshotclassificationoutputarray--zeroshotclassificationoutput----code" 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="#pipelineszeroshotclassificationpipelinetype--code-promise--zeroshotclassificationoutputarray--zeroshotclassificationoutput----code"><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~ZeroShotClassificationPipelineType ⇒ <code> Promise. < (ZeroShotClassificationOutput\|Array < ZeroShotClassificationOutput > ) > </code></span></h2> <p data-svelte-h="svelte-14robr1">Parameters specific to zero-shot classification pipelines.</p> <p data-svelte-h="svelte-v0oyxa"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(ZeroShotClassificationOutput\|Array<ZeroShotClassificationOutput>)></code> - An array or object containing the predicted labels and scores.</p> <table data-svelte-h="svelte-1esamuv"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code></td><td><p>The sequence(s) to classify, will be truncated if the model input is too large.</p></td> </tr><tr><td>candidate_labels</td><td><code>string</code> \| <code>Array<string></code></td><td><p>The set of possible class labels to classify each sequence into.
	Can be a single label, a string of comma-separated labels, or a list of labels.</p></td> </tr><tr><td>[options]</td><td><code>ZeroShotClassificationPipelineOptions</code></td><td><p>The options to use for zero-shot classification.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-105ib2i"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>sequence</td><td><code>string</code></td><td></td><td><p>The sequence for which this is the output.</p></td> </tr><tr><td>labels</td><td><code>Array.<string></code></td><td></td><td><p>The labels sorted by order of likelihood.</p></td> </tr><tr><td>scores</td><td><code>Array.<number></code></td><td></td><td><p>The probabilities for each of the labels.</p></td> </tr><tr><td>[hypothesis_template]</td><td><code>string</code></td><td><code>""This example is {}.""</code></td><td><p>The template used to turn each
	candidate label into an NLI-style hypothesis. The candidate label will replace the &#123;} placeholder.</p></td> </tr><tr><td>[multi_label]</td><td><code>boolean</code></td><td><code>false</code></td><td><p>Whether or not multiple candidate labels can be true.
	If <code>false</code>, the scores are normalized such that the sum of the label likelihoods for each sequence
	is 1. If <code>true</code>, the labels are considered independent and probabilities are normalized for each
	candidate by doing a softmax of the entailment score vs. the contradiction score.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..FeatureExtractionPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesfeatureextractionpipelinetype--code-promise--tensor--code" 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="#pipelinesfeatureextractionpipelinetype--code-promise--tensor--code"><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~FeatureExtractionPipelineType ⇒ <code> Promise. < Tensor > </code></span></h2> <p data-svelte-h="svelte-1g7now9">Parameters specific to feature extraction pipelines.</p> <p data-svelte-h="svelte-1d3dphs"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <a href="#Tensor"><code>Promise.<Tensor></code></a> - The features computed by the model.</p> <table data-svelte-h="svelte-1e229ag"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code></td><td><p>One or several texts (or one list of texts) to get the features of.</p></td> </tr><tr><td>[options]</td><td><code>FeatureExtractionPipelineOptions</code></td><td><p>The options to use for feature extraction.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-k6x8ku"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>[pooling]</td><td><code>'none'</code> \| <code>'mean'</code> \| <code>'cls'</code></td><td><code>"none"</code></td><td><p>The pooling method to use.</p></td> </tr><tr><td>[normalize]</td><td><code>boolean</code></td><td><code>false</code></td><td><p>Whether or not to normalize the embeddings in the last dimension.</p></td> </tr><tr><td>[quantize]</td><td><code>boolean</code></td><td><code>false</code></td><td><p>Whether or not to quantize the embeddings.</p></td> </tr><tr><td>[precision]</td><td><code>'binary'</code> \| <code>'ubinary'</code></td><td><code>'binary'</code></td><td><p>The precision to use for quantization.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ImageFeatureExtractionPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesimagefeatureextractionpipelinetype--code-promise--tensor--code" 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="#pipelinesimagefeatureextractionpipelinetype--code-promise--tensor--code"><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~ImageFeatureExtractionPipelineType ⇒ <code> Promise. < Tensor > </code></span></h2> <p data-svelte-h="svelte-1j7a9hq">Parameters specific to image feature extraction pipelines.</p> <p data-svelte-h="svelte-o60zvb"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <a href="#Tensor"><code>Promise.<Tensor></code></a> - The image features computed by the model.</p> <table data-svelte-h="svelte-1ij1nih"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>images</td><td><code>ImagePipelineInputs</code></td><td><p>One or several images (or one list of images) to get the features of.</p></td> </tr><tr><td>[options]</td><td><code>ImageFeatureExtractionPipelineOptions</code></td><td><p>The options to use for image feature extraction.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-4g6d9h"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>[pool]</td><td><code>boolean</code></td><td><code></code></td><td><p>Whether or not to return the pooled output. If set to <code>false</code>, the model will return the raw hidden states.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..AudioClassificationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesaudioclassificationpipelinetype--code-promise--audioclassificationoutputarray--audioclassificationoutput----code" 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="#pipelinesaudioclassificationpipelinetype--code-promise--audioclassificationoutputarray--audioclassificationoutput----code"><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~AudioClassificationPipelineType ⇒ <code> Promise. < (AudioClassificationOutput\|Array < AudioClassificationOutput > ) > </code></span></h2> <p data-svelte-h="svelte-zg073o">Parameters specific to audio classification pipelines.</p> <p data-svelte-h="svelte-1p0pjr6"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(AudioClassificationOutput\|Array<AudioClassificationOutput>)></code> - An array or object containing the predicted labels and scores.</p> <table data-svelte-h="svelte-1fnbyk"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>audio</td><td><code>AudioPipelineInputs</code></td><td><p>The input audio file(s) to be classified. The input is either:</p> <ul><li><code>string</code> or <code>URL</code> that is the filename/URL of the audio file, the file will be read at the processor's sampling rate
	to get the waveform using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioContext"><code>AudioContext</code></a> API.
	If <code>AudioContext</code> is not available, you should pass the raw waveform in as a Float32Array of shape <code>(n, )</code>.</li> <li><code>Float32Array</code> or <code>Float64Array</code> of shape <code>(n, )</code>, representing the raw audio at the correct sampling rate (no further check will be done).</li></ul></td> </tr><tr><td>[options]</td><td><code>AudioClassificationPipelineOptions</code></td><td><p>The options to use for audio classification.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-ovxjoy"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>label</td><td><code>string</code></td><td></td><td><p>The label predicted.</p></td> </tr><tr><td>score</td><td><code>number</code></td><td></td><td><p>The corresponding probability.</p></td> </tr><tr><td>[top_k]</td><td><code>number</code></td><td><code>5</code></td><td><p>The number of top labels that will be returned by the pipeline.
	If the provided number is <code>null</code> or higher than the number of labels available in the model configuration,
	it will default to the number of labels.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ZeroShotAudioClassificationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelineszeroshotaudioclassificationpipelinetype--code-promise--array--zeroshotaudioclassificationoutput--array--array--zeroshotaudioclassificationoutput-----code" 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="#pipelineszeroshotaudioclassificationpipelinetype--code-promise--array--zeroshotaudioclassificationoutput--array--array--zeroshotaudioclassificationoutput-----code"><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~ZeroShotAudioClassificationPipelineType ⇒ <code> Promise. < (Array < ZeroShotAudioClassificationOutput > \|Array < Array < ZeroShotAudioClassificationOutput > > ) > </code></span></h2> <p data-svelte-h="svelte-uiu8uf">Parameters specific to zero-shot audio classification pipelines.</p> <p data-svelte-h="svelte-1rznspb"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(Array<ZeroShotAudioClassificationOutput>\|Array<Array<ZeroShotAudioClassificationOutput>>)></code> - An array of objects containing the predicted labels and scores.</p> <table data-svelte-h="svelte-1t7i0jv"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>audio</td><td><code>AudioPipelineInputs</code></td><td><p>The input audio file(s) to be classified. The input is either:</p> <ul><li><code>string</code> or <code>URL</code> that is the filename/URL of the audio file, the file will be read at the processor's sampling rate
	to get the waveform using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioContext"><code>AudioContext</code></a> API.
	If <code>AudioContext</code> is not available, you should pass the raw waveform in as a Float32Array of shape <code>(n, )</code>.</li> <li><code>Float32Array</code> or <code>Float64Array</code> of shape <code>(n, )</code>, representing the raw audio at the correct sampling rate (no further check will be done).</li></ul></td> </tr><tr><td>candidate_labels</td><td><code>Array.<string></code></td><td><p>The candidate labels for this audio.</p></td> </tr><tr><td>[options]</td><td><code>ZeroShotAudioClassificationPipelineOptions</code></td><td><p>The options to use for zero-shot audio classification.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-1vg0xo5"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>label</td><td><code>string</code></td><td></td><td><p>The label identified by the model. It is one of the suggested <code>candidate_label</code>.</p></td> </tr><tr><td>score</td><td><code>number</code></td><td></td><td><p>The score attributed by the model for that label (between 0 and 1).</p></td> </tr><tr><td>[hypothesis_template]</td><td><code>string</code></td><td><code>""This is a sound of {}.""</code></td><td><p>The sentence used in conjunction with <code>candidate_labels</code>
	to attempt the audio classification by replacing the placeholder with the candidate_labels.
	Then likelihood is estimated by using <code>logits_per_audio</code>.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..Chunk" class="group"></a> <h2 class="relative group"><a id="pipelineschunk--code-object-code" 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="#pipelineschunk--code-object-code"><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~Chunk : <code> Object </code></span></h2> <p data-svelte-h="svelte-ptv3i7"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Properties</strong></p> <table data-svelte-h="svelte-iwz8lt"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>timestamp</td><td><code>*</code></td><td><p>The start and end timestamp of the chunk in seconds.</p></td> </tr><tr><td>text</td><td><code>string</code></td><td><p>The recognized text.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..AutomaticSpeechRecognitionPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesautomaticspeechrecognitionpipelinetype--code-promise--automaticspeechrecognitionoutputarray--automaticspeechrecognitionoutput----code" 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="#pipelinesautomaticspeechrecognitionpipelinetype--code-promise--automaticspeechrecognitionoutputarray--automaticspeechrecognitionoutput----code"><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~AutomaticSpeechRecognitionPipelineType ⇒ <code> Promise. < (AutomaticSpeechRecognitionOutput\|Array < AutomaticSpeechRecognitionOutput > ) > </code></span></h2> <p data-svelte-h="svelte-2ut6tw">Parameters specific to automatic-speech-recognition pipelines.</p> <p data-svelte-h="svelte-1mwkilo"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(AutomaticSpeechRecognitionOutput\|Array<AutomaticSpeechRecognitionOutput>)></code> - An object containing the transcription text and optionally timestamps if <code>return_timestamps</code> is <code>true</code>.</p> <table data-svelte-h="svelte-1m5w484"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>audio</td><td><code>AudioPipelineInputs</code></td><td><p>The input audio file(s) to be transcribed. The input is either:</p> <ul><li><code>string</code> or <code>URL</code> that is the filename/URL of the audio file, the file will be read at the processor's sampling rate
	to get the waveform using the <a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioContext"><code>AudioContext</code></a> API.
	If <code>AudioContext</code> is not available, you should pass the raw waveform in as a Float32Array of shape <code>(n, )</code>.</li> <li><code>Float32Array</code> or <code>Float64Array</code> of shape <code>(n, )</code>, representing the raw audio at the correct sampling rate (no further check will be done).</li></ul></td> </tr><tr><td>[options]</td><td><code>Partial.<AutomaticSpeechRecognitionConfig></code></td><td><p>Additional keyword arguments to pass along to the generate method of the model.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-h3w38e"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>text</td><td><code>string</code></td><td><p>The recognized text.</p></td> </tr><tr><td>[chunks]</td><td><code>Array.<Chunk></code></td><td><p>When using <code>return_timestamps</code>, the <code>chunks</code> will become a list
	containing all the various text chunks identified by the model.</p></td> </tr><tr><td>[return_timestamps]</td><td><code>boolean</code> \| <code>'word'</code></td><td><p>Whether to return timestamps or not. Default is <code>false</code>.</p></td> </tr><tr><td>[chunk_length_s]</td><td><code>number</code></td><td><p>The length of audio chunks to process in seconds. Default is 0 (no chunking).</p></td> </tr><tr><td>[stride_length_s]</td><td><code>number</code></td><td><p>The length of overlap between consecutive audio chunks in seconds. If not provided, defaults to <code>chunk_length_s / 6</code>.</p></td> </tr><tr><td>[force_full_sequences]</td><td><code>boolean</code></td><td><p>Whether to force outputting full sequences or not. Default is <code>false</code>.</p></td> </tr><tr><td>[language]</td><td><code>string</code></td><td><p>The source language. Default is <code>null</code>, meaning it should be auto-detected. Use this to potentially improve performance if the source language is known.</p></td> </tr><tr><td>[task]</td><td><code>string</code></td><td><p>The task to perform. Default is <code>null</code>, meaning it should be auto-detected.</p></td> </tr><tr><td>[num_frames]</td><td><code>number</code></td><td><p>The number of frames in the input audio.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ImageToTextPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesimagetotextpipelinetype--code-promise--imagetotextoutputarray--imagetotextoutput----code" 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="#pipelinesimagetotextpipelinetype--code-promise--imagetotextoutputarray--imagetotextoutput----code"><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~ImageToTextPipelineType ⇒ <code> Promise. < (ImageToTextOutput\|Array < ImageToTextOutput > ) > </code></span></h2> <p data-svelte-h="svelte-d49qij"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(ImageToTextOutput\|Array<ImageToTextOutput>)></code> - An object (or array of objects) containing the generated text(s).</p> <table data-svelte-h="svelte-ygxxf5"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>ImagePipelineInputs</code></td><td><p>The images to be captioned.</p></td> </tr><tr><td>[options]</td><td><code>*</code></td><td><p>Additional keyword arguments to pass along to the generate method of the model.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-jpm10y"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>generated_text</td><td><code>string</code></td><td><p>The generated text.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ImageClassificationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesimageclassificationpipelinetype--code-promise--imageclassificationoutputarray--imageclassificationoutput----code" 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="#pipelinesimageclassificationpipelinetype--code-promise--imageclassificationoutputarray--imageclassificationoutput----code"><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~ImageClassificationPipelineType ⇒ <code> Promise. < (ImageClassificationOutput\|Array < ImageClassificationOutput > ) > </code></span></h2> <p data-svelte-h="svelte-10azskl">Parameters specific to image classification pipelines.</p> <p data-svelte-h="svelte-1bdsbsy"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(ImageClassificationOutput\|Array<ImageClassificationOutput>)></code> - An array or object containing the predicted labels and scores.</p> <table data-svelte-h="svelte-1rcn5yv"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>images</td><td><code>ImagePipelineInputs</code></td><td><p>The input images(s) to be classified.</p></td> </tr><tr><td>[options]</td><td><code>ImageClassificationPipelineOptions</code></td><td><p>The options to use for image classification.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-ny1oa1"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>label</td><td><code>string</code></td><td></td><td><p>The label identified by the model.</p></td> </tr><tr><td>score</td><td><code>number</code></td><td></td><td><p>The score attributed by the model for that label.</p></td> </tr><tr><td>[top_k]</td><td><code>number</code></td><td><code>1</code></td><td><p>The number of top labels that will be returned by the pipeline.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ImageSegmentationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesimagesegmentationpipelinetype--code-promise--array--imagesegmentationpipelineoutput---code" 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="#pipelinesimagesegmentationpipelinetype--code-promise--array--imagesegmentationpipelineoutput---code"><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~ImageSegmentationPipelineType ⇒ <code> Promise. < Array < ImageSegmentationPipelineOutput > > </code></span></h2> <p data-svelte-h="svelte-1jdk7q7">Parameters specific to image segmentation pipelines.</p> <p data-svelte-h="svelte-17rpkxy"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<Array<ImageSegmentationPipelineOutput>></code> - The annotated segments.</p> <table data-svelte-h="svelte-12zqzt2"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>images</td><td><code>ImagePipelineInputs</code></td><td><p>The input images.</p></td> </tr><tr><td>[options]</td><td><code>ImageSegmentationPipelineOptions</code></td><td><p>The options to use for image segmentation.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-jxx1jt"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>label</td><td><code>string</code></td><td></td><td><p>The label of the segment.</p></td> </tr><tr><td>score</td><td><code>number</code> \| <code>null</code></td><td></td><td><p>The score of the segment.</p></td> </tr><tr><td>mask</td><td><code><a href="#RawImage">RawImage</a></code></td><td></td><td><p>The mask of the segment.</p></td> </tr><tr><td>[threshold]</td><td><code>number</code></td><td><code>0.5</code></td><td><p>Probability threshold to filter out predicted masks.</p></td> </tr><tr><td>[mask_threshold]</td><td><code>number</code></td><td><code>0.5</code></td><td><p>Threshold to use when turning the predicted masks into binary values.</p></td> </tr><tr><td>[overlap_mask_area_threshold]</td><td><code>number</code></td><td><code>0.8</code></td><td><p>Mask overlap threshold to eliminate small, disconnected segments.</p></td> </tr><tr><td>[subtask]</td><td><code>null</code> \| <code>string</code></td><td><code></code></td><td><p>Segmentation task to be performed. One of [<code>panoptic</code>, <code>instance</code>, and <code>semantic</code>],
	depending on model capabilities. If not set, the pipeline will attempt to resolve (in that order).</p></td> </tr><tr><td>[label_ids_to_fuse]</td><td><code>Array.<number></code></td><td><code></code></td><td><p>List of label ids to fuse. If not set, do not fuse any labels.</p></td> </tr><tr><td>[target_sizes]</td><td><code>Array.<Array<number>></code></td><td><code></code></td><td><p>List of target sizes for the input images. If not set, use the original image sizes.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ZeroShotImageClassificationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelineszeroshotimageclassificationpipelinetype--code-promise--array--zeroshotimageclassificationoutput--array--array--zeroshotimageclassificationoutput-----code" 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="#pipelineszeroshotimageclassificationpipelinetype--code-promise--array--zeroshotimageclassificationoutput--array--array--zeroshotimageclassificationoutput-----code"><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~ZeroShotImageClassificationPipelineType ⇒ <code> Promise. < (Array < ZeroShotImageClassificationOutput > \|Array < Array < ZeroShotImageClassificationOutput > > ) > </code></span></h2> <p data-svelte-h="svelte-61xmb6">Parameters specific to zero-shot image classification pipelines.</p> <p data-svelte-h="svelte-1c819p5"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(Array<ZeroShotImageClassificationOutput>\|Array<Array<ZeroShotImageClassificationOutput>>)></code> - An array of objects containing the predicted labels and scores.</p> <table data-svelte-h="svelte-1ql6xpw"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>images</td><td><code>ImagePipelineInputs</code></td><td><p>The input images.</p></td> </tr><tr><td>candidate_labels</td><td><code>Array.<string></code></td><td><p>The candidate labels for this image.</p></td> </tr><tr><td>[options]</td><td><code>ZeroShotImageClassificationPipelineOptions</code></td><td><p>The options to use for zero-shot image classification.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-14miuwu"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>label</td><td><code>string</code></td><td></td><td><p>The label identified by the model. It is one of the suggested <code>candidate_label</code>.</p></td> </tr><tr><td>score</td><td><code>number</code></td><td></td><td><p>The score attributed by the model for that label (between 0 and 1).</p></td> </tr><tr><td>[hypothesis_template]</td><td><code>string</code></td><td><code>""This is a photo of {}""</code></td><td><p>The sentence used in conjunction with <code>candidate_labels</code>
	to attempt the image classification by replacing the placeholder with the candidate_labels.
	Then likelihood is estimated by using <code>logits_per_image</code>.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ObjectDetectionPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesobjectdetectionpipelinetype--code-promise--objectdetectionpipelineoutputarray--objectdetectionpipelineoutput----code" 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="#pipelinesobjectdetectionpipelinetype--code-promise--objectdetectionpipelineoutputarray--objectdetectionpipelineoutput----code"><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~ObjectDetectionPipelineType ⇒ <code> Promise. < (ObjectDetectionPipelineOutput\|Array < ObjectDetectionPipelineOutput > ) > </code></span></h2> <p data-svelte-h="svelte-4x8tbi">Parameters specific to object detection pipelines.</p> <p data-svelte-h="svelte-148mxfe"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(ObjectDetectionPipelineOutput\|Array<ObjectDetectionPipelineOutput>)></code> - A list of objects or a list of list of objects.</p> <table data-svelte-h="svelte-nx9uxw"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>images</td><td><code>ImagePipelineInputs</code></td><td><p>The input images.</p></td> </tr><tr><td>[options]</td><td><code>ObjectDetectionPipelineOptions</code></td><td><p>The options to use for object detection.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-20m6rc"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>label</td><td><code>string</code></td><td></td><td><p>The class label identified by the model.</p></td> </tr><tr><td>score</td><td><code>number</code></td><td></td><td><p>The score attributed by the model for that label.</p></td> </tr><tr><td>box</td><td><code>BoundingBox</code></td><td></td><td><p>The bounding box of detected object in image's original size, or as a percentage if <code>percentage</code> is set to true.</p></td> </tr><tr><td>[threshold]</td><td><code>number</code></td><td><code>0.9</code></td><td><p>The threshold used to filter boxes by score.</p></td> </tr><tr><td>[percentage]</td><td><code>boolean</code></td><td><code>false</code></td><td><p>Whether to return the boxes coordinates in percentage (true) or in pixels (false).</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ZeroShotObjectDetectionPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelineszeroshotobjectdetectionpipelinetype--code-promise--array--zeroshotobjectdetectionoutput--array--array--zeroshotobjectdetectionoutput-----code" 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="#pipelineszeroshotobjectdetectionpipelinetype--code-promise--array--zeroshotobjectdetectionoutput--array--array--zeroshotobjectdetectionoutput-----code"><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~ZeroShotObjectDetectionPipelineType ⇒ <code> Promise. < (Array < ZeroShotObjectDetectionOutput > \|Array < Array < ZeroShotObjectDetectionOutput > > ) > </code></span></h2> <p data-svelte-h="svelte-ficm91">Parameters specific to zero-shot object detection pipelines.</p> <p data-svelte-h="svelte-1886dy0"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(Array<ZeroShotObjectDetectionOutput>\|Array<Array<ZeroShotObjectDetectionOutput>>)></code> - An array of objects containing the predicted labels, scores, and bounding boxes.</p> <table data-svelte-h="svelte-hp09xx"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>images</td><td><code>ImagePipelineInputs</code></td><td><p>The input images.</p></td> </tr><tr><td>candidate_labels</td><td><code>Array.<string></code></td><td><p>What the model should recognize in the image.</p></td> </tr><tr><td>[options]</td><td><code>ZeroShotObjectDetectionPipelineOptions</code></td><td><p>The options to use for zero-shot object detection.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-1ev2uof"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>label</td><td><code>string</code></td><td></td><td><p>Text query corresponding to the found object.</p></td> </tr><tr><td>score</td><td><code>number</code></td><td></td><td><p>Score corresponding to the object (between 0 and 1).</p></td> </tr><tr><td>box</td><td><code>BoundingBox</code></td><td></td><td><p>Bounding box of the detected object in image's original size, or as a percentage if <code>percentage</code> is set to true.</p></td> </tr><tr><td>[threshold]</td><td><code>number</code></td><td><code>0.1</code></td><td><p>The probability necessary to make a prediction.</p></td> </tr><tr><td>[top_k]</td><td><code>number</code></td><td><code></code></td><td><p>The number of top predictions that will be returned by the pipeline.
	If the provided number is <code>null</code> or higher than the number of predictions available, it will default
	to the number of predictions.</p></td> </tr><tr><td>[percentage]</td><td><code>boolean</code></td><td><code>false</code></td><td><p>Whether to return the boxes coordinates in percentage (true) or in pixels (false).</p></td></tr></tbody></table> <hr> <a id="module_pipelines..DocumentQuestionAnsweringPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesdocumentquestionansweringpipelinetype--code-promise--documentquestionansweringoutputarray--documentquestionansweringoutput----code" 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="#pipelinesdocumentquestionansweringpipelinetype--code-promise--documentquestionansweringoutputarray--documentquestionansweringoutput----code"><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~DocumentQuestionAnsweringPipelineType ⇒ <code> Promise. < (DocumentQuestionAnsweringOutput\|Array < DocumentQuestionAnsweringOutput > ) > </code></span></h2> <p data-svelte-h="svelte-towoux"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(DocumentQuestionAnsweringOutput\|Array<DocumentQuestionAnsweringOutput>)></code> - An object (or array of objects) containing the answer(s).</p> <table data-svelte-h="svelte-196k7qb"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>image</td><td><code>ImageInput</code></td><td><p>The image of the document to use.</p></td> </tr><tr><td>question</td><td><code>string</code></td><td><p>A question to ask of the document.</p></td> </tr><tr><td>[options]</td><td><code></code></td><td><p>Additional keyword arguments to pass along to the generate method of the model.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-14s1ibx"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>answer</td><td><code>string</code></td><td><p>The generated text.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..TextToAudioPipelineConstructorArgs" class="group"></a> <h2 class="relative group"><a id="pipelinestexttoaudiopipelineconstructorargs--code-object-code" 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="#pipelinestexttoaudiopipelineconstructorargs--code-object-code"><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~TextToAudioPipelineConstructorArgs : <code> Object </code></span></h2> <p data-svelte-h="svelte-ptv3i7"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Properties</strong></p> <table data-svelte-h="svelte-10h9uf2"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>[vocoder]</td><td><code>PreTrainedModel</code></td><td><p>The vocoder used by the pipeline (if the model uses one). If not provided, use the default HifiGan vocoder.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..TextToAudioPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinestexttoaudiopipelinetype--code-promise--texttoaudiooutput--code" 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="#pipelinestexttoaudiopipelinetype--code-promise--texttoaudiooutput--code"><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~TextToAudioPipelineType ⇒ <code> Promise. < TextToAudioOutput > </code></span></h2> <p data-svelte-h="svelte-e3q3ck">Parameters specific to text-to-audio pipelines.</p> <p data-svelte-h="svelte-djs0r5"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<TextToAudioOutput></code> - An object containing the generated audio and sampling rate.</p> <table data-svelte-h="svelte-1tcwp3s"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>texts</td><td><code>string</code> \| <code>Array<string></code></td><td><p>The text(s) to generate.</p></td> </tr><tr><td>options</td><td><code>TextToAudioPipelineOptions</code></td><td><p>Parameters passed to the model generation/forward method.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-1c1ugfn"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th>Description</th></tr></thead> <tbody><tr><td>audio</td><td><code>Float32Array</code></td><td></td><td><p>The generated audio waveform.</p></td> </tr><tr><td>sampling_rate</td><td><code>number</code></td><td></td><td><p>The sampling rate of the generated audio waveform.</p></td> </tr><tr><td>[speaker_embeddings]</td><td><code><a href="#Tensor">Tensor</a></code> \| <code>Float32Array</code> \| <code>string</code> \| <code>URL</code></td><td><code></code></td><td><p>The speaker embeddings (if the model requires it).</p></td></tr></tbody></table> <hr> <a id="module_pipelines..ImageToImagePipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesimagetoimagepipelinetype--code-promise--rawimagearray--rawimage----code" 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="#pipelinesimagetoimagepipelinetype--code-promise--rawimagearray--rawimage----code"><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~ImageToImagePipelineType ⇒ <code> Promise. < (RawImage\|Array < RawImage > ) > </code></span></h2> <p data-svelte-h="svelte-qri2bt"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(RawImage\|Array<RawImage>)></code> - The transformed image or list of images.</p> <table data-svelte-h="svelte-1a5japr"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>images</td><td><code>ImagePipelineInputs</code></td><td><p>The images to transform.</p></td></tr></tbody></table> <hr> <a id="module_pipelines..DepthEstimationPipelineType" class="group"></a> <h2 class="relative group"><a id="pipelinesdepthestimationpipelinetype--code-promise--depthestimationpipelineoutputarray--depthestimationpipelineoutput----code" 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="#pipelinesdepthestimationpipelinetype--code-promise--depthestimationpipelineoutputarray--depthestimationpipelineoutput----code"><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~DepthEstimationPipelineType ⇒ <code> Promise. < (DepthEstimationPipelineOutput\|Array < DepthEstimationPipelineOutput > ) > </code></span></h2> <p data-svelte-h="svelte-1h3fxm6"><strong>Kind</strong>: inner typedef of <a href="#module_pipelines"><code>pipelines</code></a><br> <strong>Returns</strong>: <code>Promise.<(DepthEstimationPipelineOutput\|Array<DepthEstimationPipelineOutput>)></code> - An image or a list of images containing result(s).</p> <table data-svelte-h="svelte-15hpala"><thead><tr><th>Param</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>images</td><td><code>ImagePipelineInputs</code></td><td><p>The images to compute depth for.</p></td></tr></tbody></table> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <table data-svelte-h="svelte-3tu74i"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead> <tbody><tr><td>predicted_depth</td><td><code><a href="#Tensor">Tensor</a></code></td><td><p>The raw depth map predicted by the model.</p></td> </tr><tr><td>depth</td><td><code><a href="#RawImage">RawImage</a></code></td><td><p>The processed depth map as an image (with the same size as the input image).</p></td></tr></tbody></table> <hr> <a id="module_pipelines..AllTasks" class="group"></a> <h2 class="relative group"><a id="pipelinesalltasks--code--code" 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--code--code"><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 : <code> </code></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/docs/source/api/pipelines.md" target="_blank"><span data-svelte-h="svelte-1kd6by1"><</span> <span data-svelte-h="svelte-x0xyl0">></span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a> <p></p>

	<script>
	{
	__sveltekit_kuyevp = {
	assets: "/docs/transformers.js/pr_1113/en",
	base: "/docs/transformers.js/pr_1113/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/transformers.js/pr_1113/en/_app/immutable/entry/start.88a6e140.js"),
	import("/docs/transformers.js/pr_1113/en/_app/immutable/entry/app.0003020d.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 12],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 425 kB
Xet hash:: f3f001be6961bf3e6498c6446e5f709ad04897ed2007c14020abfc3db06215d8

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