HuggingFace provider implementation (#133)

* HuggingFace provider implementation | Patch 1

* HuggingFace provider implementation | Patch 2

Author: ShiftHackZ

app/build.gradle

@@ -17,9 +17,13 @@ android {
         versionName "0.5.7"
         versionCode 171
 
-        buildConfigField "String", "IMAGE_CDN_URL", "\"https://random.imagecdn.app\""
-        buildConfigField "String", "HORDE_AI_URL", "\"https://stablehorde.net\""
+        buildConfigField "String", "IMAGE_CDN_URL", "\"https://random.imagecdn.app/\""
+        buildConfigField "String", "HUGGING_FACE_URL", "\"https://huggingface.co/\""
+        buildConfigField "String", "HUGGING_FACE_INFERENCE_URL", "\"https://api-inference.huggingface.co/\""
+        buildConfigField "String", "HORDE_AI_URL", "\"https://stablehorde.net/\""
+
         buildConfigField "String", "HORDE_AI_SIGN_UP_URL", "\"https://stablehorde.net/register\""
+        buildConfigField "String", "HUGGING_FACE_INFO_URL", "\"https://huggingface.co/docs/api-inference/index\""
         buildConfigField "String", "UPDATE_API_URL", "\"https://sdai.moroz.cc\""
         buildConfigField "String", "DEMO_MODE_API_URL", "\"https://sdai.moroz.cc\""
         buildConfigField "String", "POLICY_URL", "\"https://sdai.moroz.cc/policy.html\""

app/src/main/java/com/shifthackz/aisdv1/app/di/ProvidersModule.kt

@@ -7,6 +7,7 @@ import com.shifthackz.aisdv1.core.common.appbuild.BuildVersion
 import com.shifthackz.aisdv1.core.common.file.FileProviderDescriptor
 import com.shifthackz.aisdv1.core.common.links.LinksProvider
 import com.shifthackz.aisdv1.core.common.schedulers.SchedulersProvider
+import com.shifthackz.aisdv1.domain.entity.ServerSource
 import com.shifthackz.aisdv1.domain.feature.auth.AuthorizationCredentials
 import com.shifthackz.aisdv1.domain.feature.auth.AuthorizationStore
 import com.shifthackz.aisdv1.domain.preference.PreferenceManager
@@ -15,7 +16,9 @@ import com.shifthackz.aisdv1.feature.diffusion.environment.DeviceNNAPIFlagProvid
 import com.shifthackz.aisdv1.feature.diffusion.environment.LocalModelIdProvider
 import com.shifthackz.aisdv1.network.qualifiers.ApiUrlProvider
 import com.shifthackz.aisdv1.network.qualifiers.CredentialsProvider
-import com.shifthackz.aisdv1.network.qualifiers.HordeApiKeyProvider
+import com.shifthackz.aisdv1.network.qualifiers.ApiKeyProvider
+import com.shifthackz.aisdv1.network.qualifiers.NetworkHeaders
+import com.shifthackz.aisdv1.network.qualifiers.NetworkPrefixes
 import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers
 import io.reactivex.rxjava3.core.Scheduler
 import io.reactivex.rxjava3.schedulers.Schedulers
@@ -28,6 +31,7 @@ import java.util.concurrent.Executors
  * Needed for retrofit builder, because it will crash at runtime if baseUrl is not set
  */
 private const val DEFAULT_SERVER_URL = "http://127.0.0.1"
+private const val DEFAULT_HORDE_API_KEY = "0000000000"
 
 val providersModule = module {
 
@@ -37,11 +41,26 @@ val providersModule = module {
             override val stableDiffusionAppApiUrl: String = BuildConfig.UPDATE_API_URL
             override val hordeApiUrl: String = BuildConfig.HORDE_AI_URL
             override val imageCdnApiUrl: String = BuildConfig.IMAGE_CDN_URL
+            override val huggingFaceApiUrl: String = BuildConfig.HUGGING_FACE_URL
+            override val huggingFaceInferenceApiUrl = BuildConfig.HUGGING_FACE_INFERENCE_URL
         }
     }
 
     single {
-        HordeApiKeyProvider { get<PreferenceManager>().hordeApiKey }
+        ApiKeyProvider {
+            val preference = get<PreferenceManager>()
+            when (preference.source) {
+                ServerSource.HORDE -> {
+                    val key = preference.hordeApiKey.takeIf(String::isNotEmpty) ?: DEFAULT_HORDE_API_KEY
+                    NetworkHeaders.API_KEY to key
+                }
+                ServerSource.HUGGING_FACE -> {
+                    val key = "${NetworkPrefixes.BEARER} ${preference.huggingFaceApiKey}"
+                    NetworkHeaders.AUTHORIZATION to key
+                }
+                else -> null
+            }
+        }
     }
 
     single<CredentialsProvider> {
@@ -63,6 +82,7 @@ val providersModule = module {
         object : LinksProvider {
             override val hordeUrl: String = BuildConfig.HORDE_AI_URL
             override val hordeSignUpUrl: String = BuildConfig.HORDE_AI_SIGN_UP_URL
+            override val huggingFaceUrl: String = BuildConfig.HUGGING_FACE_INFO_URL
             override val privacyPolicyUrl: String = BuildConfig.POLICY_URL
             override val gitHubSourceUrl: String = BuildConfig.GITHUB_SOURCE_URL
             override val setupInstructionsUrl: String = BuildConfig.SETUP_INSTRUCTIONS_URL

core/common/src/main/java/com/shifthackz/aisdv1/core/common/extensions/KotlinExtensions.kt

@@ -0,0 +1,6 @@
+package com.shifthackz.aisdv1.core.common.extensions
+
+inline fun <T> T.applyIf(predicate: Boolean, block: T.() -> Unit): T {
+    if (!predicate) return this
+    return apply(block)
+}

core/common/src/main/java/com/shifthackz/aisdv1/core/common/links/LinksProvider.kt

@@ -3,6 +3,7 @@ package com.shifthackz.aisdv1.core.common.links
 interface LinksProvider {
     val hordeUrl: String
     val hordeSignUpUrl: String
+    val huggingFaceUrl: String
     val privacyPolicyUrl: String
     val gitHubSourceUrl: String
     val setupInstructionsUrl: String

core/ui/src/main/java/com/shifthackz/aisdv1/core/contract/RxDisposableContract.kt

@@ -9,11 +9,13 @@ interface RxDisposableContract {
 
     infix operator fun CompositeDisposable.plus(d: Disposable) = this.add(compositeDisposable)
 
-    operator fun Disposable.not() {
+    operator fun Disposable.not(): Disposable {
         compositeDisposable.add(this)
+        return this
     }
 
-    fun Disposable.addToDisposable() {
+    fun Disposable.addToDisposable(): Disposable {
         compositeDisposable.add(this)
+        return this
     }
 }

data/src/main/java/com/shifthackz/aisdv1/data/di/LocalDataSourceModule.kt

@@ -4,6 +4,7 @@ import com.shifthackz.aisdv1.data.gateway.DatabaseClearGatewayImpl
 import com.shifthackz.aisdv1.data.gateway.mediastore.MediaStoreGatewayFactory
 import com.shifthackz.aisdv1.data.local.DownloadableModelLocalDataSource
 import com.shifthackz.aisdv1.data.local.GenerationResultLocalDataSource
+import com.shifthackz.aisdv1.data.local.HuggingFaceModelsLocalDataSource
 import com.shifthackz.aisdv1.data.local.ServerConfigurationLocalDataSource
 import com.shifthackz.aisdv1.data.local.StableDiffusionEmbeddingsLocalDataSource
 import com.shifthackz.aisdv1.data.local.StableDiffusionHyperNetworksLocalDataSource
@@ -12,6 +13,7 @@ import com.shifthackz.aisdv1.data.local.StableDiffusionModelsLocalDataSource
 import com.shifthackz.aisdv1.data.local.StableDiffusionSamplersLocalDataSource
 import com.shifthackz.aisdv1.domain.datasource.DownloadableModelDataSource
 import com.shifthackz.aisdv1.domain.datasource.GenerationResultDataSource
+import com.shifthackz.aisdv1.domain.datasource.HuggingFaceModelsDataSource
 import com.shifthackz.aisdv1.domain.datasource.ServerConfigurationDataSource
 import com.shifthackz.aisdv1.domain.datasource.StableDiffusionEmbeddingsDataSource
 import com.shifthackz.aisdv1.domain.datasource.StableDiffusionHyperNetworksDataSource
@@ -35,5 +37,6 @@ val localDataSourceModule = module {
     factoryOf(::ServerConfigurationLocalDataSource) bind ServerConfigurationDataSource.Local::class
     factoryOf(::GenerationResultLocalDataSource) bind GenerationResultDataSource.Local::class
     factoryOf(::DownloadableModelLocalDataSource) bind DownloadableModelDataSource.Local::class
+    factoryOf(::HuggingFaceModelsLocalDataSource) bind HuggingFaceModelsDataSource.Local::class
     factory { MediaStoreGatewayFactory(androidContext(), get()).invoke() }
 }

data/src/main/java/com/shifthackz/aisdv1/data/di/RemoteDataSourceModule.kt

@@ -6,6 +6,8 @@ import com.shifthackz.aisdv1.data.provider.ServerUrlProvider
 import com.shifthackz.aisdv1.data.remote.DownloadableModelRemoteDataSource
 import com.shifthackz.aisdv1.data.remote.HordeGenerationRemoteDataSource
 import com.shifthackz.aisdv1.data.remote.HordeStatusSource
+import com.shifthackz.aisdv1.data.remote.HuggingFaceGenerationRemoteDataSource
+import com.shifthackz.aisdv1.data.remote.HuggingFaceModelsRemoteDataSource
 import com.shifthackz.aisdv1.data.remote.RandomImageRemoteDataSource
 import com.shifthackz.aisdv1.data.remote.ServerConfigurationRemoteDataSource
 import com.shifthackz.aisdv1.data.remote.StableDiffusionEmbeddingsRemoteDataSource
@@ -16,6 +18,8 @@ import com.shifthackz.aisdv1.data.remote.StableDiffusionModelsRemoteDataSource
 import com.shifthackz.aisdv1.data.remote.StableDiffusionSamplersRemoteDataSource
 import com.shifthackz.aisdv1.domain.datasource.DownloadableModelDataSource
 import com.shifthackz.aisdv1.domain.datasource.HordeGenerationDataSource
+import com.shifthackz.aisdv1.domain.datasource.HuggingFaceGenerationDataSource
+import com.shifthackz.aisdv1.domain.datasource.HuggingFaceModelsDataSource
 import com.shifthackz.aisdv1.domain.datasource.RandomImageDataSource
 import com.shifthackz.aisdv1.domain.datasource.ServerConfigurationDataSource
 import com.shifthackz.aisdv1.domain.datasource.StableDiffusionEmbeddingsDataSource
@@ -47,6 +51,7 @@ val remoteDataSourceModule = module {
     }
     singleOf(::HordeStatusSource) bind HordeGenerationDataSource.StatusSource::class
     factoryOf(::HordeGenerationRemoteDataSource) bind HordeGenerationDataSource.Remote::class
+    factoryOf(::HuggingFaceGenerationRemoteDataSource) bind HuggingFaceGenerationDataSource.Remote::class
     factoryOf(::StableDiffusionGenerationRemoteDataSource) bind StableDiffusionGenerationDataSource.Remote::class
     factoryOf(::StableDiffusionSamplersRemoteDataSource) bind StableDiffusionSamplersDataSource.Remote::class
     factoryOf(::StableDiffusionModelsRemoteDataSource) bind StableDiffusionModelsDataSource.Remote::class
@@ -56,11 +61,12 @@ val remoteDataSourceModule = module {
     factoryOf(::ServerConfigurationRemoteDataSource) bind ServerConfigurationDataSource.Remote::class
     factoryOf(::RandomImageRemoteDataSource) bind RandomImageDataSource.Remote::class
     factoryOf(::DownloadableModelRemoteDataSource) bind DownloadableModelDataSource.Remote::class
+    factoryOf(::HuggingFaceModelsRemoteDataSource) bind HuggingFaceModelsDataSource.Remote::class
 
     factory<ServerConnectivityGateway> {
         val lambda: () -> Boolean = {
             val prefs = get<PreferenceManager>()
-            prefs.source == ServerSource.CUSTOM
+            prefs.source == ServerSource.AUTOMATIC1111
         }
         val monitor = get<ConnectivityMonitor> { parametersOf(lambda) }
         ServerConnectivityGatewayImpl(monitor, get())

data/src/main/java/com/shifthackz/aisdv1/data/di/RepositoryModule.kt

@@ -5,6 +5,8 @@ import android.os.PowerManager
 import com.shifthackz.aisdv1.data.repository.DownloadableModelRepositoryImpl
 import com.shifthackz.aisdv1.data.repository.GenerationResultRepositoryImpl
 import com.shifthackz.aisdv1.data.repository.HordeGenerationRepositoryImpl
+import com.shifthackz.aisdv1.data.repository.HuggingFaceGenerationRepositoryImpl
+import com.shifthackz.aisdv1.data.repository.HuggingFaceModelsRepositoryImpl
 import com.shifthackz.aisdv1.data.repository.LocalDiffusionGenerationRepositoryImpl
 import com.shifthackz.aisdv1.data.repository.RandomImageRepositoryImpl
 import com.shifthackz.aisdv1.data.repository.ServerConfigurationRepositoryImpl
@@ -19,6 +21,8 @@ import com.shifthackz.aisdv1.data.repository.WakeLockRepositoryImpl
 import com.shifthackz.aisdv1.domain.repository.DownloadableModelRepository
 import com.shifthackz.aisdv1.domain.repository.GenerationResultRepository
 import com.shifthackz.aisdv1.domain.repository.HordeGenerationRepository
+import com.shifthackz.aisdv1.domain.repository.HuggingFaceGenerationRepository
+import com.shifthackz.aisdv1.domain.repository.HuggingFaceModelsRepository
 import com.shifthackz.aisdv1.domain.repository.LocalDiffusionGenerationRepository
 import com.shifthackz.aisdv1.domain.repository.RandomImageRepository
 import com.shifthackz.aisdv1.domain.repository.ServerConfigurationRepository
@@ -46,6 +50,7 @@ val repositoryModule = module {
     singleOf(::TemporaryGenerationResultRepositoryImpl) bind TemporaryGenerationResultRepository::class
     factoryOf(::LocalDiffusionGenerationRepositoryImpl) bind LocalDiffusionGenerationRepository::class
     factoryOf(::HordeGenerationRepositoryImpl) bind HordeGenerationRepository::class
+    factoryOf(::HuggingFaceGenerationRepositoryImpl) bind HuggingFaceGenerationRepository::class
     factoryOf(::StableDiffusionGenerationRepositoryImpl) bind StableDiffusionGenerationRepository::class
     factoryOf(::StableDiffusionModelsRepositoryImpl) bind StableDiffusionModelsRepository::class
     factoryOf(::StableDiffusionSamplersRepositoryImpl) bind StableDiffusionSamplersRepository::class
@@ -56,4 +61,5 @@ val repositoryModule = module {
     factoryOf(::GenerationResultRepositoryImpl) bind GenerationResultRepository::class
     factoryOf(::RandomImageRepositoryImpl) bind RandomImageRepository::class
     factoryOf(::DownloadableModelRepositoryImpl) bind DownloadableModelRepository::class
+    factoryOf(::HuggingFaceModelsRepositoryImpl) bind HuggingFaceModelsRepository::class
 }

data/src/main/java/com/shifthackz/aisdv1/data/local/HuggingFaceModelsLocalDataSource.kt

@@ -0,0 +1,21 @@
+package com.shifthackz.aisdv1.data.local
+
+import com.shifthackz.aisdv1.data.mappers.mapDomainToEntity
+import com.shifthackz.aisdv1.data.mappers.mapEntityToDomain
+import com.shifthackz.aisdv1.domain.datasource.HuggingFaceModelsDataSource
+import com.shifthackz.aisdv1.domain.entity.HuggingFaceModel
+import com.shifthackz.aisdv1.storage.db.persistent.dao.HuggingFaceModelDao
+import com.shifthackz.aisdv1.storage.db.persistent.entity.HuggingFaceModelEntity
+
+internal class HuggingFaceModelsLocalDataSource(
+    private val dao: HuggingFaceModelDao,
+) : HuggingFaceModelsDataSource.Local {
+
+    override fun getAll() = dao
+        .query()
+        .map(List<HuggingFaceModelEntity>::mapEntityToDomain)
+
+    override fun save(models: List<HuggingFaceModel>) = dao
+        .deleteAll()
+        .andThen(dao.insertList(models.mapDomainToEntity()))
+}

data/src/main/java/com/shifthackz/aisdv1/data/mappers/HuggingFaceModelMappers.kt

@@ -0,0 +1,37 @@
+package com.shifthackz.aisdv1.data.mappers
+
+import com.shifthackz.aisdv1.domain.entity.HuggingFaceModel
+import com.shifthackz.aisdv1.network.model.HuggingFaceModelRaw
+import com.shifthackz.aisdv1.storage.db.persistent.entity.HuggingFaceModelEntity
+
+//region RAW --> DOMAIN
+fun List<HuggingFaceModelRaw>.mapRawToDomain(): List<HuggingFaceModel> =
+    map(HuggingFaceModelRaw::mapRawToDomain)
+
+fun HuggingFaceModelRaw.mapRawToDomain(): HuggingFaceModel = with(this) {
+    HuggingFaceModel(
+        id = id ?: "",
+        name = name ?: "",
+        alias = alias ?: "",
+        source = source ?: ""
+    )
+}
+//endregion
+
+//region DOMAIN -> ENTITY
+fun List<HuggingFaceModel>.mapDomainToEntity(): List<HuggingFaceModelEntity> =
+    map(HuggingFaceModel::mapDomainToEntity)
+
+fun HuggingFaceModel.mapDomainToEntity(): HuggingFaceModelEntity = with(this) {
+    HuggingFaceModelEntity(id, name, alias, source)
+}
+//endregion
+
+//region ENTITY -> DOMAIN
+fun List<HuggingFaceModelEntity>.mapEntityToDomain(): List<HuggingFaceModel> =
+    map(HuggingFaceModelEntity::mapEntityToDomain)
+
+fun HuggingFaceModelEntity.mapEntityToDomain(): HuggingFaceModel = with(this) {
+    HuggingFaceModel(id, name, alias, source)
+}
+//endregion