move gpt2 in its own app

Author: Pierrci

gpt2/build.gradle

@@ -0,0 +1,57 @@
+apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android'
+apply plugin: 'kotlin-android-extensions'
+
+android {
+    compileSdkVersion 29
+    buildToolsVersion "29.0.2"
+
+
+    defaultConfig {
+        applicationId "co.huggingface.android_transformers.gpt2"
+        minSdkVersion 26
+        targetSdkVersion 29
+        versionCode 1
+        versionName "1.0"
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    aaptOptions {
+        noCompress "tflite"
+    }
+
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_1_8
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    sourceSets { main { assets.srcDirs = ['src/main/assets', 'src/main/assets/'] } }
+}
+
+apply from: 'download.gradle'
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
+    implementation 'androidx.appcompat:appcompat:1.1.0'
+    implementation 'androidx.core:core-ktx:1.1.0'
+    implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
+    testImplementation 'junit:junit:4.12'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
+
+    implementation 'org.tensorflow:tensorflow-lite:2.0.0'
+
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.2'
+    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.2'
+    implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.2.0-rc02'
+    implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.2.0-rc02'
+    implementation 'androidx.activity:activity-ktx:1.1.0-rc02'
+}

gpt2/download.gradle

@@ -0,0 +1,14 @@
+apply plugin: 'de.undercouch.download'
+
+task downloadLiteModel {
+    def downloadFiles = [
+//        'https://s3.amazonaws.com/models.huggingface.co/bert/distilbert-base-uncased-distilled-squad-384.tflite': 'model.tflite',
+    ]
+    downloadFiles.each { key, value ->
+      download {
+          src key
+          dest "$projectDir/src/main/assets/" + value
+          overwrite false
+      }
+    }
+}

gpt2/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

gpt2/src/androidTest/java/co/huggingface/android_transformers/gpt2/ExampleInstrumentedTest.kt

@@ -0,0 +1,24 @@
+package co.huggingface.android_transformers.gpt2
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+    @Test
+    fun useAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        assertEquals("co.huggingface.android_transformers.gpt2", appContext.packageName)
+    }
+}

gpt2/src/main/AndroidManifest.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    package="co.huggingface.android_transformers.gpt2">
+
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/AppTheme"
+        tools:ignore="GoogleAppIndexingWarning">
+        <activity android:name=".MainActivity">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>

gpt2/src/main/assets/.gitignore

@@ -0,0 +1 @@
+*.tflite

gpt2/src/main/java/co/huggingface/android_transformers/gpt2/MainActivity.kt

@@ -0,0 +1,38 @@
+package co.huggingface.android_transformers.gpt2
+
+import androidx.appcompat.app.AppCompatActivity
+import android.os.Bundle
+import android.os.Handler
+import android.os.HandlerThread
+import androidx.activity.viewModels
+import androidx.lifecycle.observe
+
+class MainActivity : AppCompatActivity() {
+    private val gpt2: co.huggingface.android_transformers.gpt2.ml.GPT2Client by viewModels()
+    private val handlerThread by lazy { HandlerThread("GPT2Client") }
+    private val handler by lazy {
+        handlerThread.start()
+        Handler(handlerThread.looper)
+    }
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_main)
+
+        handler.post {
+            gpt2.init()
+            val generation = gpt2.generate("My name is")
+
+            runOnUiThread {
+                generation.observe(this) {
+                    print(it)
+                }
+            }
+        }
+    }
+
+    override fun onDestroy() {
+        super.onDestroy()
+        handlerThread.quit()
+    }
+}

app/src/main/java/co/huggingface/android_transformers/gpt2/ml/GPT2Client.kt renamed to gpt2/src/main/java/co/huggingface/android_transformers/gpt2/ml/GPT2Client.kt

@@ -3,7 +3,10 @@ package co.huggingface.android_transformers.gpt2.ml
 import android.app.Application
 import android.util.JsonReader
 import androidx.lifecycle.AndroidViewModel
+import androidx.lifecycle.liveData
+import androidx.lifecycle.viewModelScope
 import co.huggingface.android_transformers.gpt2.tokenization.GPT2Tokenizer
+import kotlinx.coroutines.Dispatchers
 import org.tensorflow.lite.Interpreter
 import java.io.BufferedReader
 import java.io.FileInputStream
@@ -17,7 +20,7 @@ private const val SEQUENCE_LENGTH  = 64
 private const val VOCAB_SIZE       = 50257
 private const val NUM_HEAD         = 12
 private const val NUM_LITE_THREADS = 4
-private const val MODEL_PATH       = "gpt2-64.tflite"
+private const val MODEL_PATH       = "model.tflite"
 private const val VOCAB_PATH       = "gpt2-vocab.json"
 private const val MERGES_PATH      = "gpt2-merges.txt"
 
@@ -44,12 +47,10 @@ class GPT2Client(application: Application) : AndroidViewModel(application) {
         if (!::tflite.isInitialized) {
             tflite = loadModel()
         }
-
-        generate("My name is")
     }
 
-    fun generate(text: String, nbTokens: Int = 10) { // = liveData<String>(
-            //viewModelScope.coroutineContext+Dispatchers.Default) {
+    fun generate(text: String, nbTokens: Int = 10) = liveData<String>(
+            viewModelScope.coroutineContext+Dispatchers.Default) {
 
         val tokens = tokenizer.encode(text)
         repeat (nbTokens) {
@@ -85,8 +86,7 @@ class GPT2Client(application: Application) : AndroidViewModel(application) {
 
             tokens.add(nextToken)
             val decodedToken = tokenizer.decode(listOf(nextToken))
-            print(decodedToken)
-//            emit(decodedToken)
+            emit(decodedToken)
         }
     }