Hugging Face Unity API 安裝與使用指南

Hugging Face Unity API 提供了 Hugging Face Inference API 的精簡整合，使 Unity 開發者能夠直接在遊戲專案中實作 AI 模型。此整合允許執行各種機器學習任務，且無需在本地端託管模型。

安裝流程

Hugging Face Unity API 透過 Unity Package Manager 使用 Git URL 以套件形式安裝。設定流程包括以下步驟：

  1. Package Addition: 在 Unity 專案中，前往 Window -> Package Manager，選取 Add Package from git URL，並輸入 https://github.com/huggingface/unity-api.git。
  2. Authentication: 安裝完成後，Hugging Face API Wizard（位於 Window -> Hugging Face API Wizard）需要 Hugging Face API 金鑰，可在使用者的帳號設定中產生。
  3. Configuration: 使用者可以在 wizard 中測試 API 金鑰，並可選擇性修改模型端點。若要更換模型，開發者可在 Hugging Face 網站上特定模型頁面的 Deploy -> Inference API 區段找到 API_URL。
  4. Examples: API Wizard 包含 Install Examples 選項，以提供開發者範例實作。

支援的 AI 任務與自訂模型

HuggingFaceAPI 類別提供針對各種機器學習任務的專屬方法。支援的任務包括：

  • Conversational AI: 對話
  • Text Generation: 文字生成
  • Visual Content: 文字轉圖像
  • Natural Language Processing: 文字分類、問答、翻譯與摘要
  • Audio Processing: 語音辨識

開發者可透過在 API Wizard 中更新模型端點，使用 Hugging Face 上託管的自訂模型，將其對應至特定模型的 Inference API URL。

實作範例：句子相似度

將 API 整合至 Unity 腳本需使用 HuggingFace.API 命名空間。由於 API 以非同步方式運作，會使用回呼函式處理成功與錯誤狀態。

句子相似度任務的範例實作：

using HuggingFace.API;

void Query() {
    string inputText = "I'm on my way to the forest.";
    string[] candidates = {
        "The player is going to the city",
        "The player is going to the wilderness",
        "The player is wandering aimlessly"
    };
    HuggingFaceAPI.SentenceSimilarity(inputText, OnSuccess, OnError, candidates);
}

void OnSuccess(float[] result) {
    foreach(float value in result) {
        Debug.Log(value);
    }
}

void OnError(string error) {
    Debug.LogError(error);
}

使用與效能最佳化

為確保在 Unity 環境中的穩定效能，開發者應遵守以下技術考量：

  • Asynchronous Execution: API 以非同步方式呼叫；回應與錯誤必須透過提供的回呼函式處理。
  • Latency Management: 若開發者遇到回應緩慢或效能瓶頸，建議切換至資源需求較低的模型端點。

Sources