Hub Python Library documentation

Kurulum

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Kurulum

Başlamadan önce, uygun paketleri kurarak ortamınızı yapılandırmalısınız.

huggingface_hub, Python 3.10+ üzerinde test edilir.

pip ile kurulum

huggingface_hub paketini bir sanal ortamda kurmanız şiddetle önerilir. Python sanal ortamlarıyla ilgili deneyiminiz yoksa bu kılavuza göz atın. Sanal ortam, farklı projeleri yönetmeyi kolaylaştırır ve bağımlılıklar arasındaki uyumluluk sorunlarını önler.

Proje dizininizde sanal bir ortam oluşturarak başlayın:

python -m venv .venv

Sanal ortamı etkinleştirin. Linux ve macOS'ta:

source .venv/bin/activate

Windows'ta sanal ortamı etkinleştirin:

.venv/Scripts/activate

Artık huggingface_hub paketini PyPi kayıtlı deposundan kurmaya hazırsınız:

pip install --upgrade huggingface_hub

Tamamlandıktan sonra, kurulumu kontrol edin doğru çalıştığından emin olun.

İsteğe bağlı bağımlılıkları yükleyin

huggingface_hub bağımlılıklarının bazıları, huggingface_hub çekirdek özelliklerinin çalıştırılması için gerekli olmadığından isteğe bağlıdır. Ancak isteğe bağlı bağımlılıklar yüklü değilse, huggingface_hub özelliklerinin bazıları kullanılamayabilir.

İsteğe bağlı bağımlılıkları pip aracılığıyla yükleyebilirsiniz:

# Install dependencies for both torch-specific and MCP-specific features.
pip install 'huggingface_hub[mcp,torch]'

