Package clarifai2.dto.model

Class Model<PREDICTION extends Prediction>

java.lang.Object

clarifai2.dto.model.Model<PREDICTION>

All Implemented Interfaces:

HasClarifaiID, HasClarifaiIDRequired

Direct Known Subclasses:

ClusterModel, ColorModel, ConceptModel, DetectionModel, EmbeddingModel, FaceEmbeddingModel, UnknownModel, VideoModel

public abstract class Model<PREDICTION extends Prediction>
extends java.lang.Object
implements HasClarifaiIDRequired

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	Model.Builder<B extends Model.Builder<B>>

Method Summary

Modifier and Type	Method	Description
static <T extends Model<?>> T	_create(@NotNull ModelType modelType, @NotNull ClarifaiClient helper, @NotNull java.lang.String id, @NotNull java.lang.String name, @Nullable OutputInfo outputInfo)
static <T extends Model<?>> T	_create(@NotNull ModelType modelType, @NotNull ClarifaiClient helper, @NotNull java.lang.String id, @NotNull java.lang.String name, @Nullable OutputInfo outputInfo, @Nullable ModelVersion modelVersion)
@NotNull java.lang.String	appID()
@NotNull ClusterModel	asClusterModel()
@NotNull ColorModel	asColorModel()
@NotNull ConceptModel	asConceptModel()
@NotNull DetectionModel	asDetectionModel()
@NotNull EmbeddingModel	asEmbeddingModel()
@NotNull FaceEmbeddingModel	asFaceEmbeddingModel()
@NotNull java.util.Date	createdAt()
@NotNull ClarifaiRequest<java.util.List<ModelVersion>>	deleteVersion(@NotNull ModelVersion version)
@NotNull ClarifaiRequest<java.util.List<ModelVersion>>	deleteVersion(@NotNull java.lang.String versionID)
static @NotNull Model	deserialize(ModelOuterClass.Model model, BaseClarifaiClient client)
@NotNull GetModelInputsRequest	getInputs()
@NotNull GetModelRequest	getModelRequest()
@NotNull ClarifaiRequest<ModelVersion>	getVersionByID(@NotNull java.lang.String versionID)
@NotNull ClarifaiPaginatedRequest<java.util.List<ModelVersion>>	getVersions()
boolean	isClusterModel()
boolean	isColorModel()
boolean	isConceptModel()
boolean	isEmbeddingModel()
boolean	isFaceEmbeddingModel()
abstract @NotNull ModelType	modelType()
static ModelType	modelTypeStatic()
@NotNull ModelVersion	modelVersion()
abstract @Nullable java.lang.String	name()
@NotNull OutputInfo	outputInfo()
@NotNull PredictRequest<PREDICTION>	predict()
@NotNull TrainModelRequest	train()

Methods inherited from class java.lang.Object

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

Methods inherited from interface clarifai2.dto.HasClarifaiIDRequired

id

Method Detail

_create

@NotNull
public static <T extends Model<?>> T _create(@NotNull
                                             @NotNull ModelType modelType,
                                             @NotNull
                                             @NotNull ClarifaiClient helper,
                                             @NotNull
                                             @NotNull java.lang.String id,
                                             @NotNull
                                             @NotNull java.lang.String name,
                                             @Nullable
                                             @Nullable OutputInfo outputInfo)

_create

@NotNull
public static <T extends Model<?>> T _create(@NotNull
                                             @NotNull ModelType modelType,
                                             @NotNull
                                             @NotNull ClarifaiClient helper,
                                             @NotNull
                                             @NotNull java.lang.String id,
                                             @NotNull
                                             @NotNull java.lang.String name,
                                             @Nullable
                                             @Nullable OutputInfo outputInfo,
                                             @Nullable
                                             @Nullable ModelVersion modelVersion)

getModelRequest

@NotNull
public @NotNull GetModelRequest getModelRequest()

isConceptModel

public final boolean isConceptModel()

asConceptModel

@NotNull
public final @NotNull ConceptModel asConceptModel()

isColorModel

public final boolean isColorModel()

asColorModel

@NotNull
public final @NotNull ColorModel asColorModel()

isEmbeddingModel

public final boolean isEmbeddingModel()

asEmbeddingModel

@NotNull
public final @NotNull EmbeddingModel asEmbeddingModel()

isFaceEmbeddingModel

public final boolean isFaceEmbeddingModel()

asFaceEmbeddingModel

@NotNull
public final @NotNull FaceEmbeddingModel asFaceEmbeddingModel()

isClusterModel

public final boolean isClusterModel()

asClusterModel

@NotNull
public final @NotNull ClusterModel asClusterModel()

asDetectionModel

@NotNull
public final @NotNull DetectionModel asDetectionModel()

name

@Nullable
public abstract @Nullable java.lang.String name()

modelType

@NotNull
public abstract @NotNull ModelType modelType()

modelTypeStatic

public static ModelType modelTypeStatic()

createdAt

@NotNull
public @NotNull java.util.Date createdAt()

appID

@NotNull
public @NotNull java.lang.String appID()

modelVersion

@NotNull
public @NotNull ModelVersion modelVersion()

outputInfo

@NotNull
public @NotNull OutputInfo outputInfo()

getInputs

@NotNull
public final @NotNull GetModelInputsRequest getInputs()

getVersions

@NotNull
public final @NotNull ClarifaiPaginatedRequest<java.util.List<ModelVersion>> getVersions()

predict

@NotNull
public final @NotNull PredictRequest<PREDICTION> predict()

getVersionByID

@NotNull
public final @NotNull ClarifaiRequest<ModelVersion> getVersionByID(@NotNull
                                                                   @NotNull java.lang.String versionID)

deleteVersion

@NotNull
public final @NotNull ClarifaiRequest<java.util.List<ModelVersion>> deleteVersion(@NotNull
                                                                                  @NotNull ModelVersion version)

deleteVersion

@NotNull
public final @NotNull ClarifaiRequest<java.util.List<ModelVersion>> deleteVersion(@NotNull
                                                                                  @NotNull java.lang.String versionID)

train

@NotNull
public final @NotNull TrainModelRequest train()

deserialize

@NotNull
public static @NotNull Model deserialize(ModelOuterClass.Model model,
                                         BaseClarifaiClient client)