Global refactoring

Update the app name, upload quantized model, update FAB colors, add instructions to the home screen

app/build.gradle

@@ -9,7 +9,7 @@ android {
     buildToolsVersion "30.0.3"
 
     defaultConfig {
-        applicationId "com.example.caption_assistant"
+        applicationId "com.example.image_tagger"
         minSdkVersion 27
         targetSdkVersion 30
         versionCode 1
@@ -78,8 +78,10 @@ dependencies {
     implementation  group: 'org.bytedeco', name: 'openblas', version: openBLASVersion, classifier: "android-x86"
     implementation  group: 'org.bytedeco', name: 'openblas', version: openBLASVersion, classifier: "android-x86_64"
 
-    implementation 'org.pytorch:pytorch_android:1.7.1'
-    implementation 'org.pytorch:pytorch_android_torchvision:1.7.1'
+    def pyTorchVersion = '1.7.1'
+
+    implementation "org.pytorch:pytorch_android:$pyTorchVersion"
+    implementation "org.pytorch:pytorch_android_torchvision:$pyTorchVersion"
 
     implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'
 

app/src/androidTest/java/com/example/caption_assistant/ExampleInstrumentedTest.kt → app/src/androidTest/java/com/example/image_tagger/ExampleInstrumentedTest.kt

@@ -1,4 +1,4 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4

app/src/main/AndroidManifest.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.example.caption_assistant">
+    package="com.example.image_tagger">
 
     <uses-permission
         android:name="android.permission.CAMERA" />
@@ -9,7 +9,7 @@
         android:required="false" />
 
     <application
-        android:name=".CaptionAssistant"
+        android:name="com.example.image_tagger.ImageTagger"
         android:allowBackup="true"
         android:fullBackupContent="@xml/backup_descriptor"
         android:icon="@mipmap/ic_launcher"
@@ -20,15 +20,15 @@
         android:theme="@style/Theme.CaptionAssistant">
 
         <activity
-            android:name=".MainActivity"
+            android:name="com.example.image_tagger.MainActivity"
             android:screenOrientation="portrait">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
         <activity
-            android:name=".CaptionActivity"
+            android:name="com.example.image_tagger.TaggerActivity"
             android:screenOrientation="portrait">
         </activity>
 

app/src/main/java/com/example/caption_assistant/CNN.kt → app/src/main/java/com/example/image_tagger/CNN.kt

@@ -1,4 +1,4 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 import android.graphics.Bitmap
 import kotlinx.coroutines.Dispatchers

app/src/main/java/com/example/caption_assistant/Constants.kt → app/src/main/java/com/example/image_tagger/Constants.kt

@@ -1,11 +1,11 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 object Constants {
     const val IMAGE_COUNTER_KEY = "ImageId"
     const val IMAGE_FILENAME = "Image"
     const val IMAGE_FOLDER_NAME = "Images"
-    const val CSV_NAME = "caption_assistant.csv"
-    const val DATABASE_NAME = "caption_assistant.db"
+    const val CSV_NAME = "image_tagger.csv"
+    const val DATABASE_NAME = "image_tagger.db"
     const val MODEL_NAME = "model.pt"
     const val NUM_CHANNELS = 3
     const val INPUT_HEIGHT = 256

app/src/main/java/com/example/caption_assistant/GaussianNaiveBayes.kt → app/src/main/java/com/example/image_tagger/GaussianNaiveBayes.kt

@@ -1,4 +1,4 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 import kotlinx.coroutines.*
 import org.nd4j.linalg.api.buffer.DataType
@@ -11,7 +11,7 @@ import kotlin.math.ln
 
 class GaussianNaiveBayes(private val coroutineScope: CoroutineScope) {
 
-    private fun calculatePosterior(
+    private fun calculateConditionalProba(
         x: INDArray, classStatistics: Statistics
     ): Float {
         return with(x.sub(classStatistics.mean)) {
@@ -25,10 +25,13 @@ class GaussianNaiveBayes(private val coroutineScope: CoroutineScope) {
         }
     }
 
-    private suspend fun calculatePosteriors(x: INDArray, statistics: List<Statistics>): Map<Int, Float> {
+    private suspend fun calculateConditionalProbas(x: INDArray, statistics: List<Statistics>): Map<Int, Float> {
         val (classIds, jobs) = statistics.map { classStatistics ->
             Pair(
-                classStatistics.cid, coroutineScope.async(Dispatchers.Default) { calculatePosterior(x, classStatistics) }
+                classStatistics.cid,
+                coroutineScope.async(Dispatchers.Default) {
+                    calculateConditionalProba(x, classStatistics)
+                }
             )
         }.unzip()
 
@@ -54,13 +57,13 @@ class GaussianNaiveBayes(private val coroutineScope: CoroutineScope) {
             }
             .toMap()
 
-        val posteriors = calculatePosteriors(x, statistics)
+        val conditionals = calculateConditionalProbas(x, statistics)
 
-        return (priors.keys + posteriors.keys)
+        return (priors.keys + conditionals.keys)
             .associateWith { classId ->
-                sequenceOf(priors[classId], posteriors[classId])
+                sequenceOf(priors[classId], conditionals[classId])
                     .filterNotNull()
-                    .reduce { prior, posterior -> prior + posterior }
+                    .reduce { prior, conditional -> prior + conditional }
             }
     }
 

app/src/main/java/com/example/caption_assistant/CaptionAssistant.kt → app/src/main/java/com/example/image_tagger/ImageTagger.kt

@@ -1,4 +1,4 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 import android.app.Application
 import android.content.Context
@@ -14,11 +14,11 @@ import org.nd4j.linalg.factory.Nd4j
 import java.io.File
 import java.io.FileOutputStream
 
-class CaptionAssistant : Application() {
+class ImageTagger : Application() {
 
     companion object {
         lateinit var mediaFolder: File
-        lateinit var db: CaptionDB
+        lateinit var db: TagsDB
         var cnn: CNN? = null
     }
 
@@ -28,7 +28,7 @@ class CaptionAssistant : Application() {
         db = Room
                 .databaseBuilder(
                         applicationContext,
-                        CaptionDB::class.java,
+                        TagsDB::class.java,
                         Constants.DATABASE_NAME
                 )
                 .allowMainThreadQueries()

app/src/main/java/com/example/caption_assistant/MainActivity.kt → app/src/main/java/com/example/image_tagger/MainActivity.kt

@@ -1,4 +1,4 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 import android.Manifest
 import android.content.Context
@@ -13,9 +13,11 @@ import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
 import android.widget.ImageView
+import android.widget.TextView
 import androidx.appcompat.app.AppCompatActivity
 import androidx.core.app.ActivityCompat
 import androidx.core.content.FileProvider
+import androidx.core.view.isVisible
 import androidx.recyclerview.widget.LinearLayoutManager
 import androidx.recyclerview.widget.RecyclerView
 import com.google.android.material.floatingactionbutton.FloatingActionButton
@@ -28,6 +30,7 @@ class MainActivity : AppCompatActivity() {
     private val permissionsRequired = listOf(Manifest.permission.CAMERA to Utils.Action.CAPTURE_IMAGE())
     private val imageExtensions = listOf("jpg", "png", "gif")
     private lateinit var imageFeed: RecyclerView
+    private lateinit var uploadImageText: TextView
     private lateinit var fabUpload: FloatingActionButton
     private lateinit var fabCamera: FloatingActionButton
     lateinit var listOfImages: MutableList<File>
@@ -48,6 +51,7 @@ class MainActivity : AppCompatActivity() {
         setContentView(R.layout.activity_main)
 
         imageFeed = findViewById(R.id.image_feed)
+        uploadImageText = findViewById(R.id.upload_image_text)
         fabUpload = findViewById(R.id.fab_upload)
         fabCamera = findViewById(R.id.fab_camera)
 
@@ -89,6 +93,7 @@ class MainActivity : AppCompatActivity() {
         }
         imageFeed.adapter = ImageListAdapter(this)
 
+        uploadImageText.isVisible = listOfImages.isEmpty()
 
         checkPermissions()
     }
@@ -112,6 +117,7 @@ class MainActivity : AppCompatActivity() {
             }
             listOfImages.clear()
             listOfImages.addAll(getImageFiles(imageDir).sorted())
+            uploadImageText.isVisible = listOfImages.isEmpty()
             imageFeed.adapter?.notifyDataSetChanged()
             imageFeed.layoutManager?.scrollToPosition(listOfImages.size - 1)
         }
@@ -160,7 +166,7 @@ class ImageListAdapter(private val parent: MainActivity) : RecyclerView.Adapter<
         init {
             imageView.setOnClickListener {
                 val imageUri = it.tag as Uri
-                val captionIntent = Intent(parent.baseContext, CaptionActivity::class.java)
+                val captionIntent = Intent(parent.baseContext, TaggerActivity::class.java)
                 captionIntent.putExtra("ImageURI", imageUri)
                 parent.startActivity(captionIntent)
             }

app/src/main/java/com/example/caption_assistant/Persistence.kt → app/src/main/java/com/example/image_tagger/Persistence.kt

@@ -1,4 +1,4 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 import androidx.room.*
 import com.daveanthonythomas.moshipack.MoshiPack
@@ -55,6 +55,6 @@ class Converters {
 
 @Database(entities = [Statistics::class], version = 2)
 @TypeConverters(Converters::class)
-abstract class CaptionDB : RoomDatabase() {
+abstract class TagsDB : RoomDatabase() {
     abstract fun statisticsDao(): StatisticsDao
 }

app/src/main/java/com/example/caption_assistant/TagChooserDialog.kt → app/src/main/java/com/example/image_tagger/TagChooserDialog.kt

@@ -1,4 +1,4 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 import android.app.Dialog
 import android.content.Context
@@ -13,7 +13,7 @@ import java.util.*
 
 class TagChooserDialog(context: Context) : Dialog(context) {
 
-    val parent: CaptionActivity = context as CaptionActivity
+    val parent: TaggerActivity = context as TaggerActivity
 
     private lateinit var tagList: ListView
     private lateinit var tagMapAdapter: TagMapAdapter

app/src/main/java/com/example/caption_assistant/CaptionActivity.kt → app/src/main/java/com/example/image_tagger/TaggerActivity.kt

@@ -1,4 +1,4 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 import android.net.Uri
 import android.os.Bundle
@@ -19,7 +19,7 @@ import org.nd4j.linalg.api.ndarray.INDArray
 import org.nd4j.linalg.factory.Nd4j
 import kotlin.coroutines.CoroutineContext
 
-class CaptionActivity : AppCompatActivity(), CoroutineScope by MainScope() {
+class TaggerActivity : AppCompatActivity(), CoroutineScope by MainScope() {
 
     private var imageUri: Uri? = null
     private var inferenceIsRunning = false
@@ -32,7 +32,7 @@ class CaptionActivity : AppCompatActivity(), CoroutineScope by MainScope() {
     private lateinit var confirmButton: Button
     private lateinit var predictionsChipGroup: ChipGroup
 
-    private val statsTable by lazy { CaptionAssistant.db.statisticsDao() }
+    private val statsTable by lazy { ImageTagger.db.statisticsDao() }
     private val gnb by lazy { GaussianNaiveBayes(this) }
 
     private lateinit var job: Job
@@ -43,7 +43,7 @@ class CaptionActivity : AppCompatActivity(), CoroutineScope by MainScope() {
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
-        setContentView(R.layout.activity_caption)
+        setContentView(R.layout.activity_tagger)
 
         imageView = findViewById(R.id.chosen_image)
         progressBar = findViewById(R.id.progress_bar)
@@ -66,7 +66,7 @@ class CaptionActivity : AppCompatActivity(), CoroutineScope by MainScope() {
             launch {
                 enableBackgroundTaskRunning()
 
-                with(TagChooserDialog(this@CaptionActivity)) {
+                with(TagChooserDialog(this@TaggerActivity)) {
                     title = "Choose appropriate tag"
                     setCanceledOnTouchOutside(false)
                     show()
@@ -85,7 +85,7 @@ class CaptionActivity : AppCompatActivity(), CoroutineScope by MainScope() {
                         .toMap()
                 )
 
-                hideKeyboard(this@CaptionActivity.currentFocus ?: View(this@CaptionActivity))
+                hideKeyboard(this@TaggerActivity.currentFocus ?: View(this@TaggerActivity))
                 finish()
             }
         }
@@ -117,7 +117,7 @@ class CaptionActivity : AppCompatActivity(), CoroutineScope by MainScope() {
                         bitmap?.let { bm ->
                             imageView.setImageBitmap(bm)
 
-                            CaptionAssistant.cnn?.let { cnn ->
+                            ImageTagger.cnn?.let { cnn ->
                                 val embeddingVector = cnn.forward(bm)
 
                                 val statistics = withContext(Dispatchers.IO) { statsTable.getStatistics() }
@@ -205,7 +205,7 @@ class CaptionActivity : AppCompatActivity(), CoroutineScope by MainScope() {
             setTitle("Interrupt running process?")
             setPositiveButton(android.R.string.ok) { _, _ ->
                 job.cancel()
-                this@CaptionActivity.disableBackgroundTaskRunning()
+                this@TaggerActivity.disableBackgroundTaskRunning()
             }
             setNegativeButton(android.R.string.cancel) { _, _ -> }
             show()

app/src/main/java/com/example/caption_assistant/Utils.kt → app/src/main/java/com/example/image_tagger/Utils.kt

@@ -1,4 +1,4 @@
-package com.example.caption_assistant
+package com.example.image_tagger
 
 import android.graphics.Bitmap
 import java.io.ByteArrayOutputStream

app/src/main/res/drawable/ic_baseline_add_circle_outline_24.xml

@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24"
+    android:tint="?attr/colorControlNormal">
+  <path
+      android:fillColor="@android:color/white"
+      android:pathData="M13,7h-2v4L7,11v2h4v4h2v-4h4v-2h-4L13,7zM12,2C6.48,2 2,6.48 2,12s4.48,10 10,10 10,-4.48 10,-10S17.52,2 12,2zM12,20c-4.41,0 -8,-3.59 -8,-8s3.59,-8 8,-8 8,3.59 8,8 -3.59,8 -8,8z"/>
+</vector>