com.rest.huggingface

com.rest.huggingface

Klien RESTFACE HUGGINGFACE yang tidak resmi untuk Unity Game Engine.

Saya tidak berafiliasi dengan Huggingface dan akun dengan API Access diperlukan.

Semua hak cipta, merek dagang, logo, dan aset adalah milik pemiliknya masing -masing.

Menginstal

Membutuhkan persatuan 2021.3 LTS atau lebih tinggi.

Metode instalasi yang disarankan adalah meskipun Unity Package Manager dan OpenUpm.

Via Unity Package Manager dan OpenUpm

• Buka Pengaturan Proyek Persatuan Anda
• Pilih Package Manager
• Tambahkan Paket OpenUpm Registry:
  • Nama: OpenUPM
  • URL: https://package.openupm.com
  • Lingkup:
    • com.rest.huggingface
    • com.utilities
• Buka jendela Unity Package Manager
• Ubah registri dari persatuan ke My Registries
• Tambahkan Paket HuggingFace

Via Unity Package Manager dan URL GIT

• Buka Manajer Paket Persatuan Anda
• Tambahkan paket dari URL git: https://github.com/RageAgainstThePixel/com.rest.huggingface.git#upm

  Catatan: Repo ini memiliki dependensi pada repositori lain! Anda bertanggung jawab untuk menambahkan ini sendiri.

  • com.utilities.async
  • com.utilities.rest
  • com.utilities.Audio
  • com.utilities.encoder.wav

Dokumentasi

Daftar isi

• Otentikasi
• Pusat
• Kesimpulan

Otentikasi

Ada 4 cara untuk memberikan kunci API Anda, dalam urutan prioritas:

️ Kami merekomendasikan menggunakan variabel lingkungan untuk memuat kunci API alih -alih memiliki kode keras di sumber Anda. Tidak disarankan menggunakan metode ini dalam produksi, tetapi hanya untuk menerima kredensial pengguna, pengujian lokal dan skenario start cepat.

1. Lulus kunci langsung dengan konstruktor ️
2. Objek Unityable Scriptable ️
3. Muat tombol dari file konfigurasi
4. Gunakan variabel lingkungan sistem

Lulus kunci langsung dengan konstruktor

 var api = new HuggingFaceClient ( " yourApiKey " ) ;

Atau membuat objek HuggingFaceAuthentication secara manual

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

Objek Unityable Scriptable

Anda dapat menyimpan kunci langsung ke objek skrip yang terletak di folder Assets/Resources .

Anda dapat membuat yang baru dengan menggunakan menu konteks panel Project dan membuat objek skrip HuggingFaceConfiguration baru.

Muat tombol dari file konfigurasi

Upaya memuat tombol API dari file konfigurasi, secara default .huggingface di direktori saat ini, secara opsional melintasi pohon direktori atau di direktori home pengguna.

Untuk membuat file konfigurasi, buat file teks baru bernama .huggingface dan berisi baris:

Format JSON

{
  "apiKey" : " yourApiKey " ,
}

Anda juga dapat memuat file secara langsung dengan jalur yang diketahui dengan memanggil metode statis dalam otentikasi:

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

Gunakan variabel lingkungan sistem

Gunakan variabel lingkungan sistem Anda Tentukan kunci API untuk digunakan.

• Gunakan HUGGING_FACE_API_KEY untuk kunci API Anda.

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

Pusat

Todo

Kesimpulan

Todo