Merge pull request #19 from dev-diaries41/refactor/providers

Update IEmbeddingProvider interface

Author: dev-diaries41

CHANGELOG.md

@@ -1,7 +1,9 @@
-### v1.1.1 - 02/11/2025
+### v1.1.1 - 04/11/2025
 
 ### Added
 * Added new text embedding provider, Mini-LM
+*  Add `initialized` and `isInitialized` to `IEmbeddingProvider`"
+
 
 ### Changed
 * IEmbeddingProvider is require to provider `embeddingDim` variable (used to be optional)

core/src/main/java/com/fpf/smartscansdk/core/embeddings/IEmbeddingProvider.kt

@@ -5,6 +5,8 @@ import android.graphics.Bitmap
 
 interface IEmbeddingProvider<T> {
     val embeddingDim: Int
+    suspend fun initialize()
+    fun isInitialized(): Boolean
     fun closeSession() = Unit
     suspend fun embed(data: T): FloatArray
     suspend fun embedBatch(data: List<T>): List<FloatArray>

ml/src/main/java/com/fpf/smartscansdk/ml/models/providers/embeddings/clip/ClipImageEmbedder.kt

@@ -29,15 +29,15 @@ class ClipImageEmbedder(
     override val embeddingDim: Int = 512
     private var closed = false
 
-    suspend fun initialize() = model.loadModel()
+    override suspend fun initialize() = model.loadModel()
 
-    fun isInitialized() = model.isLoaded()
+    override fun isInitialized() = model.isLoaded()
 
-    override suspend fun embed(bitmap: Bitmap): FloatArray = withContext(Dispatchers.Default) {
+    override suspend fun embed(data: Bitmap): FloatArray = withContext(Dispatchers.Default) {
         if (!isInitialized()) throw IllegalStateException("Model not initialized")
 
         val inputShape = longArrayOf(ClipConfig.DIM_BATCH_SIZE.toLong(), ClipConfig.DIM_PIXEL_SIZE.toLong(), ClipConfig.IMAGE_SIZE_X.toLong(), ClipConfig.IMAGE_SIZE_Y.toLong())
-        val imgData: FloatBuffer = preProcess(bitmap)
+        val imgData: FloatBuffer = preProcess(data)
         val inputName = model.getInputNames()?.firstOrNull() ?: throw IllegalStateException("Model inputs not available")
         val output = model.run(mapOf(inputName to TensorData.FloatBufferTensor(imgData, inputShape)))
         normalizeL2((output.values.first() as Array<FloatArray>)[0])

ml/src/main/java/com/fpf/smartscansdk/ml/models/providers/embeddings/clip/ClipTextEmbedder.kt

@@ -42,9 +42,9 @@ class ClipTextEmbedder(
     override val embeddingDim: Int = 512
     private var closed = false
 
-    suspend fun initialize() = model.loadModel()
+    override suspend fun initialize() = model.loadModel()
 
-    fun isInitialized() = model.isLoaded()
+    override fun isInitialized() = model.isLoaded()
 
     override suspend fun embed(data: String): FloatArray = withContext(Dispatchers.Default) {
         if (!isInitialized()) throw IllegalStateException("Model not initialized")

ml/src/main/java/com/fpf/smartscansdk/ml/models/providers/embeddings/minilm/MiniLmTextEmbedder.kt

@@ -29,11 +29,11 @@ class MiniLMTextEmbedder(
     private var closed = false
     override val embeddingDim: Int = 384 // MiniLM-L6-v2 dimension
 
-    suspend fun initialize()  {
+    override suspend fun initialize()  {
         model.loadModel()
     }
 
-    fun isInitialized() = model.isLoaded()
+    override fun isInitialized() = model.isLoaded()
 
     override suspend fun embed(data: String): FloatArray = withContext(Dispatchers.Default) {
         if (!isInitialized()) throw IllegalStateException("Model not initialized")