clarifai2.dto.model.Model Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Clarifai Java API Client
The newest version!
package clarifai2.dto.model;

import clarifai2.internal.grpc.api.ModelOuterClass;
import clarifai2.api.BaseClarifaiClient;
import clarifai2.api.ClarifaiClient;
import clarifai2.api.request.ClarifaiPaginatedRequest;
import clarifai2.api.request.ClarifaiRequest;
import clarifai2.api.request.model.GetModelInputsRequest;
import clarifai2.api.request.model.GetModelRequest;
import clarifai2.api.request.model.PredictRequest;
import clarifai2.api.request.model.TrainModelRequest;
import clarifai2.dto.HasClarifaiIDRequired;
import clarifai2.dto.model.output_info.OutputInfo;
import clarifai2.dto.prediction.Prediction;
import clarifai2.exception.ClarifaiException;
import clarifai2.grpc.DateTimeConverter;
import clarifai2.internal.JSONAdapterFactory;
import clarifai2.internal.JSONObjectBuilder;
import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonNull;
import com.google.gson.JsonObject;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.reflect.TypeToken;
import com.kevinmost.auto.value.custom_hashcode_equals.adapter.IgnoreForHashCodeEquals;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Date;
import java.util.List;

import static clarifai2.internal.InternalUtil.clientInstance;
import static clarifai2.internal.InternalUtil.fromJson;
import static clarifai2.internal.InternalUtil.isJsonNull;
import static clarifai2.internal.InternalUtil.toJson;

@SuppressWarnings("NullableProblems")
@JsonAdapter(Model.Adapter.class)
public abstract class Model implements HasClarifaiIDRequired {

  private final String nonCompleteModelExceptionMessage
      = "This model is not complete and does not have this field. Use GetModelRequest to acquire a complete model.";

  Model() {} // AutoValue instances only

  @SuppressWarnings("unchecked")
  @NotNull
  public static > T _create(
      @NotNull ModelType modelType,
      @NotNull ClarifaiClient helper,
      @NotNull String id,
      @NotNull String name,
      @Nullable OutputInfo outputInfo
  ) {
    return _create(modelType, helper, id, name, outputInfo, null);
  }

  @SuppressWarnings("unchecked")
  @NotNull
  public static > T _create(
      @NotNull ModelType modelType,
      @NotNull ClarifaiClient helper,
      @NotNull String id,
      @NotNull String name,
      @Nullable OutputInfo outputInfo,
      @Nullable ModelVersion modelVersion
  ) {
    return ((T) getBuilder(modelType)
        .client(helper)
        .id(id)
        .name(name)
        ._outputInfo(outputInfo)
        ._modelVersion(modelVersion)
        .build());
  }

  @NotNull public GetModelRequest getModelRequest() {
    GetModelRequest request = client().getModelByID(id());
    if (_modelVersion() != null) {
      return request.withVersion(_modelVersion().id());
    }
    return request;
  }

  @NotNull private static Builder getBuilder(@NotNull ModelType modelType) {
    switch (modelType) {
      case CONCEPT:
        return new AutoValue_ConceptModel.Builder();
      case CLUSTER:
        return new AutoValue_ClusterModel.Builder();
      case COLOR:
        return new AutoValue_ColorModel.Builder();
      case EMBEDDING:
        return new AutoValue_EmbeddingModel.Builder();
      case FACE_EMBEDDING:
        return new AutoValue_FaceEmbeddingModel.Builder();
      case DETECT_CONCEPT:
        return new AutoValue_DetectionModel.Builder();
      case VIDEO:
        return new AutoValue_VideoModel.Builder();
      default:
        return new AutoValue_UnknownModel.Builder();
    }
  }

  public final boolean isConceptModel() {
    return this instanceof ConceptModel;
  }

  @NotNull public final ConceptModel asConceptModel() {
    return (ConceptModel) this;
  }

  public final boolean isColorModel() {
    return this instanceof ColorModel;
  }

  @NotNull public final ColorModel asColorModel() {
    return ((ColorModel) this);
  }

  public final boolean isEmbeddingModel() {
    return this instanceof EmbeddingModel;
  }

  @NotNull public final EmbeddingModel asEmbeddingModel() {
    return ((EmbeddingModel) this);
  }

  public final boolean isFaceEmbeddingModel() {
    return this instanceof FaceEmbeddingModel;
  }

  @NotNull public final FaceEmbeddingModel asFaceEmbeddingModel() {
    return ((FaceEmbeddingModel) this);
  }

  public final boolean isClusterModel() {
    return this instanceof ClusterModel;
  }

  @NotNull public final ClusterModel asClusterModel() {
    return ((ClusterModel) this);
  }

  @NotNull public final DetectionModel asDetectionModel() {
    return ((DetectionModel) this);
  }

  /*
   * AutoValue methods.
   */

  @IgnoreForHashCodeEquals @Nullable public abstract String name();

  @NotNull public abstract ModelType modelType();
  public static ModelType modelTypeStatic() { return ModelType.UNKNOWN; }

  @IgnoreForHashCodeEquals @Nullable abstract Date _createdAt();

  @IgnoreForHashCodeEquals @Nullable abstract String _appID();

