feat(huggingface): add support for HuggingFace (#256)

Blarc · Blarc · commit fa2ad4a49b20 · 2024-10-08T20:29:30.000+02:00
Closes #256
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### Added
+
+- Support for Hugging Face.
+
 ## [2.5.0] - 2024-09-22
 
 ### Added
diff --git a/README.md b/README.md
@@ -39,6 +39,7 @@ plugin and configure a LLM API client in plugin's settings: <kbd>Settings</kbd>
 - Anthropic
 - Azure Open AI
 - Gemini
+- Hugging Face
 - Open AI
 - Ollama
 - Qianfan (Ernie)
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -108,6 +108,7 @@ dependencies {
     implementation("dev.langchain4j:langchain4j-vertex-ai-gemini")
     implementation("dev.langchain4j:langchain4j-anthropic")
     implementation("dev.langchain4j:langchain4j-azure-open-ai")
+    implementation("dev.langchain4j:langchain4j-hugging-face")
 
     // tests
     testImplementation("org.junit.jupiter:junit-jupiter-params:5.11.2")
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/Icons.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/Icons.kt
@@ -10,4 +10,5 @@ object Icons {
     val GEMINI = IconLoader.getIcon("/icons/gemini.png", javaClass)
     val ANTHROPIC = IconLoader.getIcon("/icons/anthropic.svg", javaClass)
     val AZURE_OPEN_AI = IconLoader.getIcon("/icons/azureOpenAi.svg", javaClass)
+    val HUGGING_FACE = IconLoader.getIcon("/icons/huggingface.svg", javaClass)
 }
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/AppSettings2.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/AppSettings2.kt
@@ -8,6 +8,7 @@ import com.github.blarc.ai.commits.intellij.plugin.settings.clients.LLMClientCon
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.anthropic.AnthropicClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.azureOpenAi.AzureOpenAiClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.gemini.GeminiClientConfiguration
+import com.github.blarc.ai.commits.intellij.plugin.settings.clients.huggingface.HuggingFaceClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.ollama.OllamaClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.openAi.OpenAiClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.openAi.OpenAiClientSharedState
@@ -57,7 +58,8 @@ class AppSettings2 : PersistentStateComponent<AppSettings2> {
             QianfanClientConfiguration::class,
             GeminiClientConfiguration::class,
             AnthropicClientConfiguration::class,
-            AzureOpenAiClientConfiguration::class
+            AzureOpenAiClientConfiguration::class,
+            HuggingFaceClientConfiguration::class
         ],
         style = XCollection.Style.v2
     )
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/LLMClientTable.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/LLMClientTable.kt
@@ -6,6 +6,7 @@ import com.github.blarc.ai.commits.intellij.plugin.settings.AppSettings2
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.anthropic.AnthropicClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.azureOpenAi.AzureOpenAiClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.gemini.GeminiClientConfiguration
+import com.github.blarc.ai.commits.intellij.plugin.settings.clients.huggingface.HuggingFaceClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.ollama.OllamaClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.openAi.OpenAiClientConfiguration
 import com.github.blarc.ai.commits.intellij.plugin.settings.clients.qianfan.QianfanClientConfiguration
@@ -149,7 +150,8 @@ class LLMClientTable {
                     QianfanClientConfiguration(),
                     GeminiClientConfiguration(),
                     AnthropicClientConfiguration(),
-                    AzureOpenAiClientConfiguration()
+                    AzureOpenAiClientConfiguration(),
+                    HuggingFaceClientConfiguration()
                 )
             } else {
                 listOf(newLLMClientConfiguration)
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/huggingface/HuggingFaceClientConfiguration.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/huggingface/HuggingFaceClientConfiguration.kt
@@ -0,0 +1,68 @@
+package com.github.blarc.ai.commits.intellij.plugin.settings.clients.huggingface;
+
+import com.github.blarc.ai.commits.intellij.plugin.Icons
+import com.github.blarc.ai.commits.intellij.plugin.settings.clients.LLMClientConfiguration
+import com.github.blarc.ai.commits.intellij.plugin.settings.clients.LLMClientSharedState
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vcs.ui.CommitMessage
+import com.intellij.util.xmlb.annotations.Attribute
+import com.intellij.util.xmlb.annotations.Transient
+import com.intellij.vcs.commit.AbstractCommitWorkflowHandler
+import dev.langchain4j.model.huggingface.HuggingFaceModelName
+import javax.swing.Icon
+
+class HuggingFaceClientConfiguration : LLMClientConfiguration(
+    "HuggingFace",
+    HuggingFaceModelName.TII_UAE_FALCON_7B_INSTRUCT,
+    "0.7"
+) {
+
+    @Attribute
+    var timeout: Int = 30
+    @Attribute
+    var maxNewTokens: Int = 30
+    @Attribute
+    var waitForModel: Boolean = true
+    @Attribute
+    var tokenIsStored: Boolean = false
+    @Transient
+    var token: String? = null
+
+    companion object {
+        const val CLIENT_NAME = "HuggingFace"
+    }
+
+    override fun getClientName(): String {
+        return CLIENT_NAME
+    }
+
+    override fun getClientIcon(): Icon {
+        return Icons.HUGGING_FACE
+    }
+
+    override fun getSharedState(): LLMClientSharedState {
+        return HuggingFaceClientSharedState.getInstance()
+    }
+
+    override fun generateCommitMessage(commitWorkflowHandler: AbstractCommitWorkflowHandler<*, *>, commitMessage: CommitMessage, project: Project) {
+        return HuggingFaceClientService.getInstance().generateCommitMessage(this, commitWorkflowHandler, commitMessage, project)
+
+    }
+
+    override fun getRefreshModelsFunction() = null
+
+    override fun clone(): LLMClientConfiguration {
+        val copy = HuggingFaceClientConfiguration()
+        copy.id = id
+        copy.name = name
+        copy.modelId = modelId
+        copy.temperature = temperature
+        copy.tokenIsStored = tokenIsStored
+        copy.timeout = timeout
+        copy.waitForModel = waitForModel
+        copy.maxNewTokens = maxNewTokens
+        return copy
+    }
+
+    override fun panel() = HuggingFaceClientPanel(this)
+}
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/huggingface/HuggingFaceClientPanel.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/huggingface/HuggingFaceClientPanel.kt
@@ -0,0 +1,86 @@
+package com.github.blarc.ai.commits.intellij.plugin.settings.clients.huggingface;
+
+import com.github.blarc.ai.commits.intellij.plugin.AICommitsBundle.message
+import com.github.blarc.ai.commits.intellij.plugin.emptyText
+import com.github.blarc.ai.commits.intellij.plugin.settings.clients.LLMClientPanel
+import com.intellij.ui.components.JBCheckBox
+import com.intellij.ui.components.JBPasswordField
+import com.intellij.ui.components.JBTextField
+import com.intellij.ui.dsl.builder.*
+
+class HuggingFaceClientPanel private constructor(
+    private val clientConfiguration: HuggingFaceClientConfiguration,
+    val service: HuggingFaceClientService
+) : LLMClientPanel(clientConfiguration) {
+
+    private val tokenPasswordField = JBPasswordField()
+    private val maxNewTokensTextField = JBTextField()
+    private val waitForModelCheckBox = JBCheckBox()
+
+    constructor(configuration: HuggingFaceClientConfiguration) : this(configuration, HuggingFaceClientService.getInstance())
+
+    override fun create() = panel {
+        nameRow()
+        timeoutRow(clientConfiguration::timeout)
+        tokenRow()
+        modelIdRow()
+        temperatureRow()
+        maxNewTokens()
+        waitForModel()
+        verifyRow()
+    }
+
+    override fun verifyConfiguration() {
+        // Configuration passed to panel is already a copy of the original or a new configuration
+        clientConfiguration.modelId = modelComboBox.item
+        clientConfiguration.temperature = temperatureTextField.text
+        clientConfiguration.timeout = socketTimeoutTextField.text.toInt()
+        clientConfiguration.modelId = modelComboBox.item
+        clientConfiguration.temperature = temperatureTextField.text
+        clientConfiguration.token = String(tokenPasswordField.password)
+        clientConfiguration.maxNewTokens = maxNewTokensTextField.text.toInt()
+        clientConfiguration.waitForModel = waitForModelCheckBox.isSelected
+        service.verifyConfiguration(clientConfiguration, verifyLabel)
+    }
+
+    private fun Panel.tokenRow() {
+        row {
+            label(message("settings.llmClient.token"))
+                .widthGroup("label")
+            cell(tokenPasswordField)
+                .bindText(getter = { "" }, setter = {
+                    HuggingFaceClientService.getInstance().saveToken(clientConfiguration, it)
+                })
+                .emptyText(if (clientConfiguration.tokenIsStored) message("settings.llmClient.token.stored") else message("settings.huggingface.token.example"))
+                .resizableColumn()
+                .align(Align.FILL)
+                // maxLineLength was eye-balled, but prevents the dialog getting wider
+                .comment(message("settings.huggingface.token.comment"), 50)
+        }
+    }
+
+    private fun Panel.maxNewTokens() {
+        row {
+            label(message("settings.huggingface.maxNewTokens"))
+                .widthGroup("label")
+            cell(maxNewTokensTextField)
+                .bindIntText(clientConfiguration::maxNewTokens)
+                .resizableColumn()
+                .align(Align.FILL)
+        }
+    }
+
+    private fun Panel.waitForModel() {
+        row {
+            label(message("settings.huggingface.waitForModel"))
+                .widthGroup("label")
+            cell(waitForModelCheckBox)
+                .bindSelected(clientConfiguration::waitForModel)
+                .resizableColumn()
+                .align(Align.FILL)
+
+            contextHelp(message("settings.huggingface.waitModel.comment"))
+                .align(AlignX.RIGHT)
+        }
+    }
+}
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/huggingface/HuggingFaceClientService.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/huggingface/HuggingFaceClientService.kt
@@ -0,0 +1,50 @@
+package com.github.blarc.ai.commits.intellij.plugin.settings.clients.huggingface;
+
+import com.github.blarc.ai.commits.intellij.plugin.AICommitsUtils.getCredentialAttributes
+import com.github.blarc.ai.commits.intellij.plugin.AICommitsUtils.retrieveToken
+import com.github.blarc.ai.commits.intellij.plugin.notifications.Notification
+import com.github.blarc.ai.commits.intellij.plugin.notifications.sendNotification
+import com.github.blarc.ai.commits.intellij.plugin.settings.clients.LLMClientService
+import com.intellij.ide.passwordSafe.PasswordSafe
+import com.intellij.openapi.components.Service
+import com.intellij.openapi.components.service
+import com.intellij.util.text.nullize
+import dev.langchain4j.model.chat.ChatLanguageModel
+import dev.langchain4j.model.huggingface.HuggingFaceChatModel
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+import java.time.Duration
+
+@Service(Service.Level.APP)
+class HuggingFaceClientService(private val cs: CoroutineScope) : LLMClientService<HuggingFaceClientConfiguration>(cs) {
+
+    companion object {
+        @JvmStatic
+        fun getInstance(): HuggingFaceClientService = service()
+    }
+
+    override suspend fun buildChatModel(client: HuggingFaceClientConfiguration): ChatLanguageModel {
+        val token = client.token.nullize(true) ?: retrieveToken(client.id)?.toString(true)
+
+        return HuggingFaceChatModel.builder()
+            .accessToken(token)
+            .modelId(client.modelId)
+            .temperature(client.temperature.toDouble())
+            .timeout(Duration.ofSeconds(client.timeout.toLong()))
+            .maxNewTokens(client.maxNewTokens)
+            .waitForModel(client.waitForModel)
+            .build()
+    }
+
+    fun saveToken(client: HuggingFaceClientConfiguration, token: String) {
+        cs.launch(Dispatchers.Default) {
+            try {
+                PasswordSafe.instance.setPassword(getCredentialAttributes(client.id), token)
+                client.tokenIsStored = true
+            } catch (e: Exception) {
+                sendNotification(Notification.unableToSaveToken(e.message))
+            }
+        }
+    }
+}
diff --git a/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/huggingface/HuggingFaceClientSharedState.kt b/src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/clients/huggingface/HuggingFaceClientSharedState.kt
@@ -0,0 +1,32 @@
+package com.github.blarc.ai.commits.intellij.plugin.settings.clients.huggingface;
+
+import com.github.blarc.ai.commits.intellij.plugin.settings.clients.LLMClientSharedState
+import com.intellij.openapi.components.*
+import com.intellij.util.xmlb.annotations.XCollection
+import dev.langchain4j.model.huggingface.HuggingFaceModelName
+
+@Service(Service.Level.APP)
+@State(name = "HuggingFaceClientSharedState", storages = [Storage("AICommitsHuggingFace.xml")])
+class HuggingFaceClientSharedState : PersistentStateComponent<HuggingFaceClientSharedState>, LLMClientSharedState {
+
+    companion object {
+        @JvmStatic
+        fun getInstance(): HuggingFaceClientSharedState = service()
+    }
+
+    @XCollection(style = XCollection.Style.v2)
+    override val hosts: MutableSet<String> = mutableSetOf()
+
+    @XCollection(style = XCollection.Style.v2)
+    override val modelIds: MutableSet<String> = mutableSetOf(
+        HuggingFaceModelName.TII_UAE_FALCON_7B_INSTRUCT
+    )
+
+    override fun getState(): HuggingFaceClientSharedState = this
+
+    override fun loadState(state: HuggingFaceClientSharedState) {
+        // Add all model IDs from enum in case they are not stored in xml
+        modelIds += state.modelIds
+        hosts += state.hosts
+    }
+}
diff --git a/src/main/resources/icons/huggingface.svg b/src/main/resources/icons/huggingface.svg
diff --git a/src/main/resources/messages/AiCommitsBundle.properties b/src/main/resources/messages/AiCommitsBundle.properties
@@ -100,3 +100,9 @@ settings.azureOpenAi.modelId=Deployment name
 settings.azureOpenAi.token=Key
 settings.azureOpenAi.token.example=a3cxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 settings.azureOpenAi.token.comment=This value can be found in the Keys and Endpoint section when examining your resource from the Azure portal. You can use either KEY1 or KEY2.
+
+settings.huggingface.token.comment=HuggingFace access token can be generated <a href="https://huggingface.co/settings/tokens">here</a>.
+settings.huggingface.token.example=hf_fKASPPYLkasgjasKwpSnAASRdasdCdAsddsASSDF
+settings.huggingface.maxNewTokens=Max new tokens
+settings.huggingface.waitForModel=Wait for model
+settings.huggingface.waitModel.comment=When a model is warm, it is ready to be used, and you will get a response relatively quickly. However, some models are cold and need to be loaded before they can be used. In that case, you will get a 503 error. Rather than doing many requests until it is loaded, you can wait for the model to be loaded.

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,5 @@ object Icons {`
`10`	`10`	`val GEMINI = IconLoader.getIcon("/icons/gemini.png", javaClass)`
`11`	`11`	`val ANTHROPIC = IconLoader.getIcon("/icons/anthropic.svg", javaClass)`
`12`	`12`	`val AZURE_OPEN_AI = IconLoader.getIcon("/icons/azureOpenAi.svg", javaClass)`
	`13`	`+ val HUGGING_FACE = IconLoader.getIcon("/icons/huggingface.svg", javaClass)`
`13`	`14`	`}`