Remove extra parameters from the InferenceModel#copy

copyWeight and saveOptimizerState parameters are unused in the OnnxInferenceModel, and InferenceModel is not required to have a name, so copiedModelName does not always make sense as well. It's better to have a more generic copy method in the interface, and move these parameters to the appropriate implementing classes.
Kotlin · Dec 19, 2022 · 7df2a7c · 7df2a7c
1 parent b2b7af9
commit 7df2a7c
Show file tree

Hide file tree

Showing 15 changed files with 33 additions and 95 deletions.
diff --git a/api/src/main/kotlin/org/jetbrains/kotlinx/dl/api/inference/InferenceModel.kt b/api/src/main/kotlin/org/jetbrains/kotlinx/dl/api/inference/InferenceModel.kt
@@ -37,14 +37,9 @@ public interface InferenceModel : AutoCloseable {
     public fun reshape(vararg dims: Long)
 
     /**
-     * Creates a copy.
+     * Creates a copy of this model.
      *
-     * @param [copiedModelName] Set up this name to make a copy with a new name.
      * @return A copied inference model.
      */
-    public fun copy(
-        copiedModelName: String? = null,
-        saveOptimizerState: Boolean = false,
-        copyWeights: Boolean = true
-    ): InferenceModel
+    public fun copy(): InferenceModel
 }
