如何安装和使用Hugging Face Unity API

Hugging Face Unity API的安装和使用方法

Hugging Face Unity API 是 Hugging Face 推出的一款易于使用的集成工具，可让开发者在 Unity 项目中访问和使用 Hugging Face AI 模型。在本博文中，我们将介绍安装和使用 Hugging Face Unity API 的步骤。

安装

1. 打开你的 Unity 项目
2. 进入 Window -> Package Manager
3. 点击 + 并选择 Add Package from git URL
4. 输入 https://github.com/huggingface/unity-api.git
5. 安装完成后，Unity API 向导窗口会弹出。如果没有弹出，可以进入 Window -> Hugging Face API Wizard

1. 输入你的 API 密钥。你可以在 Hugging Face 账户设置中创建 API 密钥。
2. 通过点击 API 向导中的 Test API key 来测试 API 密钥。
3. 如果需要，可以更改模型的端点来使用其他模型。任何支持推断 API 的模型的端点都可以在 Hugging Face 网站上的模型页面中找到，点击 Deploy -> Inference API ，并复制 API_URL 字段中的 URL。
4. 如果需要，可以根据需要配置高级设置。获取最新信息，请访问项目的代码库 https://github.com/huggingface/unity-api
5. 点击 Install Examples 查看如何使用 API 的示例。然后可以关闭 API 向导。

现在 API 已经设置完成，你可以在脚本中调用 API。下面是一个执行句子相似度任务的示例：

• StarCoder：一种用于代码的先进LLM
• 使用StarCoder创建一个编码助手
• 介绍RWKV – 具有Transformer优势的RNN

using HuggingFace.API;

/* 其他代码 */

// 调用 API
void Query() {
    string inputText = "我正在去森林的路上。";
    string[] candidates = {
        "玩家正在前往城市",
        "玩家正在前往荒野",
        "玩家正在漫无目的地徘徊"
    };
    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);
}

/* 其他代码 */

支持的任务和自定义模型

Hugging Face Unity API 当前还支持以下任务：

• 对话
• 文本生成
• 文本到图像
• 文本分类
• 问答
• 翻译
• 摘要
• 语音识别

可以使用 HuggingFaceAPI 类提供的相应方法来执行这些任务。

要使用你自己在 Hugging Face 上托管的自定义模型，请在 API 向导中更改模型的端点。

使用提示

1. 请记住，API 是异步调用的，会通过回调返回响应或错误。
2. 如果遇到响应缓慢或性能问题，请将模型端点更改为资源更低的模型。

总结

Hugging Face Unity API 提供了一种简单的方法将 AI 模型集成到 Unity 项目中。希望本教程能对你有所帮助。如果有任何问题或想要更多地参与使用 Hugging Face 用于游戏开发，请加入 Hugging Face Discord！