Hub documentation

Dataset Gambar

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Dataset Gambar

Panduan ini akan menunjukkan cara mengonfigurasi repositori dataset Anda dengan file gambar. Anda dapat menemukan contoh repositori yang menyertainya dalam koleksi contoh dataset gambar ini.

Dataset dengan struktur dan format file yang didukung secara otomatis memiliki Dataset Viewer di halamannya di Hub.

Informasi tambahan tentang gambar Anda - seperti caption atau bounding box untuk object detection - dimuat secara otomatis selama Anda menyertakan informasi ini dalam file metadata (metadata.csv/metadata.jsonl/metadata.parquet).

Sebagai alternatif, gambar dapat berada dalam file Parquet atau dalam arsip TAR yang mengikuti format WebDataset.

Hanya gambar

Jika dataset Anda hanya terdiri dari satu kolom berisi gambar, Anda cukup menyimpan file gambar Anda di root:

my_dataset_repository/
β”œβ”€β”€ 1.jpg
β”œβ”€β”€ 2.jpg
β”œβ”€β”€ 3.jpg
└── 4.jpg

atau dalam subdirektori:

my_dataset_repository/
└── images
    β”œβ”€β”€ 1.jpg
    β”œβ”€β”€ 2.jpg
    β”œβ”€β”€ 3.jpg
    └── 4.jpg

Beberapa format didukung secara bersamaan, termasuk PNG, JPEG, TIFF, dan WebP.

my_dataset_repository/
└── images
    β”œβ”€β”€ 1.jpg
    β”œβ”€β”€ 2.png
    β”œβ”€β”€ 3.tiff
    └── 4.webp

Jika Anda memiliki beberapa split, Anda dapat menempatkan gambar Anda ke dalam direktori yang diberi nama sesuai:

my_dataset_repository/
β”œβ”€β”€ train
β”‚Β Β  β”œβ”€β”€ 1.jpg
β”‚Β Β  └── 2.jpg
└── test
    β”œβ”€β”€ 3.jpg
    └── 4.jpg

Lihat Nama file dan split untuk informasi lebih lanjut dan cara lain untuk mengorganisasi data berdasarkan split.

Kolom tambahan

Jika ada informasi tambahan yang ingin Anda sertakan tentang dataset Anda, seperti teks caption atau bounding box, tambahkan sebagai file metadata.csv di repository Anda. Hal ini memungkinkan Anda dengan cepat membuat dataset untuk berbagai tugas computer vision seperti text captioning atau object detection.

my_dataset_repository/
└── train
    β”œβ”€β”€ 1.jpg
    β”œβ”€β”€ 2.jpg
    β”œβ”€β”€ 3.jpg
    β”œβ”€β”€ 4.jpg
    └── metadata.csv

File metadata.csv Anda harus memiliki kolom file_name yang menghubungkan file gambar dengan metadata mereka:

file_name,text
1.jpg,a drawing of a green pokemon with red eyes
2.jpg,a green and yellow toy with a red nose
3.jpg,a red and white ball with an angry look on its face
4.jpg,a cartoon ball with a smile on its face

Anda juga dapat menggunakan file JSONL metadata.jsonl:

{"file_name": "1.jpg","text": "a drawing of a green pokemon with red eyes"}
{"file_name": "2.jpg","text": "a green and yellow toy with a red nose"}
{"file_name": "3.jpg","text": "a red and white ball with an angry look on its face"}
{"file_name": "4.jpg","text": "a cartoon ball with a smile on its face"}

Dan untuk dataset yang lebih besar atau jika Anda tertarik dengan fitur pengambilan data yang lebih lanjut, Anda dapat menggunakan file Parquet metadata.parquet.

Path relatif

File metadata harus berada di direktori yang sama dengan gambar yang terkait, atau di direktori induk mana pun, seperti pada contoh ini:

my_dataset_repository/
└── train
    β”œβ”€β”€ images
    β”‚Β Β  β”œβ”€β”€ 1.jpg
    β”‚Β Β  β”œβ”€β”€ 2.jpg
    β”‚Β Β  β”œβ”€β”€ 3.jpg
    β”‚Β Β  └── 4.jpg
    └── metadata.csv

Dalam kasus ini, kolom file_name harus berupa jalur relatif lengkap ke gambar, bukan hanya nama file:

file_name,text
images/1.jpg,a drawing of a green pokemon with red eyes
images/2.jpg,a green and yellow toy with a red nose
images/3.jpg,a red and white ball with an angry look on its face
images/4.jpg,a cartoon ball with a smile on it's face

File metadata tidak dapat ditempatkan di subdirektori dari direktori yang berisi gambar.

Secara lebih umum, kolom apa pun yang bernama file_name atau *_file_name harus berisi jalur relatif lengkap ke gambar.

Klasifikasi gambar