huggingface_hub içindeki isteğe bağlı bağımlılıkların listesi aşağıdadır:

  • fastai, torch: çerçeveye özgü özellikleri çalıştırmak için bağımlılıklar.
  • dev: kütüphaneye katkıda bulunmak için gereken bağımlılıklar. testing (testleri çalıştırmak için), typing (tip denetleyicisini çalıştırmak için) ve quality (lint'leri çalıştırmak için) içerir.

Kaynaktan kur

Bazı durumlarda, huggingface_hub paketini doğrudan kaynak kodundan kurmak ilginç olabilir. Bu, en son kararlı sürüm yerine en güncel main sürümünü kullanmanızı sağlar. Örneğin, son resmi sürümden bu yana bir hata düzeltilmiş ancak yeni bir sürüm henüz yayımlanmamışsa, en son gelişmelerden haberdar kalmak için main sürümü faydalıdır.

Ancak bu, main sürümünün her zaman kararlı olmayabileceği anlamına gelir. main sürümünün çalışır durumda kalmasını sağlamaya çalışırız ve çoğu sorun genellikle birkaç saat veya bir gün içinde çözülür. Bir sorunla karşılaşırsanız, lütfen bir Issue açın ki daha da hızlı çözebilelim!

pip install git+https://github.com/huggingface/huggingface_hub

Kaynaktan yüklerken belirli bir dalı da belirtebilirsiniz. Henüz birleştirilmemiş yeni bir özellik veya hata düzeltmesini test etmek istiyorsanız bu işe yarar:

pip install git+https://github.com/huggingface/huggingface_hub@my-feature-branch

Tamamlandıktan sonra, kurulumu kontrol edin doğru çalıştığından emin olun.

Düzenlenebilir kurulum

Kaynaktan kurulum, düzenlenebilir bir kurulum yapmanıza olanak tanır. huggingface_hub projesine katkıda bulunmayı planlıyor ve koddaki değişiklikleri test etmeniz gerekiyorsa bu daha ileri düzey bir kurulumdur. Bunun için huggingface_hub projesinin yerel bir kopyasını bilgisayarınıza klonlamanız gerekir.

# First, clone repo locally
git clone https://github.com/huggingface/huggingface_hub.git

# Then, install with -e flag
cd huggingface_hub
pip install -e .

Bu komutlar, klonladığınız depoyu içeren klasörü Python kütüphane yollarınıza bağlar. Python artık normal kütüphane yollarının yanı sıra klonladığınız klasörün içine de bakar. Örneğin, Python paketleriniz genellikle ./.venv/lib/python3.13/site-packages/ dizinine kuruluyorsa, Python klonladığınız ./huggingface_hub/ klasörünü de arar.

Hugging Face CLI'yi yükleyin

Python ortamınıza dokunmadan hf CLI'yi kurmak için tek satırlık kurulum araçlarımızı kullanın:

macOS ve Linux'ta:

curl -LsSf https://hf.co/cli/install.sh | bash

Windows'ta:

powershell -ExecutionPolicy ByPass -c "irm https://hf.co/cli/install.ps1 | iex"

Mevcut bir kurulumu yükseltmek için hf update komutunu çalıştırın — bu komut, hf'in nasıl yüklendiğini (bağımsız kurulum aracı, Homebrew veya pip) algılar ve eşleşen komutu çalıştırır.

conda ile kurulum

Daha aşina olduğunuz bir yöntemle, huggingface_hub paketini conda-forge kanalını kullanarak da yükleyebilirsiniz:

conda install -c conda-forge huggingface_hub

Tamamlandıktan sonra, kurulumu kontrol edin doğru çalıştığından emin olun.

Kurulumu kontrol edin

Kurulumdan sonra, aşağıdaki komutu çalıştırarak huggingface_hub'ün düzgün çalıştığını kontrol edin:

python -c "from huggingface_hub import model_info; print(model_info('gpt2'))"

Bu komut, gpt2 modeli hakkında Hub'dan bilgi alır. Çıktı şu şekilde görünmelidir:

Model Name: gpt2
Tags: ['pytorch', 'tf', 'jax', 'tflite', 'rust', 'safetensors', 'gpt2', 'text-generation', 'en', 'doi:10.57967/hf/0039', 'transformers', 'exbert', 'license:mit', 'has_space']
Task: text-generation

Windows kısıtlamaları

İyi ML’yi her yerde demokratikleştirme hedefimizle, huggingface_hub’ü bir platformlar arası kütüphane olarak ve özellikle hem Unix tabanlı hem de Windows sistemlerinde doğru çalışacak şekilde tasarladık. Ancak huggingface_hub’ün Windows üzerinde çalıştırıldığında bazı kısıtlamaları vardır. Bilinen sorunların kapsamlı bir listesi aşağıdadır. Belgelenmemiş bir sorunla karşılaşırsanız lütfen Github’da bir sorun açarak bize bildirin.

  • huggingface_hub önbellek sistemi, Hub’dan indirilen dosyaları verimli bir şekilde önbelleğe almak için sembolik bağlantılara dayanır. Windows’ta sembolik bağlantıları etkinleştirmek için geliştirici modunu etkinleştirmeniz veya betiğinizi yönetici olarak çalıştırmanız gerekir. Etkinleştirilmezlerse önbellek sistemi yine de çalışır ancak optimize edilmemiş bir şekilde çalışır. Daha fazla ayrıntı için önbellek kısıtlamaları bölümünü okuyun.
  • Hub'daki dosya yolları özel karakterler içerebilir (ör. "path/to?/my/file"). Windows, özel karakterler konusunda daha kısıtlayıcıdır ve bu da bu dosyaların Windows'ta indirilmesini imkansız hale getirir. Umarız bu nadir bir durumdur. Bunun bir hata olduğunu düşünüyorsanız lütfen depo sahibine veya bir çözüm bulmamız için bize ulaşın.

Sonraki adımlar

Makinenizde huggingface_hub düzgün bir şekilde yüklendikten sonra, başlamak için ortam değişkenlerini yapılandırmak veya kılavuzlarımızdan birine göz atmak isteyebilirsiniz.

Update on GitHub