com.rest.huggingface

com.rest.huggingface

Неофициальный клиент Restful Huggingface для игрового двигателя Unity.

Я не связан с HuggingFace, и требуется учетная запись с API -доступом.

Все авторские права, товарные знаки, логотипы и активы являются собственностью их соответствующих владельцев.

Установка

Требуется Unity 2021.3 LTS или выше.

Рекомендуемый метод установки - это хотя диспетчер пакетов Unity и OpenUpm.

Через диспетчер пакетов Unity и OpenUpm

• Откройте настройки проекта Unity
• Выберите Package Manager
• Добавить реестр пакетов OpenUpm:
  • Имя: OpenUPM
  • URL: https://package.openupm.com
  • Область (ы):
    • com.rest.huggingface
    • com.utilities
• Откройте окно менеджера Unity Package
• Изменить реестр с единства на My Registries
• Добавить пакет HuggingFace

Через диспетчер пакетов Unity и jit url

• Откройте менеджер по пакетам Unity
• Добавить пакет из url url: https://github.com/RageAgainstThePixel/com.rest.huggingface.git#upm

  Примечание: в этом репо зависите от других репозиториев! Вы несете ответственность за добавление их самостоятельно.

  • com.utility.async
  • com.utility.rest
  • com.utility.audio
  • com.utilities.encoder.wav

Документация

Оглавление

• Аутентификация
• Центр
• Вывод

Аутентификация

Есть 4 способа обеспечить ваши ключи API в порядке приоритета:

️ Мы рекомендовали использовать переменные среды для загрузки клавиши API вместо того, чтобы в вашем источнике. Не рекомендуется использовать этот метод в производстве, но только для принятия учетных данных пользователя, локального тестирования и быстрого начала сценариев.

1. Передайте ключи напрямую с конструктором ️
2. Объект Unity Scriptable ️
3. Загрузить клавишу из файла конфигурации
4. Используйте переменные системы системы

Передайте ключи напрямую с конструктором

 var api = new HuggingFaceClient ( " yourApiKey " ) ;

Или создать объект HuggingFaceAuthentication вручную

 var api = new HuggingFaceClient ( new HuggingFaceAuthentication ( " yourApiKey " ) ) ; 

Объект Unity Scriptable

Вы можете сохранить ключ непосредственно в сценарию, который находится в папке Assets/Resources .

Вы можете создать новый, используя контекстное меню панели Project и создав новый сценарий сценария HuggingFaceConfiguration .

Загрузить клавишу из файла конфигурации

Попытки загрузить клавиши API из файла конфигурации по умолчанию .huggingface в текущем каталоге, необязательно пройдя дерево каталогов или в домашнем каталоге пользователя.

Чтобы создать файл конфигурации, создайте новый текстовый файл с именем .huggingface и содержащей строку:

Формат JSON

{
  "apiKey" : " yourApiKey " ,
}

Вы также можете загрузить файл напрямую с помощью известного пути, вызывая статический метод в аутентификации:

 var api = new HuggingFaceClient ( new HuggingFaceAuthentication ( ) . LoadFromDirectory ( " your/path/to/.huggingface " ) ) ; ; 

Используйте переменные системы системы

Используйте переменные среды вашей системы. Укажите ключ API для использования.

• Используйте HUGGING_FACE_API_KEY для вашего ключа API.

 var api = new HuggingFaceClient ( new HuggingFaceAuthentication ( ) . LoadFromEnvironment ( ) ) ;

Центр

Тодо

Вывод

Тодо