Untuk dataset klasifikasi gambar, Anda juga dapat menggunakan setup sederhana: gunakan direktori untuk memberi nama kelas gambar. Simpan file gambar Anda dalam struktur direktori seperti:

my_dataset_repository/
β”œβ”€β”€ green
β”‚Β Β  β”œβ”€β”€ 1.jpg
β”‚Β Β  └── 2.jpg
└── red
    β”œβ”€β”€ 3.jpg
    └── 4.jpg

Dataset yang dibuat dengan struktur ini berisi dua kolom: image dan label (dengan nilai green dan red).

Anda juga dapat menyediakan beberapa split. Untuk melakukannya, direktori dataset Anda harus memiliki struktur berikut (lihat Nama file dan split untuk informasi lebih lanjut):

my_dataset_repository/
β”œβ”€β”€ test
β”‚Β Β  β”œβ”€β”€ green
β”‚Β Β  β”‚Β Β  └── 2.jpg
β”‚Β Β  └── red
β”‚Β Β      └── 4.jpg
└── train
    β”œβ”€β”€ green
    β”‚Β Β  └── 1.jpg
    └── red
        └── 3.jpg

Anda dapat menonaktifkan penambahan otomatis kolom label dalam konfigurasi YAML. Jika nama direktori Anda tidak memiliki arti khusus, atur drop_labels: true di header README:

configs:
  - config_name: default  # Name of the dataset subset, if applicable.
    drop_labels: true

Dataset berskala besar

Format WebDataset

Format WebDataset sangat cocok untuk dataset gambar berskala besar (lihat timm/imagenet-12k-wds sebagai contoh). Format ini terdiri dari arsip TAR yang berisi gambar beserta metadata-nya dan dioptimalkan untuk streaming. Format ini berguna jika Anda memiliki sejumlah besar gambar dan ingin mendapatkan streaming data loaders untuk pelatihan berskala besar.

my_dataset_repository/
β”œβ”€β”€ train-0000.tar
β”œβ”€β”€ train-0001.tar
β”œβ”€β”€ ...
└── train-1023.tar

Untuk membuat arsip TAR WebDataset, buat direktori yang berisi file gambar dan metadata yang akan diarsipkan, lalu buat arsip TAR menggunakan misalnya perintah tar. Ukuran umum per arsip biasanya sekitar 1GB. Pastikan setiap pasangan gambar dan metadata berbagi prefiks file yang sama, misalnya:

train-0000/
β”œβ”€β”€ 000.jpg
β”œβ”€β”€ 000.json
β”œβ”€β”€ 001.jpg
β”œβ”€β”€ 001.json
β”œβ”€β”€ ...
β”œβ”€β”€ 999.jpg
└── 999.json

Perhatikan bahwa untuk kenyamanan pengguna dan untuk memungkinkan Dataset Viewer, setiap dataset yang dihosting di Hub secara otomatis dikonversi ke format Parquet hingga 5GB. Baca lebih lanjut tentang hal ini dalam dokumentasi Parquet format.

Format Parquet

Alih-alih mengunggah gambar dan metadata sebagai file individual, Anda dapat menyematkan semuanya di dalam file Parquet. Hal ini berguna jika Anda memiliki sejumlah besar gambar, jika Anda ingin menyematkan beberapa kolom gambar, atau jika Anda ingin menyimpan informasi tambahan tentang gambar di file yang sama. Parquet juga berguna untuk menyimpan data seperti byte mentah, yang tidak didukung oleh JSON/CSV.

my_dataset_repository/
└── train.parquet

File Parquet dengan data gambar dapat dibuat menggunakan pandas atau pustaka datasets. Untuk membuat file Parquet dengan data gambar di pandas, Anda dapat menggunakan pandas-image-methods dan df.to_parquet(). Di datasets, Anda dapat mengatur tipe kolom menjadi Image() dan menggunakan metode ds.to_parquet(...) atau ds.push_to_hub(...). Anda dapat menemukan panduan untuk memuat dataset gambar di datasets di sini.

Sebagai alternatif, Anda dapat mengatur tipe gambar Parquet yang dibuat menggunakan alat lain secara manual. Pertama, pastikan kolom gambar Anda bertipe struct, dengan field biner "bytes" untuk data gambar dan field string "path" untuk nama atau path file gambar. Kemudian, Anda harus menentukan tipe fitur kolom secara langsung dalam YAML di header README, misalnya:

dataset_info:
  features:
  - name: image
    dtype: image
  - name: caption
    dtype: string

Perhatikan bahwa Parquet direkomendasikan untuk gambar kecil (<1MB per gambar) dan grup baris kecil (100 baris per grup baris, yang digunakan oleh datasets untuk gambar). Untuk gambar yang lebih besar, disarankan untuk menggunakan format WebDataset, atau membagikan file gambar asli (secara opsional dengan file metadata, dan mengikuti rekomendasi dan batasan repositori untuk penyimpanan dan jumlah file).

Update on GitHub