Hugging Face's logo

Transformers documentation

Ekstraktor fitur

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.2).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Ekstraktor fitur

Feature extractor bertanggung jawab untuk menyiapkan fitur input untuk model audio. Ini mencakup ekstraksi fitur dari sekuens, misalnya, pra-pemrosesan file audio untuk menghasilkan fitur Log-Mel Spectrogram, dan konversi ke tensor NumPy dan PyTorch.

FeatureExtractionMixin

kelas transformers.FeatureExtractionMixin

< >

( **kwargs )

Ini adalah mixin ekstraksi fitur yang digunakan untuk menyediakan fungsionalitas penyimpanan/pemuatan untuk ekstraktor fitur sekuensial dan audio.

from_pretrained

< >

( pretrained_model_name_or_path: str | os.PathLikecache_dir: str | os.PathLike | None = Noneforce_download: bool = Falselocal_files_only: bool = Falsetoken: str | bool | None = Nonerevision: str = 'main'**kwargs )

Parameter

  • pretrained_model_name_or_path (str atau os.PathLike) — Ini bisa berupa:
    • sebuah string, model id dari feature_extractor pretrained yang dihosting di dalam repo model di huggingface.co.
    • path ke direktori yang berisi file feature extractor yang disimpan menggunakan metode save_pretrained(), misalnya ./my_model_directory/.
    • path ke file JSON feature extractor yang disimpan file, misalnya ./my_model_directory/preprocessor_config.json.
  • cache_dir (str atau os.PathLike, opsional) — Path ke direktori tempat feature extractor model pretrained yang diunduh harus di-cache jika cache standar tidak digunakan.
  • force_download (bool, opsional, default False) — Apakah akan memaksa (mengunduh ulang) file feature extractor dan menimpa versi yang di-cache jika ada.
  • proxies (dict[str, str], opsional) — Kamus server proxy untuk digunakan berdasarkan protokol atau endpoint, misalnya {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. Proxy digunakan pada setiap permintaan.
  • token (str atau bool, opsional) — Token yang digunakan sebagai otorisasi bearer HTTP untuk file jarak jauh. Jika True, atau tidak ditentukan, akan menggunakan token yang dihasilkan saat menjalankan hf auth login (disimpan di ~/.huggingface).
  • revision (str, opsional, default "main") — Versi model spesifik yang akan digunakan. Bisa berupa nama branch, nama tag, atau commit id, karena kami menggunakan sistem berbasis git untuk menyimpan model dan artefak lainnya di huggingface.co, sehingga revision dapat berupa identifikasi apa pun yang diizinkan oleh git.

Instansiasi tipe FeatureExtractionMixin dari feature extractor, misalnya kelas turunan dari SequenceFeatureExtractor.

Contoh:

# We can't instantiate directly the base class *FeatureExtractionMixin* nor *SequenceFeatureExtractor* so let's show the examples on a
# derived class: *Wav2Vec2FeatureExtractor*
feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained(
    "facebook/wav2vec2-base-960h"
)  # Download feature_extraction_config from huggingface.co and cache.
feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained(
    "./test/saved_model/"
)  # E.g. feature_extractor (or model) was saved using *save_pretrained('./test/saved_model/')*
feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained("./test/saved_model/preprocessor_config.json")
feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained(
    "facebook/wav2vec2-base-960h", return_attention_mask=False, foo=False
)
assert feature_extractor.return_attention_mask is False
feature_extractor, unused_kwargs = Wav2Vec2FeatureExtractor.from_pretrained(
    "facebook/wav2vec2-base-960h", return_attention_mask=False, foo=False, return_unused_kwargs=True
)
assert feature_extractor.return_attention_mask is False
assert unused_kwargs == {"foo": False}

save_pretrained

< >

( save_directory: str | os.PathLikepush_to_hub: bool = False**kwargs )

Parameter

  • save_directory (str atau os.PathLike) — Direktori tempat file JSON feature extractor akan disimpan (akan dibuat jika belum ada).
  • push_to_hub (bool, opsional, default False) — Apakah model Anda akan didorong ke Hugging Face model hub setelah disimpan. Anda dapat menentukan repository yang ingin Anda tuju dengan repo_id (defaultnya adalah nama save_directory di namespace Anda).
  • kwargs (dict[str, Any], opsional) — Argumen kata kunci tambahan yang diteruskan ke metode push_to_hub().

Simpan objek feature_extractor ke direktori save_directory agar dapat dimuat ulang menggunakan metode kelas from_pretrained().

SequenceFeatureExtractor

kelas transformers.SequenceFeatureExtractor

< >

( feature_size: intsampling_rate: intpadding_value: float**kwargs )

Parameter

  • feature_size (int) — Dimensi fitur dari fitur yang diekstrak.
  • sampling_rate (int) — Laju sampling di mana file audio harus didigitalisasi, dinyatakan dalam hertz (Hz).
  • padding_value (float) — Nilai yang digunakan untuk mengisi nilai / vektor padding.

Ini adalah kelas ekstraksi fitur umum untuk pengenalan ucapan.

pad

< >

( processed_features: transformers.feature_extraction_utils.BatchFeature | list[transformers.feature_extraction_utils.BatchFeature] | dict[str, transformers.feature_extraction_utils.BatchFeature] | dict[str, list[transformers.feature_extraction_utils.BatchFeature]] | list[dict[str, transformers.feature_extraction_utils.BatchFeature]]padding: bool | str | transformers.utils.generic.PaddingStrategy = Truemax_length: int | None = Nonetruncation: bool = Falsepad_to_multiple_of: int | None = Nonereturn_attention_mask: bool | None = Nonereturn_tensors: str | transformers.utils.generic.TensorType | None = None )

Parameter

  • processed_features (BatchFeature, daftar BatchFeature, dict[str, list[float]], dict[str, list[list[float]] atau list[dict[str, list[float]]]) — Input yang telah diproses. Dapat mewakili satu input (BatchFeature atau dict[str, list[float]]) atau batch nilai / vektor input (daftar BatchFeature, dict[str, list[list[float]]] atau list[dict[str, list[float]]]) sehingga Anda dapat menggunakan metode ini selama pra-pemrosesan maupun dalam fungsi collate PyTorch Dataloader.

    Alih-alih list[float], Anda dapat menggunakan tensor (array numpy atau tensor PyTorch), lihat catatan di atas untuk tipe pengembalian.

  • padding (bool, str atau PaddingStrategy, opsional, defaultnya True) — Pilih strategi untuk melakukan padding pada urutan yang dikembalikan (sesuai sisi padding dan indeks padding model) di antara:
    • True atau 'longest': Pad hingga urutan terpanjang dalam batch (atau tanpa padding jika hanya satu urutan yang diberikan).
    • 'max_length': Pad hingga panjang maksimum yang ditentukan dengan argumen max_length atau hingga panjang input maksimum yang dapat diterima oleh model jika argumen tersebut tidak diberikan.
    • False atau 'do_not_pad' (default): Tidak ada padding (yaitu, dapat menghasilkan batch dengan urutan yang panjangnya berbeda).
  • max_length (int, opsional) — Panjang maksimum dari daftar yang dikembalikan dan secara opsional panjang padding (lihat di atas).
  • truncation (bool) — Mengaktifkan pemotongan untuk memotong urutan input yang lebih panjang dari max_length menjadi max_length.
  • pad_to_multiple_of (int, opsional) — Jika diset, akan melakukan padding pada urutan hingga menjadi kelipatan dari nilai yang diberikan.

    Ini sangat berguna untuk memungkinkan penggunaan Tensor Cores pada perangkat keras NVIDIA dengan compute capability >= 7.5 (Volta), atau pada TPU yang diuntungkan dari panjang sekuens yang merupakan kelipatan 128.

  • return_attention_mask (bool, opsional) — Apakah akan mengembalikan attention mask. Jika dibiarkan pada nilai default, akan mengembalikan attention mask sesuai dengan default feature_extractor tertentu.

    Apa itu attention mask?

  • return_tensors (str atau TensorType, opsional) — Jika diset, akan mengembalikan tensor alih-alih daftar integer Python. Nilai yang dapat diterima adalah:
    • 'pt': Mengembalikan objek PyTorch torch.Tensor.
    • 'np': Mengembalikan objek Numpy np.ndarray.

Pad nilai input / vektor input atau batch nilai input / vektor input hingga panjang yang telah ditentukan atau hingga panjang urutan maksimum dalam batch.

Nilai padding sisi (kiri/kanan) didefinisikan pada level feature extractor (dengan self.padding_side, self.padding_value)

Jika processed_features yang diberikan berupa dictionary dari array numpy atau tensor PyTorch, hasilnya akan menggunakan tipe yang sama kecuali Anda menyediakan tipe tensor yang berbeda dengan return_tensors. Dalam kasus tensor PyTorch, Anda akan kehilangan perangkat spesifik dari tensor Anda.

BatchFeature

kelas transformers.BatchFeature

< >

( data: dict[str, typing.Any] | None = Nonetensor_type: None | str | transformers.utils.generic.TensorType = Noneskip_tensor_conversion: list[str] | set[str] | None = None )

Parameter

  • data (dict, opsional) — Kamus berisi daftar/array/tensor yang dikembalikan oleh metode call/pad (‘input_values’, ‘attention_mask’, dll.).
  • tensor_type (Union[None, str, TensorType], opsional) — Anda dapat memberikan tensor_type di sini untuk mengonversi daftar bilangan bulat menjadi Tensor PyTorch/Numpy saat inisialisasi.
  • skip_tensor_conversion (list[str] atau set[str], opsional) — Daftar atau set kunci yang TIDAK boleh dikonversi menjadi tensor, bahkan ketika tensor_type ditentukan.

Menyimpan output dari metode pad() dan __call__ spesifik feature extractor.

Kelas ini diturunkan dari kamus python dan dapat digunakan sebagai kamus.

convert_to_tensors

< >

( tensor_type: str | transformers.utils.generic.TensorType | None = Noneskip_tensor_conversion: list[str] | set[str] | None = None )

Parameter

  • tensor_type (str atau TensorType, opsional) — Jenis tensor yang akan digunakan. Jika str, harus salah satu nilai dari enum TensorType. Jika None, tidak ada modifikasi yang dilakukan.
  • skip_tensor_conversion (list[str] atau set[str], opsional) — Daftar atau set kunci yang TIDAK boleh dikonversi menjadi tensor, bahkan ketika tensor_type ditentukan.

Konversi konten internal menjadi tensor.

Note: Nilai yang tidak memiliki struktur seperti array (misalnya, string, dict, daftar string) akan dilewati secara otomatis dan tidak akan dikonversi menjadi tensor. Array yang tidak beraturan (daftar array dengan panjang berbeda) tetap akan dicoba, meskipun mungkin menimbulkan error selama konversi.

ke

< >

( *args**kwargs ) → BatchFeature

Parameter

  • args (Tuple) — Akan diteruskan ke fungsi to(...) dari tensor.
  • kwargs (Dict, opsional) — Akan diteruskan ke fungsi to(...) dari tensor. Untuk mengaktifkan transfer data asinkron, setel flag non_blocking di kwargs (defaultnya False).

Mengembalikan

BatchFeature

Instans yang sama setelah dimodifikasi.

Kirim semua nilai ke perangkat dengan memanggil v.to(*args, **kwargs) (hanya PyTorch). Ini harus mendukung casting ke dtypes yang berbeda dan mengirim BatchFeature ke device yang berbeda.

ImageFeatureExtractionMixin

kelas transformers.ImageFeatureExtractionMixin

< >

( )

Mixin yang berisi utilitas untuk menyiapkan fitur gambar.

center_crop

< >

( imagesize ) → new_image

Parameter

  • image (PIL.Image.Image atau np.ndarray atau torch.Tensor dengan bentuk (n_channels, height, width) atau (height, width, n_channels)) — Gambar yang akan diubah ukurannya.
  • size (int atau tuple[int, int]) — Ukuran yang menjadi target pemotongan gambar.

Mengembalikan

new_image

Center cropped PIL.Image.Image atau np.ndarray atau torch.Tensor dengan bentuk: (n_channels, height, width).

Crops image ke ukuran yang diberikan menggunakan center crop. Perhatikan bahwa jika gambar terlalu kecil untuk di-crop ke ukuran yang diberikan, gambar akan di-pad (sehingga hasil yang dikembalikan memiliki ukuran yang diminta).

convert_rgb

< >

( image )

Parameter

  • image (PIL.Image.Image) — Gambar yang akan dikonversi.

Mengonversi PIL.Image.Image ke format RGB.

expand_dims

< >

( image )

Parameter

  • image (PIL.Image.Image atau np.ndarray atau torch.Tensor) — Gambar yang akan diperluas.

Memperluas image 2 dimensi menjadi 3 dimensi.

flip_channel_order

< >

( image )

Parameter

  • image (PIL.Image.Image atau np.ndarray atau torch.Tensor) — Gambar yang saluran warnanya akan dibalik. Jika np.ndarray atau torch.Tensor, dimensi saluran harus berada di depan.

Membalikkan urutan channel dari image dari RGB ke BGR, atau sebaliknya. Perhatikan bahwa ini akan memicu konversi image menjadi array NumPy jika berupa PIL Image.

normalize

< >

( imagemeanstdrescale = False )

Parameter

  • image (PIL.Image.Image atau np.ndarray atau torch.Tensor) — Gambar yang akan dinormalisasi.
  • mean (list[float] atau np.ndarray atau torch.Tensor) — Rata-rata (per channel) yang digunakan untuk normalisasi.
  • std (list[float] atau np.ndarray atau torch.Tensor) — Standar deviasi (per channel) yang digunakan untuk normalisasi.
  • rescale (bool, opsional, default False) — Apakah akan melakukan penskalaan ulang gambar agar berada di antara 0 dan 1. Jika gambar PIL diberikan, penskalaan akan terjadi secara otomatis.

Menormalkan image dengan mean dan std. Perhatikan bahwa ini akan memicu konversi image menjadi array NumPy jika berupa PIL Image.

rescale

< >

( image: ndarrayscale: float | int )

Skala ulang gambar numpy dengan jumlah skala

resize

< >

( imagesizeresample = Nonedefault_to_square = Truemax_size = None ) → image

Parameter

  • image (PIL.Image.Image atau np.ndarray atau torch.Tensor) — Gambar yang akan diubah ukurannya.
  • size (int atau tuple[int, int]) — Ukuran yang akan digunakan untuk mengubah ukuran gambar. Jika size adalah urutan seperti (h, w), ukuran output akan disesuaikan dengan ini.

    Jika size adalah int dan default_to_square adalah True, maka gambar akan di-resize menjadi (size, size). Jika size adalah int dan default_to_square adalah False, maka sisi terkecil gambar akan disesuaikan dengan angka ini. yaitu, jika height > width, maka gambar akan di-rescale menjadi (size * height / width, size).

  • resample (int, opsional, default PILImageResampling.BILINEAR) — Filter yang digunakan untuk resampling.
  • default_to_square (bool, opsional, defaultnya True) — Cara mengonversi size ketika berupa satu int. Jika diset ke True, size akan dikonversi menjadi persegi (size,size). Jika diset ke False, akan mereplikasi torchvision.transforms.Resize dengan dukungan untuk mengubah ukuran hanya pada sisi terkecil dan menyediakan max_size opsional.
  • max_size (int, opsional, defaultnya None) — Batas maksimum untuk sisi terpanjang dari gambar yang di-resize: jika sisi terpanjang gambar lebih besar dari max_size setelah di-resize sesuai dengan size, maka gambar akan di-resize lagi sehingga sisi terpanjangnya sama dengan max_size. Akibatnya, size mungkin ditimpa, yaitu sisi yang lebih pendek bisa menjadi lebih pendek dari size. Hanya digunakan jika default_to_square adalah False.

Mengembalikan

image

PIL.Image.Image yang telah diubah ukurannya.

Mengubah ukuran image. Memastikan konversi input menjadi PIL.Image.

rotate

< >

( imageangleresample = Noneexpand = 0center = Nonetranslate = Nonefillcolor = None ) → image

Parameter

  • image (PIL.Image.Image atau np.ndarray atau torch.Tensor) — Gambar yang akan diputar. Jika np.ndarray atau torch.Tensor, akan dikonversi menjadi PIL.Image.Image sebelum diputar.

Mengembalikan

image

PIL.Image.Image yang diputar.

Mengembalikan salinan yang diputar dari image. Metode ini mengembalikan salinan dari image, yang diputar sejumlah derajat tertentu berlawanan arah jarum jam di sekitar pusatnya.

to_numpy_array

< >

( imagerescale = Nonechannel_first = True )

Parameter

  • image (PIL.Image.Image atau np.ndarray atau torch.Tensor) — Gambar yang akan dikonversi menjadi array NumPy.
  • rescale (bool, opsional) — Apakah akan menerapkan faktor penskalaan (untuk membuat nilai piksel menjadi float antara 0. dan 1.). Akan default ke True jika gambar adalah PIL Image atau array/tensor dari integer, False selain itu.
  • channel_first (bool, opsional, default True) — Apakah akan mempermutasi dimensi gambar untuk menempatkan dimensi channel di depan.

Mengonversi image menjadi array numpy. Secara opsional, melakukan penskalaan ulang dan menempatkan dimensi channel sebagai dimensi pertama.

to_pil_image

< >

( imagerescale = None )

Parameter

  • image (PIL.Image.Image atau numpy.ndarray atau torch.Tensor) — Gambar yang akan dikonversi ke format PIL Image.
  • rescale (bool, opsional) — Apakah akan menerapkan faktor penskalaan (untuk membuat nilai piksel menjadi bilangan bulat antara 0 dan 255). Akan default ke True jika tipe gambar adalah tipe floating, False selain itu.

Mengonversi image menjadi PIL Image. Secara opsional, melakukan penskalaan ulang dan mengembalikan dimensi channel sebagai sumbu terakhir jika diperlukan.

Update on GitHub

←ExecuTorch Pemroses gambar→