Throw RuntimeExceptions instead of AssertionError in ObjectDetector

PiperOrigin-RevId: 400353926

Author: lu-wang-g

tensorflow_lite_support/java/src/java/org/tensorflow/lite/task/vision/detector/ObjectDetector.java

@@ -96,8 +96,9 @@ public final class ObjectDetector extends BaseVisionTaskApi {
    *
    * @param modelPath path to the detection model with metadata in the assets
    * @throws IOException if an I/O error occurs when loading the tflite model
-   * @throws AssertionError if error occurs when creating {@link ObjectDetector} from the native
-   *     code
+   * @throws IllegalArgumentException if an argument is invalid
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
   public static ObjectDetector createFromFile(Context context, String modelPath)
       throws IOException {
@@ -109,8 +110,9 @@ public static ObjectDetector createFromFile(Context context, String modelPath)
    *
    * @param modelFile the detection model {@link File} instance
    * @throws IOException if an I/O error occurs when loading the tflite model
-   * @throws AssertionError if error occurs when creating {@link ObjectDetector} from the native
-   *     code
+   * @throws IllegalArgumentException if an argument is invalid
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
   public static ObjectDetector createFromFile(File modelFile) throws IOException {
     return createFromFileAndOptions(modelFile, ObjectDetectorOptions.builder().build());
@@ -122,10 +124,9 @@ public static ObjectDetector createFromFile(File modelFile) throws IOException {
    *
    * @param modelBuffer a direct {@link ByteBuffer} or a {@link MappedByteBuffer} of the detection
    *     model
-   * @throws AssertionError if error occurs when creating {@link ObjectDetector} from the native
-   *     code
    * @throws IllegalArgumentException if the model buffer is not a direct {@link ByteBuffer} or a
-   *     {@link MappedByteBuffer}
+   *     {@link MappedByteBuffer} * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
   public static ObjectDetector createFromBuffer(final ByteBuffer modelBuffer) {
     return createFromBufferAndOptions(modelBuffer, ObjectDetectorOptions.builder().build());
@@ -136,8 +137,9 @@ public static ObjectDetector createFromBuffer(final ByteBuffer modelBuffer) {
    *
    * @param modelPath path to the detection model with metadata in the assets
    * @throws IOException if an I/O error occurs when loading the tflite model
-   * @throws AssertionError if error occurs when creating {@link ObjectDetector} from the native
-   *     code
+   * @throws IllegalArgumentException if an argument is invalid
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
   public static ObjectDetector createFromFileAndOptions(
       Context context, String modelPath, ObjectDetectorOptions options) throws IOException {
@@ -170,8 +172,9 @@ public long createHandle(
    *
    * @param modelFile the detection model {@link File} instance
    * @throws IOException if an I/O error occurs when loading the tflite model
-   * @throws AssertionError if error occurs when creating {@link ObjectDetector} from the native
-   *     code
+   * @throws IllegalArgumentException if an argument is invalid
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
   public static ObjectDetector createFromFileAndOptions(
       File modelFile, final ObjectDetectorOptions options) throws IOException {
@@ -201,10 +204,10 @@ public long createHandle() {
    *
    * @param modelBuffer a direct {@link ByteBuffer} or a {@link MappedByteBuffer} of the detection
    *     model
-   * @throws AssertionError if error occurs when creating {@link ObjectDetector} from the native
-   *     code
    * @throws IllegalArgumentException if the model buffer is not a direct {@link ByteBuffer} or a
    *     {@link MappedByteBuffer}
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    */
   public static ObjectDetector createFromBufferAndOptions(
       final ByteBuffer modelBuffer, final ObjectDetectorOptions options) {
@@ -328,8 +331,8 @@ public Builder setScoreThreshold(float scoreThreshold) {
        *
        * <p>If non-empty, detection results whose label is not in this set will be filtered out.
        * Duplicate or unknown labels are ignored. Mutually exclusive with {@code labelDenyList}. It
-       * will cause {@link AssertionError} when calling {@link #createFromFileAndOptions}, if both
-       * {@code labelDenyList} and {@code labelAllowList} are set.
+       * will cause {@link IllegalStateException} when calling {@link #createFromFileAndOptions}, if
+       * both {@code labelDenyList} and {@code labelAllowList} are set.
        */
       public Builder setLabelAllowList(List<String> labelAllowList) {
         this.labelAllowList = Collections.unmodifiableList(new ArrayList<>(labelAllowList));
@@ -341,8 +344,8 @@ public Builder setLabelAllowList(List<String> labelAllowList) {
        *
        * <p>If non-empty, detection results whose label is in this set will be filtered out.
        * Duplicate or unknown labels are ignored. Mutually exclusive with {@code labelAllowList}. It
-       * will cause {@link AssertionError} when calling {@link #createFromFileAndOptions}, if both
-       * {@code labelDenyList} and {@code labelAllowList} are set.
+       * will cause {@link IllegalStateException} when calling {@link #createFromFileAndOptions}, if
+       * both {@code labelDenyList} and {@code labelAllowList} are set.
        */
       public Builder setLabelDenyList(List<String> labelDenyList) {
         this.labelDenyList = Collections.unmodifiableList(new ArrayList<>(labelDenyList));
@@ -435,7 +438,8 @@ private ObjectDetectorOptions(Builder builder) {
    * </ul>
    *
    * @param image a UINT8 {@link TensorImage} object that represents an RGB or YUV image
-   * @throws AssertionError if error occurs when processing the image from the native code
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    * @throws IllegalArgumentException if the color space type of image is unsupported
    */
   public List<Detection> detect(TensorImage image) {
@@ -464,7 +468,8 @@ public List<Detection> detect(TensorImage image) {
    *
    * @param image a UINT8 {@link TensorImage} object that represents an RGB or YUV image
    * @param options the options to configure how to preprocess the image
-   * @throws AssertionError if error occurs when processing the image from the native code
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    * @throws IllegalArgumentException if the color space type of image is unsupported
    */
   public List<Detection> detect(TensorImage image, ImageProcessingOptions options) {
@@ -484,7 +489,8 @@ public List<Detection> run(
    * Performs actual detection on the provided {@code MlImage}.
    *
    * @param image an {@code MlImage} object that represents an image
-   * @throws AssertionError if error occurs when processing the image from the native code
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    * @throws IllegalArgumentException if the storage type or format of the image is unsupported
    */
   public List<Detection> detect(MlImage image) {
@@ -504,7 +510,8 @@ public List<Detection> detect(MlImage image) {
    *
    * @param image an {@code MlImage} object that represents an image
    * @param options the options to configure how to preprocess the image
-   * @throws AssertionError if error occurs when classifying the image from the native code
+   * @throws IllegalStateException if there is an internal error
+   * @throws RuntimeException if there is an otherwise unspecified error
    * @throws IllegalArgumentException if the storage type or format of the image is unsupported
    */
   public List<Detection> detect(MlImage image, ImageProcessingOptions options) {

tensorflow_lite_support/java/src/native/task/vision/detector/object_detector_jni.cc

@@ -33,7 +33,7 @@ limitations under the License.
 namespace {
 
 using ::tflite::support::StatusOr;
-using ::tflite::support::utils::kAssertionError;
+using ::tflite::support::utils::GetExceptionClassNameForStatusCode;
 using ::tflite::support::utils::kInvalidPointer;
 using ::tflite::support::utils::StringListToVector;
 using ::tflite::support::utils::ThrowException;
@@ -42,7 +42,6 @@ using ::tflite::task::vision::BoundingBox;
 using ::tflite::task::vision::ConvertToCategory;
 using ::tflite::task::vision::DetectionResult;
 using ::tflite::task::vision::FrameBuffer;
-
 using ::tflite::task::vision::ObjectDetector;
 using ::tflite::task::vision::ObjectDetectorOptions;
 
@@ -162,13 +161,17 @@ jlong CreateObjectDetectorFromOptions(JNIEnv* env,
   if (object_detector_or.ok()) {
     return reinterpret_cast<jlong>(object_detector_or->release());
   } else {
-    ThrowException(env, kAssertionError,
-                   "Error occurred when initializing ObjectDetector: %s",
-                   object_detector_or.status().message().data());
+    ThrowException(
+        env,
+        GetExceptionClassNameForStatusCode(object_detector_or.status().code()),
+        "Error occurred when initializing ObjectDetector: %s",
+        object_detector_or.status().message().data());
     return kInvalidPointer;
   }
 }
 
+}  // namespace
+
 extern "C" JNIEXPORT void JNICALL
 Java_org_tensorflow_lite_task_vision_detector_ObjectDetector_deinitJni(
     JNIEnv* env, jobject thiz, jlong native_handle) {
@@ -221,10 +224,10 @@ Java_org_tensorflow_lite_task_vision_detector_ObjectDetector_detectNative(
   if (results_or.ok()) {
     return ConvertToDetectionResults(env, results_or.value());
   } else {
-    ThrowException(env, kAssertionError,
-                   "Error occurred when detecting the image: %s",
-                   results_or.status().message().data());
+    ThrowException(
+        env, GetExceptionClassNameForStatusCode(results_or.status().code()),
+        "Error occurred when detecting the image: %s",
+        results_or.status().message().data());
     return nullptr;
   }
 }
-}  // namespace