Package ai.djl.modality.cv.translator

Class Sam2Translator

java.lang.Object

ai.djl.modality.cv.translator.Sam2Translator

All Implemented Interfaces:

NoBatchifyTranslator<Sam2Translator.Sam2Input,DetectedObjects>, PostProcessor<DetectedObjects>, PreProcessor<Sam2Translator.Sam2Input>, Translator<Sam2Translator.Sam2Input,DetectedObjects>

public class Sam2Translator
extends Object
implements NoBatchifyTranslator<Sam2Translator.Sam2Input,DetectedObjects>

A Translator that handles mask generation task.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Sam2Translator.Builder	The builder for Sam2Translator.
static final class	Sam2Translator.Sam2Input	A class represents the segment anything input.

Constructor Summary

Constructors

Constructor	Description
Sam2Translator(Sam2Translator.Builder builder)	Constructs a Sam2Translator instance.

Method Summary

Modifier and Type	Method	Description
static Sam2Translator.Builder	builder()	Creates a builder to build a Sam2Translator.
static Sam2Translator.Builder	builder(Map<String,?> arguments)	Creates a builder to build a Sam2Translator with specified arguments.
void	prepare(TranslatorContext ctx)	Prepares the translator with the manager and model to use.
NDList	processInput(TranslatorContext ctx, Sam2Translator.Sam2Input input)	Processes the input and converts it to NDList.
DetectedObjects	processOutput(TranslatorContext ctx, NDList list)	Processes the output NDList to the corresponding output object.

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.NoBatchifyTranslator

getBatchifier

Methods inherited from interface ai.djl.translate.Translator

batchProcessInput, batchProcessOutput, getExpansions

Constructor Details

Sam2Translator

public Sam2Translator(Sam2Translator.Builder builder)

Constructs a Sam2Translator instance.

Method Details

prepare

public void prepare(TranslatorContext ctx)
             throws IOException,
ModelException

Prepares the translator with the manager and model to use.

Specified by:

prepare in interface Translator<Sam2Translator.Sam2Input,DetectedObjects>

Parameters:

ctx - the context for the Predictor.

Throws:

IOException

ModelException

processInput

public NDList processInput(TranslatorContext ctx,
 Sam2Translator.Sam2Input input)
                    throws Exception

Processes the input and converts it to NDList.

Specified by:

processInput in interface PreProcessor<Sam2Translator.Sam2Input>

Parameters:

ctx - the toolkit for creating the input NDArray

input - the input object

Returns:

the NDList after pre-processing

Throws:

Exception - if an error occurs during processing input

processOutput

public DetectedObjects processOutput(TranslatorContext ctx,
 NDList list)

Processes the output NDList to the corresponding output object.

Specified by:

processOutput in interface PostProcessor<DetectedObjects>

Parameters:

ctx - the toolkit used for post-processing

list - the output NDList after inference, usually immutable in engines like PyTorch. @see Issue 1774

Returns:

the output object of expected type

builder

public static Sam2Translator.Builder builder()

Creates a builder to build a Sam2Translator.

Returns:

a new builder

builder

public static Sam2Translator.Builder builder(Map<String,?> arguments)

Creates a builder to build a Sam2Translator with specified arguments.

Parameters:

arguments - arguments to specify builder options

Returns:

a new builder