Transformers documentation

Utilitas untuk pemroses gambar

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

and get access to the augmented documentation experience

to get started

Utilitas untuk pemroses gambar

Halaman ini mencantumkan semua fungsi utilitas yang digunakan oleh pemroses gambar, terutama transformasi fungsional yang digunakan untuk memproses gambar.

Sebagian besar dari hal tersebut hanya berguna jika Anda sedang mempelajari kode dari pemroses gambar di pustaka.

Transformasi Gambar

transformers.image_transforms.center_crop

< >

( image: ndarraysize: tupledata_format: str | transformers.image_utils.ChannelDimension | None = Noneinput_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → np.ndarray

Parameter

  • image (np.ndarray) — Gambar yang akan dipotong.
  • size (tuple[int, int]) — Ukuran target untuk gambar yang dipotong.
  • data_format (str atau ChannelDimension, opsional) — Format dimensi channel untuk gambar output. Bisa berupa salah satu dari:
    • "channels_first" atau ChannelDimension.FIRST: gambar dalam format (num_channels, height, width).
    • "channels_last" atau ChannelDimension.LAST: gambar dalam format (height, width, num_channels). Jika tidak disetel, akan menggunakan format yang disimpulkan dari gambar input.
  • input_data_format (str atau ChannelDimension, opsional) — Format dimensi channel untuk gambar input. Bisa berupa salah satu dari:
    • "channels_first" atau ChannelDimension.FIRST: gambar dalam format (num_channels, height, width).
    • "channels_last" atau ChannelDimension.LAST: gambar dalam format (height, width, num_channels). Jika tidak disetel, akan menggunakan format yang disimpulkan dari gambar input.

Mengembalikan

np.ndarray

Gambar yang dipotong.

Memotong image ke size yang ditentukan menggunakan center crop. Perhatikan bahwa jika gambar terlalu kecil untuk dipotong ke ukuran yang diberikan, gambar akan di-pad (sehingga hasil yang dikembalikan selalu berukuran size).

transformers.image_transforms.center_to_corners_format

< >

( bboxes_center: TensorType )

Mengubah kotak pembatas dari format pusat ke format sudut.

center format: berisi koordinat untuk pusat kotak dan dimensi lebar serta tingginya (center_x, center_y, width, height) corners format: berisi koordinat untuk sudut kiri atas dan kanan bawah kotak (top_left_x, top_left_y, bottom_right_x, bottom_right_y)

transformers.image_transforms.corners_to_center_format

< >

( bboxes_corners: TensorType )

Mengubah kotak pembatas dari format sudut ke format pusat.

format sudut: berisi koordinat untuk sudut kiri atas dan kanan bawah kotak (top_left_x, top_left_y, bottom_right_x, bottom_right_y) format pusat: berisi koordinat untuk pusat kotak serta dimensi lebar dan tingginya (center_x, center_y, width, height)

transformers.image_transforms.id_to_rgb

< >

( id_map )

Mengonversi ID unik menjadi warna RGB.

transformers.image_transforms.normalize

< >

( image: ndarraymean: float | collections.abc.Collection[float]std: float | collections.abc.Collection[float]data_format: transformers.image_utils.ChannelDimension | None = Noneinput_data_format: str | transformers.image_utils.ChannelDimension | None = None )

Parameter

  • image (np.ndarray) — Gambar yang akan dinormalisasi.
  • mean (float atau Collection[float]) — Rata-rata yang digunakan untuk normalisasi.
  • std (float atau Collection[float]) — Standar deviasi yang digunakan untuk normalisasi.
  • data_format (ChannelDimension, opsional) — Format dimensi channel dari gambar keluaran. Jika tidak disetel, akan menggunakan format yang disimpulkan dari input.
  • input_data_format (ChannelDimension, opsional) — Format dimensi channel dari gambar input. Jika tidak diset, akan menggunakan format yang disimpulkan dari input.

Menormalkan image menggunakan rata-rata dan deviasi standar yang ditentukan oleh mean dan std.

image = (image - mean) / std

transformers.image_transforms.pad

< >

( image: ndarraypadding: int | tuple[int, int] | collections.abc.Iterable[tuple[int, int]]mode: PaddingMode = <PaddingMode.CONSTANT: 'constant'>constant_values: float | collections.abc.Iterable[float] = 0.0data_format: str | transformers.image_utils.ChannelDimension | None = Noneinput_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → np.ndarray

Parameter

  • image (np.ndarray) — Gambar yang akan diberi padding.
  • padding (int atau tuple[int, int] atau Iterable[tuple[int, int]]) — Padding yang diterapkan pada tepi sumbu tinggi dan lebar. Dapat berupa salah satu dari tiga format:
    • ((before_height, after_height), (before_width, after_width)) lebar pad unik untuk setiap sumbu.
    • ((before, after),) menghasilkan pad before dan after yang sama untuk tinggi dan lebar.
    • (pad,) atau int adalah pintasan untuk before = after = pad width untuk semua sumbu.
  • mode (PaddingMode) — Mode padding yang akan digunakan. Bisa berupa salah satu dari:
    • "constant": mengisi dengan nilai konstan.
    • "reflect": mengisi dengan refleksi vektor yang dipantulkan pada nilai pertama dan terakhir dari vektor di sepanjang setiap sumbu.
    • "replicate": mengisi dengan replikasi nilai terakhir di tepi array di sepanjang setiap sumbu.
    • "symmetric": mengisi dengan refleksi vektor yang dipantulkan di sepanjang tepi array.
  • constant_values (float atau Iterable[float], opsional) — Nilai yang digunakan untuk padding jika mode adalah "constant".
  • data_format (str atau ChannelDimension, opsional) — Format dimensi channel untuk gambar output. Bisa berupa salah satu dari:
    • "channels_first" atau ChannelDimension.FIRST: gambar dalam format (num_channels, height, width).
    • "channels_last" atau ChannelDimension.LAST: gambar dalam format (height, width, num_channels). Jika tidak disetel, akan menggunakan format yang sama dengan gambar input.
  • input_data_format (str atau ChannelDimension, opsional) — Format dimensi channel untuk gambar input. Bisa berupa salah satu dari:
    • "channels_first" atau ChannelDimension.FIRST: gambar dalam format (num_channels, height, width).
    • "channels_last" atau ChannelDimension.LAST: gambar dalam format (height, width, num_channels). Jika tidak disetel, akan menggunakan format yang disimpulkan dari gambar input.

Mengembalikan

np.ndarray

Gambar yang telah di-*padding*.

Menambahkan padding pada image dengan ukuran (tinggi, lebar) dan mode yang ditentukan.

transformers.image_transforms.rgb_to_id

< >

( color )

Mengonversi warna RGB menjadi ID unik.

transformers.image_transforms.rescale

< >

( image: ndarrayscale: floatdata_format: transformers.image_utils.ChannelDimension | None = Nonedtype: dtype = <class 'numpy.float32'>input_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → np.ndarray

Parameter

  • image (np.ndarray) — Gambar yang akan diskalakan ulang.
  • scale (float) — Skala yang digunakan untuk penskalaan ulang gambar.
  • data_format (ChannelDimension, opsional) — Format dimensi channel dari gambar. Jika tidak disediakan, akan sama dengan gambar input.
  • dtype (np.dtype, opsional, default np.float32) — dtype dari gambar output. Defaultnya np.float32. Digunakan untuk kompatibilitas mundur dengan feature extractor.
  • input_data_format (ChannelDimension, opsional) — Format dimensi channel dari gambar input. Jika tidak disediakan, format ini akan disimpulkan dari gambar input.

Mengembalikan

np.ndarray

Gambar yang telah diskalakan ulang.

Mengubah skala image dengan scale.

transformers.image_transforms.resize

< >

( image: ndarraysize: tupleresample: typing.Optional[ForwardRef('PILImageResampling')] = Nonereducing_gap: int | None = Nonedata_format: transformers.image_utils.ChannelDimension | None = Nonereturn_numpy: bool = Trueinput_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → np.ndarray

Parameter

  • image (np.ndarray) — Gambar yang akan diubah ukurannya.
  • size (tuple[int, int]) — Ukuran yang akan digunakan untuk mengubah ukuran (resizing) gambar.
  • resample (int, opsional, default PILImageResampling.BILINEAR) — Filter yang digunakan untuk resampling.
  • reducing_gap (int, opsional) — Terapkan optimasi dengan mengubah ukuran gambar dalam dua langkah. Semakin besar reducing_gap, semakin dekat hasilnya ke resampling yang adil. Lihat dokumentasi Pillow yang sesuai untuk detail lebih lanjut.
  • data_format (ChannelDimension, opsional) — Format dimensi channel dari gambar keluaran. Jika tidak disetel, akan menggunakan format yang disimpulkan dari input.
  • return_numpy (bool, opsional, defaultnya True) — Apakah akan mengembalikan gambar yang telah diubah ukurannya sebagai array numpy. Jika False, objek PIL.Image.Image yang dikembalikan.
  • input_data_format (ChannelDimension, opsional) — Format dimensi channel dari gambar input. Jika tidak diset, akan menggunakan format yang disimpulkan dari input.

Mengembalikan

np.ndarray

Gambar yang telah diubah ukurannya.

Mengubah ukuran image menjadi (height, width) yang ditentukan oleh size menggunakan pustaka PIL.

transformers.image_transforms.to_pil_image

< >

( image: typing.Union[numpy.ndarray, ForwardRef('PIL.Image.Image'), ForwardRef('torch.Tensor')]do_rescale: bool | None = Noneimage_mode: str | None = Noneinput_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → PIL.Image.Image

Parameter

  • image (PIL.Image.Image atau numpy.ndarray atau torch.Tensor) — Gambar yang akan dikonversi ke format PIL.Image.
  • do_rescale (bool, opsional) — Apakah akan menerapkan faktor penskalaan (untuk membuat nilai piksel menjadi bilangan bulat antara 0 dan 255). Akan secara default menjadi True jika tipe gambar adalah tipe floating dan pencasting ke int akan menyebabkan hilangnya presisi, dan False selain itu.
  • image_mode (str, opsional) — Mode yang digunakan untuk gambar PIL. Jika tidak disetel, mode default untuk tipe gambar input akan digunakan.
  • input_data_format (ChannelDimension, opsional) — Format dimensi channel dari gambar input. Jika tidak diset, akan menggunakan format yang disimpulkan dari input.

Mengembalikan

PIL.Image.Image

Gambar yang telah dikonversi.

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

ImageProcessingMixin

kelas transformers.ImageProcessingMixin

< >

( **kwargs )

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

fetch_images

< >

( image_url_or_urls: str | list[str] | list[list[str]] )

Mengonversi satu atau daftar url menjadi objek PIL.Image yang sesuai.

Jika satu url diberikan, nilai yang dikembalikan akan berupa satu objek. Jika sebuah daftar diberikan, sebuah daftar objek akan dikembalikan.

from_dict

< >

( image_processor_dict: dict**kwargs ) → ImageProcessingMixin

Parameter

  • image_processor_dict (dict[str, Any]) — Kamus yang akan digunakan untuk menginstansiasi objek image processor. Kamus semacam itu dapat diperoleh dari checkpoint pretrained dengan memanfaatkan metode to_dict().
  • kwargs (dict[str, Any]) — Parameter tambahan untuk menginisialisasi objek image processor.

Mengembalikan

ImageProcessingMixin

Objek pemroses gambar yang diinstansiasi dari parameter tersebut.

Membuat instans dari tipe ImageProcessingMixin dari kamus Python berisi parameter.

from_json_file

< >

( json_file: str | os.PathLike ) → A image processor of type ImageProcessingMixin

Parameter

  • json_file (str atau os.PathLike) — Path ke file JSON yang berisi parameter.

Mengembalikan

Pemroses gambar bertipe ImageProcessingMixin

objek image_processor yang diinstansiasi dari file JSON tersebut.

Membuat instans pemroses gambar bertipe ImageProcessingMixin dari path ke file JSON berisi parameter.

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 image_processor pretrained yang dihosting di dalam repo model di huggingface.co.
    • path ke direktori yang berisi file image processor yang disimpan menggunakan metode save_pretrained(), misalnya ./my_model_directory/.
    • path ke file JSON image processor yang disimpan file, misalnya ./my_model_directory/preprocessor_config.json.
  • cache_dir (str atau os.PathLike, opsional) — Path ke direktori tempat image processor model pretrained yang diunduh harus di-cache jika cache standar tidak digunakan.
  • force_download (bool, opsional, default False) — Apakah akan memaksa (mengunduh ulang) file image processor dan menimpa versi yang sudah 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 ImageProcessingMixin dari image processor.

Contoh:

# We can't instantiate directly the base class *ImageProcessingMixin* so let's show the examples on a
# derived class: *CLIPImageProcessor*
image_processor = CLIPImageProcessor.from_pretrained(
    "openai/clip-vit-base-patch32"
)  # Download image_processing_config from huggingface.co and cache.
image_processor = CLIPImageProcessor.from_pretrained(
    "./test/saved_model/"
)  # E.g. image processor (or model) was saved using *save_pretrained('./test/saved_model/')*
image_processor = CLIPImageProcessor.from_pretrained("./test/saved_model/preprocessor_config.json")
image_processor = CLIPImageProcessor.from_pretrained(
    "openai/clip-vit-base-patch32", do_normalize=False, foo=False
)
assert image_processor.do_normalize is False
image_processor, unused_kwargs = CLIPImageProcessor.from_pretrained(
    "openai/clip-vit-base-patch32", do_normalize=False, foo=False, return_unused_kwargs=True
)
assert image_processor.do_normalize is False
assert unused_kwargs == {"foo": False}

get_image_processor_dict

< >

( pretrained_model_name_or_path: str | os.PathLike**kwargs ) → tuple[Dict, Dict]

Parameter

  • pretrained_model_name_or_path (str atau os.PathLike) — Identitas checkpoint terlatih sebelumnya yang dari mana kita ingin mengambil kamus parameter.
  • subfolder (str, opsional, defaultnya "") — Jika file yang relevan berada di dalam subfolder dari repo model di huggingface.co, Anda dapat menentukan nama folder di sini.
  • image_processor_filename (str, opsional, defaultnya "config.json") — Nama file di direktori model yang akan digunakan untuk konfigurasi image processor.

Mengembalikan

tuple[Dict, Dict]

Kamus yang akan digunakan untuk menginstansiasi objek pemroses gambar.

Dari pretrained_model_name_or_path, selesaikan menjadi kamus parameter, untuk digunakan dalam menginstansiasi image processor bertipe ~image_processor_utils.ImageProcessingMixin menggunakan from_dict.

push_to_hub

< >

( repo_id: strcommit_message: str | None = Nonecommit_description: str | None = Noneprivate: bool | None = Nonetoken: bool | str | None = Nonerevision: str | None = Nonecreate_pr: bool = Falsemax_shard_size: int | str | None = '50GB'tags: list[str] | None = None )

Parameter

  • repo_id (str) — Nama repositori tempat Anda ingin mendorong image processor Anda. Seharusnya berisi nama organisasi Anda saat mendorong ke organisasi tertentu.
  • commit_message (str, opsional) — Pesan untuk commit saat push. Akan default ke "Upload image processor".
  • commit_description (str, opsional) — Deskripsi dari commit yang akan dibuat
  • private (bool, opsional) — Apakah membuat repo menjadi privat. Jika None (default), repo akan menjadi publik kecuali default organisasi adalah privat. Nilai ini diabaikan jika repo sudah ada.
  • token (bool atau str, opsional) — Token yang digunakan sebagai otorisasi bearer HTTP untuk file jarak jauh. Jika True (default), akan menggunakan token yang dihasilkan saat menjalankan hf auth login (disimpan di ~/.huggingface).
  • revision (str, opsional) — Cabang untuk mendorong file yang diunggah.
  • create_pr (bool, opsional, default False) — Apakah akan membuat PR dengan file yang diunggah atau langsung melakukan commit.
  • max_shard_size (int atau str, opsional, default "50GB") — Hanya berlaku untuk model. Ukuran maksimum checkpoint sebelum di-shard. Setiap shard checkpoint akan memiliki ukuran lebih kecil dari nilai ini. Jika dinyatakan sebagai string, harus berupa angka diikuti satuan (seperti "5MB").
  • tags (list[str], opsional) — Daftar tag untuk didorong ke Hub.

Unggah file image processor ke 🤗 Model Hub.

Contoh:

from transformers import AutoImageProcessor

image processor = AutoImageProcessor.from_pretrained("google-bert/bert-base-cased")

# Push the image processor to your namespace with the name "my-finetuned-bert".
image processor.push_to_hub("my-finetuned-bert")

# Push the image processor to an organization with the name "my-finetuned-bert".
image processor.push_to_hub("huggingface/my-finetuned-bert")

register_for_auto_class

< >

( auto_class = 'AutoImageProcessor' )

Parameter

  • auto_class (str atau type, opsional, defaultnya "AutoImageProcessor ") — Kelas otomatis untuk mendaftarkan pemroses gambar baru ini.

Daftarkan kelas ini dengan kelas auto yang diberikan. Ini hanya harus digunakan untuk pemroses gambar kustom karena yang ada di pustaka sudah dipetakan dengan AutoImageProcessor.

save_pretrained

< >

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

Parameter

  • save_directory (str atau os.PathLike) — Direktori tempat file JSON image processor 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 image processor ke direktori save_directory agar dapat dimuat ulang menggunakan metode kelas from_pretrained().

to_dict

< >

( ) → dict[str, Any]

Mengembalikan

dict[str, Any]

Kamus dari semua atribut yang membentuk instance image processor ini.

Menserialisasi instance ini ke dalam kamus Python.

to_json_file

< >

( json_file_path: str | os.PathLike )

Parameter

  • json_file_path (str atau os.PathLike) — Path ke file JSON tempat parameter instance image_processor ini akan disimpan.

Simpan instance ini ke file JSON.

to_json_string

< >

( ) → str

Mengembalikan

str

String yang berisi semua atribut yang membentuk instance feature_extractor ini dalam format JSON.

Menserialisasi instance ini ke string JSON.

Update on GitHub