diff --git a/examples/src/test/kotlin/examples/onnx/ModelCopyingTestSuite.kt b/examples/src/test/kotlin/examples/onnx/ModelCopyingTestSuite.kt
@@ -119,7 +119,7 @@ class ModelCopyingTestSuite {
             for (modelType in modelTypes) {
                 modelHub.loadPretrainedModel(modelType, LoadingMode.SKIP_LOADING_IF_EXISTS).use { model ->
                     @Suppress("UNCHECKED_CAST")
-                    (model.copy("model_copy") as M).use { modelCopy ->
+                    (model.copy() as M).use { modelCopy ->
 
                         val detectionResult = detect(model, imageFile)
                         val detectionResultCopy = detect(modelCopy, imageFile)

diff --git a/.../kotlin/org/jetbrains/kotlinx/dl/impl/inference/imagerecognition/ImageRecognitionModel.kt b/.../kotlin/org/jetbrains/kotlinx/dl/impl/inference/imagerecognition/ImageRecognitionModel.kt
@@ -78,13 +78,9 @@ public class ImageRecognitionModel(
         return predictObject(ImageConverter.toBufferedImage(imageFile))
     }
 
-    override fun copy(
-        copiedModelName: String?,
-        saveOptimizerState: Boolean,
-        copyWeights: Boolean
-    ): ImageRecognitionModel {
+    override fun copy(): ImageRecognitionModel {
         return ImageRecognitionModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
+            internalModel.copy(),
             inputColorMode,
             channelsFirst,
             preprocessor,

diff --git a/...idMain/kotlin/org/jetbrains/kotlinx/dl/onnx/inference/facealignment/FaceDetectionModel.kt b/...idMain/kotlin/org/jetbrains/kotlinx/dl/onnx/inference/facealignment/FaceDetectionModel.kt
@@ -40,11 +40,8 @@ public class FaceDetectionModel(
             .toFloatArray { layout = TensorLayout.NCHW }
             .call(ONNXModels.FaceDetection.defaultPreprocessor)
 
-    override fun copy(copiedModelName: String?, saveOptimizerState: Boolean, copyWeights: Boolean): InferenceModel {
-        return FaceDetectionModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
-            modelKindDescription
-        )
+    override fun copy(): InferenceModel {
+        return FaceDetectionModel(internalModel.copy(), modelKindDescription)
     }
 }
 

diff --git a/...otlin/org/jetbrains/kotlinx/dl/onnx/inference/facealignment/Fan2D106FaceAlignmentModel.kt b/...otlin/org/jetbrains/kotlinx/dl/onnx/inference/facealignment/Fan2D106FaceAlignmentModel.kt
@@ -41,11 +41,8 @@ public class Fan2D106FaceAlignmentModel(
         .rotate { degrees = targetRotation.toFloat() }
         .toFloatArray { layout = TensorLayout.NCHW }
 
-    override fun copy(copiedModelName: String?, saveOptimizerState: Boolean, copyWeights: Boolean): InferenceModel {
-        return Fan2D106FaceAlignmentModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
-            modelKindDescription
-        )
+    override fun copy(): InferenceModel {
+        return Fan2D106FaceAlignmentModel(internalModel.copy(), modelKindDescription)
     }
 }
 

diff --git a/onnx/src/commonMain/kotlin/org/jetbrains/kotlinx/dl/onnx/inference/OnnxInferenceModel.kt b/onnx/src/commonMain/kotlin/org/jetbrains/kotlinx/dl/onnx/inference/OnnxInferenceModel.kt
@@ -271,13 +271,8 @@ public open class OnnxInferenceModel private constructor(
         }
     }
 
-    override fun copy(
-        copiedModelName: String?,
-        saveOptimizerState: Boolean,
-        copyWeights: Boolean
-    ): OnnxInferenceModel {
+    override fun copy(): OnnxInferenceModel {
         val model = OnnxInferenceModel(modelSource)
-        model.name = copiedModelName
         if (inputShape != null) {
             model.reshape(*inputDimensions)
         }

diff --git a/...vmMain/kotlin/org/jetbrains/kotlinx/dl/onnx/inference/facealignment/FaceDetectionModel.kt b/...vmMain/kotlin/org/jetbrains/kotlinx/dl/onnx/inference/facealignment/FaceDetectionModel.kt
@@ -38,10 +38,7 @@ public class FaceDetectionModel(
             .toFloatArray { }
             .call(ONNXModels.FaceDetection.defaultPreprocessor)
 
-    override fun copy(copiedModelName: String?, saveOptimizerState: Boolean, copyWeights: Boolean): InferenceModel {
-        return FaceDetectionModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
-            modelKindDescription
-        )
+    override fun copy(): InferenceModel {
+        return FaceDetectionModel(internalModel.copy(), modelKindDescription)
     }
 }
diff --git a/...otlin/org/jetbrains/kotlinx/dl/onnx/inference/facealignment/Fan2D106FaceAlignmentModel.kt b/...otlin/org/jetbrains/kotlinx/dl/onnx/inference/facealignment/Fan2D106FaceAlignmentModel.kt
@@ -57,15 +57,8 @@ public class Fan2D106FaceAlignmentModel(
         return detectLandmarks(ImageConverter.toBufferedImage(imageFile))
     }
 
-    override fun copy(
-        copiedModelName: String?,
-        saveOptimizerState: Boolean,
-        copyWeights: Boolean
-    ): Fan2D106FaceAlignmentModel {
-        return Fan2D106FaceAlignmentModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
-            modelKindDescription
-        )
+    override fun copy(): Fan2D106FaceAlignmentModel {
+        return Fan2D106FaceAlignmentModel(internalModel.copy(), modelKindDescription)
     }
 }
 
diff --git a/...g/jetbrains/kotlinx/dl/onnx/inference/objectdetection/EfficientDetObjectDetectionModel.kt b/...g/jetbrains/kotlinx/dl/onnx/inference/objectdetection/EfficientDetObjectDetectionModel.kt
@@ -65,14 +65,7 @@ public class EfficientDetObjectDetectionModel(
         return detectObjects(ImageConverter.toBufferedImage(imageFile), topK)
     }
 
-    override fun copy(
-        copiedModelName: String?,
-        saveOptimizerState: Boolean,
-        copyWeights: Boolean
-    ): EfficientDetObjectDetectionModel {
-        return EfficientDetObjectDetectionModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
-            modelKindDescription
-        )
+    override fun copy(): EfficientDetObjectDetectionModel {
+        return EfficientDetObjectDetectionModel(internalModel.copy(), modelKindDescription)
     }
 }
diff --git a/...jetbrains/kotlinx/dl/onnx/inference/objectdetection/SSDMobileNetV1ObjectDetectionModel.kt b/...jetbrains/kotlinx/dl/onnx/inference/objectdetection/SSDMobileNetV1ObjectDetectionModel.kt
@@ -74,14 +74,7 @@ public class SSDMobileNetV1ObjectDetectionModel(
         return detectObjects(ImageConverter.toBufferedImage(imageFile), topK)
     }
 
-    override fun copy(
-        copiedModelName: String?,
-        saveOptimizerState: Boolean,
-        copyWeights: Boolean
-    ): SSDMobileNetV1ObjectDetectionModel {
-        return SSDMobileNetV1ObjectDetectionModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
-            modelKindDescription
-        )
+    override fun copy(): SSDMobileNetV1ObjectDetectionModel {
+        return SSDMobileNetV1ObjectDetectionModel(internalModel.copy(), modelKindDescription)
     }
 }
diff --git a/...kotlin/org/jetbrains/kotlinx/dl/onnx/inference/objectdetection/SSDObjectDetectionModel.kt b/...kotlin/org/jetbrains/kotlinx/dl/onnx/inference/objectdetection/SSDObjectDetectionModel.kt
@@ -103,15 +103,7 @@ public class SSDObjectDetectionModel(
         return foundObjects
     }
 
-
-    override fun copy(
-        copiedModelName: String?,
-        saveOptimizerState: Boolean,
-        copyWeights: Boolean
-    ): SSDObjectDetectionModel {
-        return SSDObjectDetectionModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
-            modelKindDescription
-        )
+    override fun copy(): SSDObjectDetectionModel {
+        return SSDObjectDetectionModel(internalModel.copy(), modelKindDescription)
     }
 }
diff --git a/...n/kotlin/org/jetbrains/kotlinx/dl/onnx/inference/posedetection/MultiPoseDetectionModel.kt b/...n/kotlin/org/jetbrains/kotlinx/dl/onnx/inference/posedetection/MultiPoseDetectionModel.kt
@@ -60,14 +60,7 @@ public class MultiPoseDetectionModel(
         return detectPoses(ImageConverter.toBufferedImage(imageFile), confidence)
     }
 
-    override fun copy(
-        copiedModelName: String?,
-        saveOptimizerState: Boolean,
-        copyWeights: Boolean
-    ): MultiPoseDetectionModel {
-        return MultiPoseDetectionModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
-            modelKindDescription
-        )
+    override fun copy(): MultiPoseDetectionModel {
+        return MultiPoseDetectionModel(internalModel.copy(), modelKindDescription)
     }
 }
diff --git a/.../kotlin/org/jetbrains/kotlinx/dl/onnx/inference/posedetection/SinglePoseDetectionModel.kt b/.../kotlin/org/jetbrains/kotlinx/dl/onnx/inference/posedetection/SinglePoseDetectionModel.kt
@@ -57,14 +57,7 @@ public class SinglePoseDetectionModel(
         return detectPose(ImageConverter.toBufferedImage(imageFile))
     }
 
-    override fun copy(
-        copiedModelName: String?,
-        saveOptimizerState: Boolean,
-        copyWeights: Boolean
-    ): SinglePoseDetectionModel {
-        return SinglePoseDetectionModel(
-            internalModel.copy(copiedModelName, saveOptimizerState, copyWeights),
-            modelKindDescription
-        )
+    override fun copy(): SinglePoseDetectionModel {
+        return SinglePoseDetectionModel(internalModel.copy(), modelKindDescription)
     }
 }
diff --git a/...orflow/src/main/kotlin/org/jetbrains/kotlinx/dl/api/inference/TensorFlowInferenceModel.kt b/...orflow/src/main/kotlin/org/jetbrains/kotlinx/dl/api/inference/TensorFlowInferenceModel.kt
@@ -146,10 +146,14 @@ public open class TensorFlowInferenceModel : InferenceModel {
         }
     }
 
-    override fun copy(
-        copiedModelName: String?,
-        saveOptimizerState: Boolean, // TODO, check this case
-        copyWeights: Boolean
+    override fun copy(): TensorFlowInferenceModel {
+        return copy(copiedModelName = null, saveOptimizerState = false, copyWeights = true)
+    }
+
+    public fun copy(
+        copiedModelName: String? = null,
+        saveOptimizerState: Boolean = false, // TODO, check this case
+        copyWeights: Boolean = true
     ): TensorFlowInferenceModel {
         val model = TensorFlowInferenceModel()
         model.kGraph = this.kGraph.copy()

diff --git a/...est/kotlin/org/jetbrains/kotlinx/dl/api/core/integration/TransferLearningFromKerasTest.kt b/...est/kotlin/org/jetbrains/kotlinx/dl/api/core/integration/TransferLearningFromKerasTest.kt
@@ -306,7 +306,7 @@ class TransferLearningTest : IntegrationTest() {
 
             it.loadWeights(hdfFile)
 
-            val copy = it.copy()
+            val copy = it.copy(saveOptimizerState = false, copyWeights = true)
             assertTrue(copy.layers.size == 11)
             copy.close()