  @Nullable abstract ModelVersion _modelVersion();

  @IgnoreForHashCodeEquals @Nullable abstract OutputInfo _outputInfo();

  @NotNull abstract ClarifaiClient client();

  /*
   * Improved getters to the AutoValue methods.
   */

  @NotNull public Date createdAt() {
    Date createdAt = _createdAt();
    if (createdAt == null) {
      throw new ClarifaiException(nonCompleteModelExceptionMessage);
    }
    return createdAt;
  }

  @NotNull public String appID() {
    String appID = _appID();
    if (appID == null) {
      throw new ClarifaiException(nonCompleteModelExceptionMessage);
    }
    return appID;
  }

  @NotNull public ModelVersion modelVersion() {
    ModelVersion modelVersion = _modelVersion();
    if (modelVersion == null) {
      throw new ClarifaiException(nonCompleteModelExceptionMessage);
    }
    return modelVersion;
  }

  @NotNull public OutputInfo outputInfo() {
    OutputInfo outputInfo = _outputInfo();
    if (outputInfo == null) {
      throw new ClarifaiException(nonCompleteModelExceptionMessage);
    }
    return outputInfo;
  }

  /*
   * Methods.
   */

  @NotNull public final GetModelInputsRequest getInputs() {
    return client().getModelInputs(id());
  }

  @NotNull public final ClarifaiPaginatedRequest> getVersions() {
    return client().getModelVersions(id());
  }

  @NotNull public final PredictRequest predict() {
    PredictRequest predict = client().predict(id());
    if (_modelVersion() != null) {
      predict.withVersion(_modelVersion());
    }
    return (PredictRequest) predict;
  }

  @NotNull public final ClarifaiRequest getVersionByID(@NotNull String versionID) {
    return client().getModelVersionByID(id(), versionID);
  }

  @NotNull public final ClarifaiRequest> deleteVersion(@NotNull ModelVersion version) {
    return deleteVersion(version.id());
  }

  @NotNull public final ClarifaiRequest> deleteVersion(@NotNull String versionID) {
    return client().deleteModelVersion(id(), versionID);
  }

  @NotNull public final TrainModelRequest train() {
    return client().trainModel(id());
  }

  protected interface Builder> {
    @NotNull B id(@NotNull String id);
    @NotNull B name(@NotNull String name);
    @NotNull B _createdAt(@Nullable Date createdAt);
    @NotNull B _appID(@Nullable String appID);
    @NotNull B _modelVersion(@Nullable ModelVersion modelVersion);
    @NotNull B _outputInfo(@Nullable OutputInfo _outputInfo);
    @NotNull B client(@Nullable ClarifaiClient client);
    @NotNull Model build();
  }

  @NotNull public static Model deserialize(ModelOuterClass.Model model, BaseClarifaiClient client) {
    ModelType modelType = ModelType.determineModelType(model.getOutputInfo());
    return getBuilder(modelType)
        .id(model.getId())
        .name(model.getName())
        ._createdAt(DateTimeConverter.timestampToDate(model.getCreatedAt()))
        ._appID(model.getAppId())
        ._modelVersion(ModelVersion.deserialize(model.getModelVersion()))
        ._outputInfo(model.hasOutputInfo() ? OutputInfo.deserialize(model.getOutputInfo()) : null)
        .client(client)
        .build();
  }

  @SuppressWarnings("rawtypes")
  static class Adapter extends JSONAdapterFactory {
    @Nullable @Override protected Serializer serializer() {
      return new Serializer() {
        @NotNull @Override public JsonElement serialize(@Nullable Model value, @NotNull Gson gson) {
          if (value == null) {
            return JsonNull.INSTANCE;
          }
          return new JSONObjectBuilder()
              .add("id", value.id())
              .add("name", value.name())
              .add("app_id", value._appID())
              .add("created_at", toJson(gson, value._createdAt(), Date.class))
              .add("model_version", toJson(gson, value._modelVersion(), ModelVersion.class))
              .add("output_info", toJson(gson, value._outputInfo(), OutputInfo.class))
              .build();
        }
      };
    }

    @Nullable @Override protected Deserializer deserializer() {
      return new Deserializer() {
        @Nullable @Override
        public Model deserialize(
            @NotNull JsonElement json,
            @NotNull TypeToken type,
            @NotNull Gson gson
        ) {
          final JsonObject root = json.getAsJsonObject();
          ModelType modelType = ModelType.determineModelType(root.get("output_info"));
          return getBuilder(modelType)
              .id(root.get("id").getAsString())
              .name(root.get("name").getAsString())
              ._createdAt(fromJson(gson, root.get("created_at"), Date.class))
              ._appID(isJsonNull(root.get("app_id")) ? null : root.get("app_id").getAsString())
              ._modelVersion(fromJson(gson, root.get("model_version"), ModelVersion.class))
              ._outputInfo(fromJson(gson, root.get("output_info"), OutputInfo.class))
              .client(clientInstance(gson))
              .build()
              ;
        }
      };
    }

    @NotNull @Override protected TypeToken typeToken() {
      return new TypeToken() {};
    }
  }
}