Package ai.djl.huggingface.translator

Class SparseRetrievalTranslator

java.lang.Object

ai.djl.huggingface.translator.SparseRetrievalTranslator

All Implemented Interfaces:

ai.djl.translate.PostProcessor<ai.djl.modality.nlp.EmbeddingOutput>, ai.djl.translate.PreProcessor<String>, ai.djl.translate.Translator<String,ai.djl.modality.nlp.EmbeddingOutput>

public class SparseRetrievalTranslator
extends Object
implements ai.djl.translate.Translator<String,ai.djl.modality.nlp.EmbeddingOutput>

The translator handles sparse retrieval for Huggingface text embedding model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SparseRetrievalTranslator.Builder	The builder for question answering translator.

Method Summary

Modifier and Type	Method	Description
ai.djl.ndarray.NDList	batchProcessInput(ai.djl.translate.TranslatorContext ctx, List<String> inputs)
List<ai.djl.modality.nlp.EmbeddingOutput>	batchProcessOutput(ai.djl.translate.TranslatorContext ctx, ai.djl.ndarray.NDList list)
static SparseRetrievalTranslator.Builder	builder(HuggingFaceTokenizer tokenizer, Map<String,?> arguments)	Creates a builder to build a SparseRetrievalTranslator.
void	prepare(ai.djl.translate.TranslatorContext ctx)
ai.djl.ndarray.NDList	processInput(ai.djl.translate.TranslatorContext ctx, String input)
ai.djl.modality.nlp.EmbeddingOutput	processOutput(ai.djl.translate.TranslatorContext ctx, ai.djl.ndarray.NDList list)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ai.djl.translate.Translator

getBatchifier, getExpansions

Method Details

prepare

public void prepare(ai.djl.translate.TranslatorContext ctx)
             throws Exception

Specified by:

prepare in interface ai.djl.translate.Translator<String,ai.djl.modality.nlp.EmbeddingOutput>

Throws:

Exception

processInput

public ai.djl.ndarray.NDList processInput(ai.djl.translate.TranslatorContext ctx,
 String input)

Specified by:

processInput in interface ai.djl.translate.PreProcessor<String>

batchProcessInput

public ai.djl.ndarray.NDList batchProcessInput(ai.djl.translate.TranslatorContext ctx,
 List<String> inputs)

Specified by:

batchProcessInput in interface ai.djl.translate.Translator<String,ai.djl.modality.nlp.EmbeddingOutput>

processOutput

public ai.djl.modality.nlp.EmbeddingOutput processOutput(ai.djl.translate.TranslatorContext ctx,
 ai.djl.ndarray.NDList list)

Specified by:

processOutput in interface ai.djl.translate.PostProcessor<ai.djl.modality.nlp.EmbeddingOutput>

batchProcessOutput

public List<ai.djl.modality.nlp.EmbeddingOutput> batchProcessOutput(ai.djl.translate.TranslatorContext ctx,
 ai.djl.ndarray.NDList list)

Specified by:

batchProcessOutput in interface ai.djl.translate.Translator<String,ai.djl.modality.nlp.EmbeddingOutput>

builder

public static SparseRetrievalTranslator.Builder builder(HuggingFaceTokenizer tokenizer,
 Map<String,?> arguments)

Creates a builder to build a SparseRetrievalTranslator.

Parameters:

tokenizer - the tokenizer

arguments - the models' arguments

Returns:

a new builder