Datasets documentation
Các phương thức tải
Các phương thức tải
Các phương pháp để liệt kê và tải bộ dữ liệu:
Bộ dữ liệu
datasets.load_dataset
< source >( path: strname: typing.Optional[str] = Nonedata_dir: typing.Optional[str] = Nonedata_files: typing.Union[str, collections.abc.Sequence[str], collections.abc.Mapping[str, typing.Union[str, collections.abc.Sequence[str]]], NoneType] = Nonesplit: typing.Union[str, datasets.splits.Split, list[str], list[datasets.splits.Split], NoneType] = Nonecache_dir: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonedownload_config: typing.Optional[datasets.download.download_config.DownloadConfig] = Nonedownload_mode: typing.Union[datasets.download.download_manager.DownloadMode, str, NoneType] = Noneverification_mode: typing.Union[datasets.utils.info_utils.VerificationMode, str, NoneType] = Nonekeep_in_memory: typing.Optional[bool] = Nonesave_infos: bool = Falserevision: typing.Union[datasets.utils.version.Version, str, NoneType] = Nonetoken: typing.Union[bool, str, NoneType] = Nonestreaming: bool = Falsenum_proc: typing.Optional[int] = Nonestorage_options: typing.Optional[dict] = None**config_kwargs ) → Dataset or DatasetDict
Tham số
- path (
str) — Đường dẫn hoặc tên của dataset.-
nếu
pathlà một kho dữ liệu trên HF hub (liệt kê tất cả các bộ dữ liệu khả dụng bằnghuggingface_hub.list_datasets) -> tải bộ dữ liệu từ các tệp được hỗ trợ trong kho (csv, json, parquet, v.v.) ví dụ:'username/dataset_name', một kho dữ liệu trên HF hub chứa các tệp dữ liệu. -
nếu
pathlà một thư mục trong một Storage Bucket trên HF Hub (liệt kê các bucket của bạn bằnghuggingface_hub.list_buckets) -> tải dataset từ các tệp được hỗ trợ trong thư mục (csv, json, parquet, v.v.) ví dụ'buckets/username/bucket_name/my_dataset'. -
nếu
pathlà một thư mục cục bộ -> tải bộ dữ liệu từ các tệp được hỗ trợ trong thư mục (csv, json, parquet, v.v.) ví dụ:'./path/to/directory/with/my/csv/data'. -
nếu
pathlà tên của một dataset builder vàdata_fileshoặcdata_dirđược chỉ định (các builder khả dụng là “json”, “csv”, “parquet”, “arrow”, “text”, “xml”, “webdataset”, “imagefolder”, “audiofolder”, “videofolder”, “meshfolder”) -> tải dataset từ các tệp trongdata_fileshoặcdata_dirví dụ'parquet'.
Sử dụng đường dẫn
hf://như'hf://datasets/username/dataset_name'để chỉ cho phép truy cập từ xa. Sử dụng đường dẫn tuyệt đối để chỉ cho phép truy cập cục bộ. -
- name (
str, tùy chọn) — Định nghĩa tên của cấu hình bộ dữ liệu. - data_dir (
str, tùy chọn) — Định nghĩadata_dircủa cấu hình bộ dữ liệu. Nếu được chỉ định cho các trình xây dựng chung (csv, text, v.v.) hoặc các bộ dữ liệu Hub vàdata_fileslàNone, hành vi tương đương với việc truyềnos.path.join(data_dir, **)làmdata_filesđể tham chiếu tất cả các tệp trong một thư mục. - data_files (
strhoặcSequencehoặcMapping, tùy chọn) — Đường dẫn đến tệp dữ liệu nguồn. - split (
Splithoặcstr) — Chỉ định phần chia (split) của dữ liệu cần tải. Nếu làNone, sẽ trả về mộtdictchứa tất cả các phần chia (thường làdatasets.Split.TRAINvàdatasets.Split.TEST). Nếu được chỉ định, sẽ trả về một Dataset duy nhất. Các phần chia có thể được kết hợp và chỉ định theo cách tương tự như trong tensorflow-datasets. - cache_dir (
str, tùy chọn) — Thư mục để đọc/ghi dữ liệu. Mặc định là"~/.cache/huggingface/datasets". - features (
Features, tùy chọn) — Đặt kiểu đặc trưng cần sử dụng cho bộ dữ liệu này. - download_config (DownloadConfig, tùy chọn) — Các tham số cấu hình tải xuống cụ thể.
- download_mode (DownloadMode hoặc
str, mặc định làREUSE_DATASET_IF_EXISTS) — Chế độ tải xuống/tạo. - verification_mode (VerificationMode hoặc
str, mặc định làBASIC_CHECKS) — Chế độ xác minh xác định các kiểm tra cần chạy trên thông tin bộ dữ liệu đã tải/xử lý (checksums/size/splits/…).Được thêm vào 2.9.1
- keep_in_memory (
bool, mặc định làNone) — Có sao chép bộ dữ liệu trong bộ nhớ hay không. Nếu làNone, bộ dữ liệu sẽ không được sao chép trong bộ nhớ trừ khi được bật rõ ràng bằng cách đặtdatasets.config.IN_MEMORY_MAX_SIZEthành giá trị khác không. Xem thêm chi tiết trong phần cải thiện hiệu suất. - revision (Version hoặc
str, tùy chọn) — Phiên bản của bộ dữ liệu cần tải. Vì các bộ dữ liệu có kho git riêng trên Datasets Hub, phiên bản mặc định “main” tương ứng với nhánh “main” của chúng. Bạn có thể chỉ định một phiên bản khác với mặc định “main” bằng cách sử dụng commit SHA hoặc git tag của kho dữ liệu. - token (
strhoặcbool, tùy chọn) — Chuỗi hoặc giá trị boolean tùy chọn để dùng làm Bearer token cho các tệp từ xa trên Datasets Hub. Nếu làTrue, hoặc không được chỉ định, sẽ lấy token từ"~/.huggingface". - streaming (
bool, mặc định làFalse) — Nếu đặt thànhTrue, thì không tải xuống các tệp dữ liệu. Thay vào đó, nó sẽ phát trực tiếp dữ liệu theo từng phần trong khi lặp qua dataset. Một IterableDataset hoặc IterableDatasetDict sẽ được trả về trong trường hợp này.Lưu ý rằng streaming hoạt động với các dataset sử dụng định dạng dữ liệu hỗ trợ việc lặp qua (iterated over), chẳng hạn như txt, csv, jsonl. Các tệp Json có thể được tải xuống hoàn toàn. Ngoài ra, streaming từ các tệp zip hoặc gzip từ xa được hỗ trợ nhưng các định dạng nén khác như rar và xz thì chưa được hỗ trợ. Định dạng tgz không cho phép streaming.
- num_proc (
int, tùy chọn, mặc định làNone) — Số lượng tiến trình khi tải xuống và tạo dataset cục bộ. Multiprocessing bị tắt theo mặc định.Được thêm vào 2.7.0
- storage_options (
dict, tuỳ chọn, mặc định làNone) — Thí nghiệm. Các cặp key/value được truyền đến backend hệ thống tệp của dataset, nếu có.Được thêm vào 2.11.0
- **config_kwargs (các tham số từ khóa bổ sung) —
Các tham số từ khóa được truyền đến
BuilderConfigvà được sử dụng trong DatasetBuilder.
Trả về
Dataset hoặc DatasetDict
- nếu
splitkhông phải làNone: bộ dữ liệu được yêu cầu, - nếu
splitlàNone, một DatasetDict với mỗi split.
hoặc IterableDataset hoặc IterableDatasetDict: nếu streaming=True
- nếu
splitkhông phải làNone, bộ dữ liệu sẽ được yêu cầu - nếu
splitlàNone, một~datasets.streaming.IterableDatasetDictvới mỗi split.
Tải một bộ dữ liệu từ Hugging Face Hub, hoặc một bộ dữ liệu cục bộ.
Bạn có thể tìm thấy danh sách các bộ dữ liệu trên Hub hoặc bằng huggingface_hub.list_datasets.
Một dataset là một thư mục chứa một số tệp dữ liệu ở các định dạng phổ biến (JSON, CSV, Parquet, v.v.) và có thể có cấu trúc phổ biến (Webdataset, ImageFolder, AudioFolder, VideoFolder, MeshFolder, v.v.)
Hàm này thực hiện các bước sau bên trong:
Tải một trình xây dựng bộ dữ liệu:
- Tìm định dạng dữ liệu phổ biến nhất trong bộ dữ liệu và chọn trình xây dựng tương ứng (JSON, CSV, Parquet, Webdataset, ImageFolder, AudioFolder, MeshFolder, v.v.)
- Tìm tệp nào thuộc phần chia nào (ví dụ: train/test) dựa trên tên tệp và tên thư mục hoặc dựa trên cấu hình YAML
- Bạn cũng có thể chỉ định
data_filesthủ công, và trình xây dựng bộ dữ liệu cần sử dụng (ví dụ: “parquet”).
Chạy trình xây dựng bộ dữ liệu:
Trong trường hợp tổng quát:
Tải các tệp dữ liệu từ bộ dữ liệu nếu chúng chưa có sẵn cục bộ hoặc chưa được lưu trong bộ nhớ đệm.
Xử lý và lưu bộ dữ liệu trong các bảng Arrow có kiểu để lưu bộ.
Bảng Arrow là các bảng có kiểu dữ liệu, có độ dài tùy ý, có thể lưu trữ các đối tượng lồng nhau và được ánh xạ sang các kiểu dữ liệu tổng quát của numpy/pandas/python. Chúng có thể được truy cập trực tiếp từ ổ đĩa, tải vào RAM hoặc thậm chí được phát trực tiếp qua web.
Trong trường hợp streaming:
- Không tải xuống hoặc lưu bộ nhớ đệm bất kỳ thứ gì. Thay vào đó, tập dữ liệu được nạp theo kiểu lười (lazy) và sẽ được phát trực tiếp (stream) khi lặp qua nó.
Trả về một dataset được xây dựng từ các phần chia được yêu cầu trong
split(mặc định: tất cả).
Ví dụ:
Tải một tập dữ liệu từ Hugging Face Hub:
>>> from datasets import load_dataset
>>> ds = load_dataset('cornell-movie-review-data/rotten_tomatoes', split='train')
# Load a subset or dataset configuration (here 'sst2')
>>> from datasets import load_dataset
>>> ds = load_dataset('nyu-mll/glue', 'sst2', split='train')
# Manual mapping of data files to splits
>>> data_files = {'train': 'train.csv', 'test': 'test.csv'}
>>> ds = load_dataset('namespace/your_dataset_name', data_files=data_files)
# Manual selection of a directory to load
>>> ds = load_dataset('namespace/your_dataset_name', data_dir='folder_name')Tải một tập dữ liệu từ một Storage Bucket trên Hugging Face Hub:
>>> from datasets import load_dataset
>>> ds = load_dataset('buckets/username/bucket_name/rotten_tomatoes', split='train')Tải bộ dữ liệu cục bộ:
# Load a CSV file
>>> from datasets import load_dataset
>>> ds = load_dataset('csv', data_files='path/to/local/my_dataset.csv')
# Load a JSON file
>>> from datasets import load_dataset
>>> ds = load_dataset('json', data_files='path/to/local/my_dataset.json')Tải một IterableDataset:
>>> from datasets import load_dataset
>>> ds = load_dataset('cornell-movie-review-data/rotten_tomatoes', split='train', streaming=True)datasets.load_from_disk
< source >( dataset_path: typing.Union[str, bytes, os.PathLike]keep_in_memory: typing.Optional[bool] = Nonestorage_options: typing.Optional[dict] = None ) → Dataset or DatasetDict
Tham số
- dataset_path (
path-like) — Đường dẫn (ví dụ:"dataset/train") hoặc URI từ xa (ví dụ:"s3://my-bucket/dataset/train") của thư mục Dataset hoặc DatasetDict mà bộ dữ liệu/bộ từ điển dữ liệu sẽ được tải từ đó. - keep_in_memory (
bool, mặc định làNone) — Có sao chép bộ dữ liệu trong bộ nhớ hay không. Nếu làNone, bộ dữ liệu sẽ không được sao chép trong bộ nhớ trừ khi được bật rõ ràng bằng cách đặtdatasets.config.IN_MEMORY_MAX_SIZEthành giá trị khác không. Xem thêm chi tiết trong phần cải thiện hiệu suất. - storage_options (
dict, tùy chọn) — Các cặp khóa/giá trị được truyền đến backend hệ thống tệp, nếu có.Được thêm vào 2.9.0
Trả về
Dataset hoặc DatasetDict
- Nếu
dataset_pathlà đường dẫn của một thư mục dataset: dataset được yêu cầu. - Nếu
dataset_pathlà đường dẫn của một thư mục dict dữ liệu, một DatasetDict với mỗi split.
Tải một tập dữ liệu đã được lưu trước đó bằng save_to_disk() từ một thư mục tập dữ liệu, hoặc
từ một hệ thống tệp bằng bất kỳ cài đặt nào của fsspec.spec.AbstractFileSystem.
datasets.load_dataset_builder
< source >( path: strname: typing.Optional[str] = Nonedata_dir: typing.Optional[str] = Nonedata_files: typing.Union[str, collections.abc.Sequence[str], collections.abc.Mapping[str, typing.Union[str, collections.abc.Sequence[str]]], NoneType] = Nonecache_dir: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonedownload_config: typing.Optional[datasets.download.download_config.DownloadConfig] = Nonedownload_mode: typing.Union[datasets.download.download_manager.DownloadMode, str, NoneType] = Nonerevision: typing.Union[datasets.utils.version.Version, str, NoneType] = Nonetoken: typing.Union[bool, str, NoneType] = Nonestorage_options: typing.Optional[dict] = None**config_kwargs )
Tham số
- path (
str) — Đường dẫn hoặc tên của dataset.-
nếu
pathlà một kho dữ liệu trên HF hub (liệt kê tất cả các bộ dữ liệu khả dụng bằnghuggingface_hub.list_datasets) -> tải bộ xây dựng dữ liệu từ các tệp được hỗ trợ trong kho (csv, json, parquet, v.v.) ví dụ:'username/dataset_name', một kho dữ liệu trên HF hub chứa các tệp dữ liệu. -
nếu
pathlà một thư mục trong một Storage Bucket trên HF Hub (liệt kê các bucket của bạn bằnghuggingface_hub.list_buckets) -> tải dataset từ các tệp được hỗ trợ trong thư mục (csv, json, parquet, v.v.) ví dụ'buckets/username/bucket_name/my_dataset'. -
nếu
pathlà một thư mục cục bộ -> tải trình xây dựng bộ dữ liệu từ các tệp được hỗ trợ trong thư mục (csv, json, parquet, v.v.) ví dụ:'./path/to/directory/with/my/csv/data'. -
nếu
pathlà tên của một dataset builder vàdata_fileshoặcdata_dirđược chỉ định (các builder có sẵn là “json”, “csv”, “parquet”, “arrow”, “text”, “xml”, “webdataset”, “imagefolder”, “audiofolder”, “videofolder”, “meshfolder”) -> tải dataset builder từ các tệp trongdata_fileshoặcdata_dirví dụ'parquet'.
Sử dụng đường dẫn
hf://như'hf://datasets/username/dataset_name'để chỉ cho phép truy cập từ xa. Sử dụng đường dẫn tuyệt đối để chỉ cho phép truy cập cục bộ. -
- name (
str, tùy chọn) — Định nghĩa tên của cấu hình bộ dữ liệu. - data_dir (
str, tùy chọn) — Định nghĩadata_dircủa cấu hình bộ dữ liệu. Nếu được chỉ định cho các trình xây dựng chung (csv, text, v.v.) hoặc các bộ dữ liệu Hub vàdata_fileslàNone, hành vi tương đương với việc truyềnos.path.join(data_dir, **)làmdata_filesđể tham chiếu tất cả các tệp trong một thư mục. - data_files (
strhoặcSequencehoặcMapping, tùy chọn) — Đường dẫn đến tệp dữ liệu nguồn. - cache_dir (
str, tùy chọn) — Thư mục để đọc/ghi dữ liệu. Mặc định là"~/.cache/huggingface/datasets". - features (Features, tùy chọn) — Đặt kiểu đặc trưng cần sử dụng cho bộ dữ liệu này.
- download_config (DownloadConfig, tùy chọn) — Các tham số cấu hình tải xuống cụ thể.
- download_mode (DownloadMode hoặc
str, mặc định làREUSE_DATASET_IF_EXISTS) — Chế độ tải xuống/tạo. - revision (Version hoặc
str, tùy chọn) — Phiên bản của bộ dữ liệu cần tải. Vì các bộ dữ liệu có kho git riêng trên Datasets Hub, phiên bản mặc định “main” tương ứng với nhánh “main” của chúng. Bạn có thể chỉ định một phiên bản khác với mặc định “main” bằng cách sử dụng commit SHA hoặc git tag của kho dữ liệu. - token (
strhoặcbool, tùy chọn) — Chuỗi hoặc giá trị boolean tùy chọn để dùng làm Bearer token cho các tệp từ xa trên Datasets Hub. Nếu làTrue, hoặc không được chỉ định, sẽ lấy token từ"~/.huggingface". - storage_options (
dict, tuỳ chọn, mặc định làNone) — Thí nghiệm. Các cặp key/value được truyền đến backend hệ thống tệp của dataset, nếu có.Được thêm vào 2.11.0
- **config_kwargs (các tham số từ khóa bổ sung) — Các tham số từ khóa được truyền đến BuilderConfig và được sử dụng trong DatasetBuilder.
Tải một trình xây dựng bộ dữ liệu có thể được sử dụng để:
- Kiểm tra thông tin chung cần thiết để xây dựng một tập dữ liệu (thư mục cache, cấu hình, thông tin tập dữ liệu, các đặc trưng, tệp dữ liệu, v.v.)
- Tải xuống và chuẩn bị bộ dữ liệu dưới dạng tệp Arrow trong bộ nhớ đệm
- Lấy một tập dữ liệu dạng luồng mà không cần tải xuống hoặc lưu bộ nhớ đệm bất kỳ thứ gì
Bạn có thể tìm thấy danh sách các bộ dữ liệu trên Hub hoặc bằng huggingface_hub.list_datasets.
Một dataset là một thư mục chứa một số tệp dữ liệu ở các định dạng phổ biến (JSON, CSV, Parquet, v.v.) và có thể có cấu trúc phổ biến (Webdataset, ImageFolder, AudioFolder, VideoFolder, MeshFolder, v.v.)
datasets.get_dataset_config_names
< source >( path: strrevision: typing.Union[datasets.utils.version.Version, str, NoneType] = Nonedownload_config: typing.Optional[datasets.download.download_config.DownloadConfig] = Nonedownload_mode: typing.Union[datasets.download.download_manager.DownloadMode, str, NoneType] = Nonedata_files: typing.Union[str, list, dict, NoneType] = None**download_kwargs )
Tham số
- path (
str) — đường dẫn đến kho dữ liệu. Có thể là:- đường dẫn cục bộ đến thư mục bộ dữ liệu chứa các tệp dữ liệu,
ví dụ:
'./dataset/squad' - một định danh bộ dữ liệu trên Hugging Face Hub (liệt kê tất cả các bộ dữ liệu và id khả dụng bằng
huggingface_hub.list_datasets), ví dụ'rajpurkar/squad','nyu-mll/glue'hoặc`'openai/webtext'
- đường dẫn cục bộ đến thư mục bộ dữ liệu chứa các tệp dữ liệu,
ví dụ:
- revision (
Union[str, datasets.Version], tuỳ chọn) — Nếu được chỉ định, module dataset sẽ được tải từ kho datasets ở phiên bản này. Mặc định:- nó được đặt thành phiên bản cục bộ của thư viện.
- nó cũng sẽ cố gắng tải từ nhánh chính nếu không có sẵn ở phiên bản cục bộ của thư viện. Việc chỉ định một phiên bản khác với phiên bản cục bộ của thư viện có thể gây ra các vấn đề về tương thích.
- download_config (DownloadConfig, tùy chọn) — Các tham số cấu hình tải xuống cụ thể.
- download_mode (DownloadMode hoặc
str, mặc định làREUSE_DATASET_IF_EXISTS) — Chế độ tải xuống/tạo. - data_files (
Union[Dict, List, str], tùy chọn) — Định nghĩa data_files của cấu hình bộ dữ liệu. - **download_kwargs (các tham số từ khóa bổ sung) —
Các thuộc tính tùy chọn cho DownloadConfig, sẽ ghi đè lên các thuộc tính trong
download_confignếu được cung cấp, ví dụ nhưtoken.
Lấy danh sách các tên cấu hình khả dụng cho một bộ dữ liệu cụ thể.
datasets.get_dataset_infos
< source >( path: strdata_files: typing.Union[str, list, dict, NoneType] = Nonedownload_config: typing.Optional[datasets.download.download_config.DownloadConfig] = Nonedownload_mode: typing.Union[datasets.download.download_manager.DownloadMode, str, NoneType] = Nonerevision: typing.Union[datasets.utils.version.Version, str, NoneType] = Nonetoken: typing.Union[bool, str, NoneType] = None**config_kwargs )
Tham số
- path (
str) — đường dẫn đến kho dữ liệu. Có thể là:- đường dẫn cục bộ đến thư mục bộ dữ liệu chứa các tệp dữ liệu,
ví dụ:
'./dataset/squad' - một định danh bộ dữ liệu trên Hugging Face Hub (liệt kê tất cả các bộ dữ liệu và id khả dụng bằng
huggingface_hub.list_datasets), ví dụ'rajpurkar/squad','nyu-mll/glue'hoặc`'openai/webtext'
- đường dẫn cục bộ đến thư mục bộ dữ liệu chứa các tệp dữ liệu,
ví dụ:
- revision (
Union[str, datasets.Version], tuỳ chọn) — Nếu được chỉ định, module dataset sẽ được tải từ kho datasets ở phiên bản này. Mặc định:- nó được đặt thành phiên bản cục bộ của thư viện.
- nó cũng sẽ cố gắng tải từ nhánh chính nếu không có sẵn ở phiên bản cục bộ của thư viện. Việc chỉ định một phiên bản khác với phiên bản cục bộ của thư viện có thể gây ra các vấn đề về tương thích.
- download_config (DownloadConfig, tùy chọn) — Các tham số cấu hình tải xuống cụ thể.
- download_mode (DownloadMode hoặc
str, mặc định làREUSE_DATASET_IF_EXISTS) — Chế độ tải xuống/tạo. - data_files (
Union[Dict, List, str], tùy chọn) — Định nghĩa data_files của cấu hình bộ dữ liệu. - token (
strhoặcbool, tùy chọn) — Chuỗi hoặc giá trị boolean tùy chọn để dùng làm Bearer token cho các tệp từ xa trên Datasets Hub. Nếu làTrue, hoặc không được chỉ định, sẽ lấy token từ"~/.huggingface". - **config_kwargs (các tham số bổ sung) — Các thuộc tính tùy chọn cho lớp builder, sẽ ghi đè lên các thuộc tính hiện có nếu được cung cấp.
Lấy thông tin meta về một dataset, được trả về dưới dạng dict ánh xạ tên config tới DatasetInfoDict.
datasets.get_dataset_split_names
< source >( path: strconfig_name: typing.Optional[str] = Nonedata_files: typing.Union[str, collections.abc.Sequence[str], collections.abc.Mapping[str, typing.Union[str, collections.abc.Sequence[str]]], NoneType] = Nonedownload_config: typing.Optional[datasets.download.download_config.DownloadConfig] = Nonedownload_mode: typing.Union[datasets.download.download_manager.DownloadMode, str, NoneType] = Nonerevision: typing.Union[datasets.utils.version.Version, str, NoneType] = Nonetoken: typing.Union[bool, str, NoneType] = None**config_kwargs )
Tham số
- path (
str) — đường dẫn đến kho dữ liệu. Có thể là:- đường dẫn cục bộ đến thư mục bộ dữ liệu chứa các tệp dữ liệu,
ví dụ:
'./dataset/squad' - một định danh bộ dữ liệu trên Hugging Face Hub (liệt kê tất cả các bộ dữ liệu và id khả dụng bằng
huggingface_hub.list_datasets), ví dụ'rajpurkar/squad','nyu-mll/glue'hoặc`'openai/webtext'
- đường dẫn cục bộ đến thư mục bộ dữ liệu chứa các tệp dữ liệu,
ví dụ:
- config_name (
str, tùy chọn) — Định nghĩa tên của cấu hình bộ dữ liệu. - data_files (
strhoặcSequencehoặcMapping, tùy chọn) — Đường dẫn đến tệp dữ liệu nguồn. - download_config (DownloadConfig, tùy chọn) — Các tham số cấu hình tải xuống cụ thể.
- download_mode (DownloadMode hoặc
str, mặc định làREUSE_DATASET_IF_EXISTS) — Chế độ tải xuống/tạo. - revision (Version hoặc
str, tùy chọn) — Phiên bản của bộ dữ liệu cần tải. Vì các bộ dữ liệu có kho git riêng trên Datasets Hub, phiên bản mặc định “main” tương ứng với nhánh “main” của chúng. Bạn có thể chỉ định một phiên bản khác với mặc định “main” bằng cách sử dụng commit SHA hoặc git tag của kho dữ liệu. - token (
strhoặcbool, tùy chọn) — Chuỗi hoặc giá trị boolean tùy chọn để dùng làm Bearer token cho các tệp từ xa trên Datasets Hub. Nếu làTrue, hoặc không được chỉ định, sẽ lấy token từ"~/.huggingface". - **config_kwargs (các tham số bổ sung) — Các thuộc tính tùy chọn cho lớp builder, sẽ ghi đè lên các thuộc tính hiện có nếu được cung cấp.
Lấy danh sách các phần chia (splits) khả dụng cho một cấu hình và bộ dữ liệu cụ thể.
Từ các tệp
Các cấu hình được sử dụng để tải các tệp dữ liệu. Chúng được sử dụng khi tải các tệp cục bộ hoặc một kho dữ liệu:
- tệp cục bộ:
load_dataset("parquet", data_dir="path/to/data/dir") - kho dữ liệu:
load_dataset("allenai/c4")
Bạn có thể truyền các đối số vào load_dataset để cấu hình việc tải dữ liệu.
Ví dụ, bạn có thể chỉ định tham số sep để định nghĩa CsvConfig được sử dụng để tải dữ liệu:
load_dataset("csv", data_dir="path/to/data/dir", sep="\t")Văn bản
class datasets.packaged_modules.text.TextConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Noneencoding: str = 'utf-8'encoding_errors: typing.Optional[str] = Nonechunksize: int = 10485760keep_linebreaks: bool = Falsesample_by: typing.Literal['line', 'paragraph', 'document'] = 'line' )
Tham số
- features — (
Features, tùy chọn): Chuyển đổi dữ liệu sangfeatures. - encoding — (
str, mặc định là “utf-8”): Mã hóa để giải mã tệp. - encoding_errors — (
str, tùy chọn): Tham số để xác định cách xử lý khi xảy ra lỗi mã hóa. Đây giống với tham sốerrortrongopen(). - chunksize — (
Features, tùy chọn, mặc định là “10MB”): Kích thước chunk để đọc dữ liệu. - keep_linebreaks — (
bool, mặc định là False): Có nên giữ các ký tự xuống dòng hay không. - sample_by (
Literal["line", "paragraph", "document"], mặc định là “line”) — Xác định việc nạp dữ liệu theo từng dòng, đoạn văn hay tài liệu. Mặc định, một hàng trong bộ dữ liệu = một dòng.
BuilderConfig cho tệp văn bản.
lớp datasets.packaged_modules.text.Text
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
CSV
lớp datasets.packaged_modules.csv.CsvConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonesep: str = ','delimiter: typing.Optional[str] = Noneheader: typing.Union[int, list[int], str, NoneType] = 'infer'names: typing.Optional[list[str]] = Nonecolumn_names: typing.Optional[list[str]] = Noneindex_col: typing.Union[int, str, list[int], list[str], NoneType] = Noneusecols: typing.Union[list[int], list[str], NoneType] = Noneprefix: typing.Optional[str] = Nonemangle_dupe_cols: bool = Trueengine: typing.Optional[typing.Literal['c', 'python', 'pyarrow']] = Noneconverters: dict = Nonetrue_values: typing.Optional[list] = Nonefalse_values: typing.Optional[list] = Noneskipinitialspace: bool = Falseskiprows: typing.Union[int, list[int], NoneType] = Nonenrows: typing.Optional[int] = Nonena_values: typing.Union[str, list[str], NoneType] = Nonekeep_default_na: bool = Truena_filter: bool = Trueverbose: bool = Falseskip_blank_lines: bool = Truethousands: typing.Optional[str] = Nonedecimal: str = '.'lineterminator: typing.Optional[str] = Nonequotechar: str = '"'quoting: int = 0escapechar: typing.Optional[str] = Nonecomment: typing.Optional[str] = Noneencoding: typing.Optional[str] = Nonedialect: typing.Optional[str] = Noneerror_bad_lines: bool = Truewarn_bad_lines: bool = Trueskipfooter: int = 0doublequote: bool = Truememory_map: bool = Falsefloat_precision: typing.Optional[str] = Nonechunksize: int = 10000features: typing.Optional[datasets.features.features.Features] = Noneencoding_errors: typing.Optional[str] = 'strict'on_bad_lines: typing.Literal['error', 'warn', 'skip'] = 'error'date_format: typing.Optional[str] = None )
BuilderConfig cho CSV.
lớp datasets.packaged_modules.csv.Csv
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
JSON
lớp datasets.packaged_modules.json.JsonConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Noneencoding: str = 'utf-8'encoding_errors: typing.Optional[str] = Nonefield: typing.Optional[str] = Noneuse_threads: bool = Trueblock_size: typing.Optional[int] = Nonechunksize: int = 10485760newlines_in_values: typing.Optional[bool] = Noneon_mixed_types: typing.Optional[typing.Literal['use_json']] = 'use_json'parse_agent_traces: bool = True )
BuilderConfig cho JSON.
lớp datasets.Json
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
XML
lớp datasets.packaged_modules.xml.XmlConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Noneencoding: str = 'utf-8'encoding_errors: typing.Optional[str] = None )
BuilderConfig cho tệp xml.
lớp datasets.packaged_modules.xml.Xml
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
Parquet
class datasets.packaged_modules.parquet.ParquetConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonebatch_size: typing.Optional[int] = Nonecolumns: typing.Optional[list[str]] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonefilters: typing.Union[pyarrow._compute.Expression, list[tuple], list[list[tuple]], NoneType] = Nonefragment_scan_options: typing.Optional[pyarrow._dataset_parquet.ParquetFragmentScanOptions] = Noneon_bad_files: typing.Literal['error', 'warn', 'skip'] = 'error' )
Tham số
- batch_size (
int, tùy chọn) — Kích thước của các RecordBatches để lặp qua. Giá trị mặc định là kích thước của nhóm hàng (được định nghĩa bởi nhóm hàng đầu tiên). - columns (
list[str], tùy chọn) — Danh sách các cột cần tải, các cột còn lại sẽ bị bỏ qua. Mặc định, tất cả các cột đều được tải. - features — (
Features, tùy chọn): Chuyển đổi dữ liệu sangfeatures. - filters (
Union[pyarrow.dataset.Expression, list[tuple], list[list[tuple]]], tùy chọn) — Chỉ trả về các dòng khớp với bộ lọc. Nếu có thể, điều kiện sẽ được đẩy xuống để khai thác thông tin phân vùng hoặc siêu dữ liệu bên trong tìm thấy trong nguồn dữ liệu, ví dụ như thống kê Parquet. Nếu không, bộ lọc sẽ được áp dụng lên các RecordBatch đã tải trước khi trả về chúng. - fragment_scan_options (
pyarrow.dataset.ParquetFragmentScanOptions, tuỳ chọn) — Các tuỳ chọn quét dành riêng cho các fragment Parquet. Điều này đặc biệt hữu ích để cấu hình bộ đệm và bộ nhớ đệm.Được thêm vào 4.2.0
- on_bad_files (
Literal["error", "warn", "skip"], tuỳ chọn, mặc định là “error”) — Chỉ định cách xử lý khi gặp tệp lỗi (tệp không thể đọc được). Các giá trị được phép là :- ‘error’, ném một Exception khi gặp tệp không hợp lệ.
- ‘warn’, phát ra cảnh báo khi gặp tệp không hợp lệ và bỏ qua tệp đó.
- ‘skip’, bỏ qua các tệp lỗi mà không gây ra ngoại lệ hay cảnh báo khi gặp chúng.
Được thêm vào 4.2.0
BuilderConfig cho Parquet.
Ví dụ:
Dòng hóa dữ liệu và lọc dữ liệu một cách hiệu quả, có thể bỏ qua toàn bộ các tệp hoặc nhóm hàng:
>>> filters = [("col_0", "==", 0)]
>>> ds = load_dataset(parquet_dataset_id, streaming=True, filters=filters)Tăng kích thước yêu cầu tối thiểu khi streaming từ 32MiB (mặc định) lên 128MiB và bật prefetching:
>>> import pyarrow
>>> import pyarrow.dataset
>>> fragment_scan_options = pyarrow.dataset.ParquetFragmentScanOptions(
... cache_options=pyarrow.CacheOptions(
... prefetch_limit=1,
... range_size_limit=128 << 20
... ),
... )
>>> ds = load_dataset(parquet_dataset_id, streaming=True, fragment_scan_options=fragment_scan_options)class datasets.packaged_modules.parquet.Parquet
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
Arrow
class datasets.packaged_modules.arrow.ArrowConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = None )
BuilderConfig cho Arrow.
class datasets.packaged_modules.arrow.Arrow
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
Vortex
class datasets.packaged_modules.vortex.VortexConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonebatch_size: typing.Optional[int] = Nonecolumns: typing.Optional[list[str]] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonefilters: typing.Union[ForwardRef('vortex.expr.Expr'), list[tuple], list[list[tuple]], NoneType] = Noneon_bad_files: typing.Literal['error', 'warn', 'skip'] = 'error' )
Tham số
- batch_size (
int, tùy chọn) — Kích thước của các RecordBatches để lặp qua. Giá trị mặc định được định nghĩa bởi trình quét Vortex. - columns (
list[str], tùy chọn) — Danh sách các cột cần tải, các cột còn lại sẽ bị bỏ qua. Mặc định, tất cả các cột đều được tải. - features — (
Features, tùy chọn): Chuyển đổi dữ liệu sangfeatures. - filters (
Union[vortex.expr.Expr, list[tuple], list[list[tuple]]], tuỳ chọn) — Chỉ trả về các dòng khớp với bộ lọc. Điều kiện được đẩy xuống (push down) vào thao tác quét Vortex để chỉ đọc các dòng khớp. Các bộ lọc được cung cấp dưới dạng danh sách các bộ (tuple) (DNF, giống như bộ nạp Parquet chấp nhận) sẽ được chuyển đổi thành một biểu thức Vortex. Giá trị null tuân theo ngữ nghĩa SQL: một giá trị null không thỏa mãn bất kỳ phép so sánh nào, do đó một dòng có cột bị lọc là null sẽ không bao giờ được trả về. Lưu ý rằngnot indo đó sẽ loại bỏ các giá trị null, trong khi bộ nạp Parquet giữ lại chúng vì nó xây dựng~field.isin(values)và một giá trị null không nằm trong tập hợp. - on_bad_files (
Literal["error", "warn", "skip"], tuỳ chọn, mặc định là “error”) — Chỉ định cách xử lý khi gặp tệp lỗi (tệp không thể đọc được). Các giá trị được phép là :- ‘error’, ném một Exception khi gặp tệp không hợp lệ.
- ‘warn’, phát ra cảnh báo khi gặp tệp không hợp lệ và bỏ qua tệp đó.
- ‘skip’, bỏ qua các tệp lỗi mà không gây ra ngoại lệ hay cảnh báo khi gặp chúng.
BuilderConfig cho Vortex.
Ví dụ:
class datasets.packaged_modules.vortex.Vortex
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
SQL
class datasets.packaged_modules.sql.SqlConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonesql: typing.Union[str, ForwardRef('sqlalchemy.sql.Selectable')] = Nonecon: typing.Union[str, ForwardRef('sqlalchemy.engine.Connection'), ForwardRef('sqlalchemy.engine.Engine'), ForwardRef('sqlite3.Connection')] = Noneindex_col: typing.Union[str, list[str], NoneType] = Nonecoerce_float: bool = Trueparams: typing.Union[list, tuple, dict, NoneType] = Noneparse_dates: typing.Union[list, dict, NoneType] = Nonecolumns: typing.Optional[list[str]] = Nonechunksize: typing.Optional[int] = 10000features: typing.Optional[datasets.features.features.Features] = None )
BuilderConfig cho SQL.
class datasets.packaged_modules.sql.Sql
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
Hình ảnh
class datasets.packaged_modules.imagefolder.ImageFolderConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonedrop_labels: bool = Nonedrop_metadata: bool = Nonemetadata_filenames: list = Nonefilters: typing.Union[pyarrow._compute.Expression, list[tuple], list[list[tuple]], NoneType] = Nonedecode_num_threads: int = 32 )
BuilderConfig cho ImageFolder.
class datasets.packaged_modules.imagefolder.ImageFolder
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
Âm thanh
class datasets.packaged_modules.audiofolder.AudioFolderConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonedrop_labels: bool = Nonedrop_metadata: bool = Nonemetadata_filenames: list = Nonefilters: typing.Union[pyarrow._compute.Expression, list[tuple], list[list[tuple]], NoneType] = Nonedecode_num_threads: int = 32 )
Cấu hình Builder cho AudioFolder.
class datasets.packaged_modules.audiofolder.AudioFolder
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
Video
lớp datasets.packaged_modules.videofolder.VideoFolderConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonedrop_labels: bool = Nonedrop_metadata: bool = Nonemetadata_filenames: list = Nonefilters: typing.Union[pyarrow._compute.Expression, list[tuple], list[list[tuple]], NoneType] = Nonedecode_num_threads: int = 32 )
BuilderConfig cho ImageFolder.
class datasets.packaged_modules.videofolder.VideoFolder
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
HDF5
class datasets.packaged_modules.hdf5.HDF5Config
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonebatch_size: typing.Optional[int] = Nonefeatures: typing.Optional[datasets.features.features.Features] = None )
BuilderConfig cho HDF5.
lớp datasets.packaged_modules.hdf5.HDF5
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
ArrowBasedBuilder chuyển đổi các tệp HDF5 thành bảng Arrow bằng cách sử dụng các kiểu mở rộng của HF.
TsFile
class datasets.packaged_modules.tsfile.TsFileConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonetable_name: Optional[str] = Nonecolumns: Optional[list[str]] = Nonestart_time: Optional[Any] = Noneend_time: Optional[Any] = Noneinput_batch_size: int = 65536output_batch_size: int = 32features: Optional[datasets.Features] = Noneon_bad_files: Literal['error', 'warn', 'skip'] = 'error'timestamp_unit: Literal['s', 'ms', 'us', 'ns'] = 'ms'timestamp_tz: Optional[str] = None )
Tham số
- table_name (str, optional) — Tên của bảng cần đọc. Khi không được đặt, bảng đầu tiên được tìm thấy trong tệp hợp lệ đầu tiên sẽ được sử dụng. Việc tra cứu không phân biệt chữ hoa chữ thường.
- columns (list[str], optional) — Tập con các cột FIELD cần giữ lại. Các cột TAG và cột TIME luôn được trả về (chúng xác định thiết bị / dòng thời gian của thiết bị và không thể bị loại trừ). Các tên tham chiếu đến cột TAG hoặc TIME, hoặc đến các trường không có trong bất kỳ tệp nào, sẽ được xử lý im lặng: các TAG/TIME vẫn được xuất ra như bình thường, và các trường chưa từng xuất hiện sẽ trở thành các cột danh sách toàn null. Khi không được đặt, tất cả các FIELD sẽ được trả về.
- start_time, end_time (datetime, date, pa.TimestampScalar, str ISO-8601, hoặc int, optional) —
Khoảng thời gian bao gồm cả hai đầu. Có thể bỏ qua một trong hai ranh giới.
Giá trị
datetimeđược lấy theo múi giờ riêng của chúng (UTC nếu không có múi giờ);intđược hiểu là epoch thô theotimestamp_unit. - input_batch_size (int, tuỳ chọn, mặc định là 65_536) —
Số dòng tối đa được lấy cho mỗi Arrow batch từ
TsFileReader.query_table. Kiểm soát bộ nhớ đỉnh khi streaming một thiết bị duy nhất. - output_batch_size (int, optional, mặc định là 32) — Số lượng thiết bị (dòng dữ liệu của tập dữ liệu đầu ra) được đóng gói vào mỗi lô ghi Arrow (Arrow record batch) được chuyển đến trình ghi (writer). Đây cũng là mức độ chi tiết mà thanh tiến độ của tập dữ liệu được cập nhật; các giá trị nhỏ hơn cho phản hồi phản hồi nhanh hơn khi đọc chậm trên từng thiết bị, trong khi các giá trị lớn hơn làm giảm chi phí xử lý cho mỗi lô.
- features (Features, tùy chọn) — Sơ đồ Features cuối cùng. Khi được cung cấp, bước quét metadata trên các tệp đầu vào sẽ bị bỏ qua.
- on_bad_files (Literal[“error”, “warn”, “skip”], optional, mặc định là “error”) — Cách xử lý nếu một tệp không thể mở hoặc thiếu bảng được yêu cầu.
- timestamp_unit (Literal[“s”, “ms”, “us”, “ns”], tuỳ chọn, mặc định là “ms”) — Đơn vị thời gian cho cột timestamp. IoTDB mặc định dùng mili giây.
- timestamp_tz (str, optional) —
Múi giờ cho cột timestamp.
Nonecó nghĩa là không có múi giờ.
BuilderConfig cho TsFile (mô hình bảng) — định dạng rộng theo thiết bị.
Trình xây dựng định dạng rộng trên mỗi thiết bị cho TsFile (mô hình bảng).
lớp datasets.packaged_modules.pdffolder.PdfFolderConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonedrop_labels: bool = Nonedrop_metadata: bool = Nonemetadata_filenames: list = Nonefilters: typing.Union[pyarrow._compute.Expression, list[tuple], list[list[tuple]], NoneType] = Nonedecode_num_threads: int = 32 )
BuilderConfig cho ImageFolder.
class datasets.packaged_modules.pdffolder.PdfFolder
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
Nifti
lớp datasets.packaged_modules.niftifolder.NiftiFolderConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonedrop_labels: bool = Nonedrop_metadata: bool = Nonemetadata_filenames: list = Nonefilters: typing.Union[pyarrow._compute.Expression, list[tuple], list[list[tuple]], NoneType] = Nonedecode_num_threads: int = 32 )
BuilderConfig cho NiftiFolder.
lớp datasets.packaged_modules.niftifolder.NiftiFolder
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
WebDataset
class datasets.packaged_modules.webdataset.WebDataset
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
Harbor
class datasets.packaged_modules.harbor.HarborConfig
< source >( name: str = 'default'version: typing.Union[datasets.utils.version.Version, str, NoneType] = 0.0.0data_dir: typing.Optional[str] = Nonedata_files: typing.Union[datasets.data_files.DataFilesDict, datasets.data_files.DataFilesPatternsDict, NoneType] = Nonedescription: typing.Optional[str] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonestrip_canary: bool = Trueinclude_files: bool = True )
Tham số
- features (
Features, tùy chọn) — Đặt các đặc trưng được sử dụng để chuyển đổi (cast) các hàng đã tạo. Mặc định, các đặc trưng của một tác vụ Harbor được sử dụng (xemHarbor). - strip_canary (
bool, tùy chọn, mặc định làTrue) — Xóa các dòng chú thích “benchmark data canary” ở đầuinstruction.mdvà từ các hướng dẫn của các bước, giống như cách Harbor thực hiện khi gửi chúng cho một agent. - include_files (
bool, tùy chọn, mặc định làTrue) — Liệt kê tất cả các tệp của mọi tác vụ (environment/,tests/,solution/…) trong cộtfiles. Đặt thànhFalseđể bỏ qua việc liệt kê các thư mục tác vụ, giúp nhanh hơn khi bộ dữ liệu nằm trên hệ thống tệp từ xa.
BuilderConfig cho các kho tác vụ Harbor.
class datasets.packaged_modules.harbor.Harbor
< source >( cache_dir: typing.Optional[str] = Nonedataset_name: typing.Optional[str] = Noneconfig_name: typing.Optional[str] = Nonehash: typing.Optional[str] = Nonebase_path: typing.Optional[str] = Noneinfo: typing.Optional[datasets.info.DatasetInfo] = Nonefeatures: typing.Optional[datasets.features.features.Features] = Nonetoken: typing.Union[bool, str, NoneType] = Nonerepo_id: typing.Optional[str] = Nonedata_files: typing.Union[str, list, dict, datasets.data_files.DataFilesDict, NoneType] = Nonedata_dir: typing.Optional[str] = Nonestorage_options: typing.Optional[dict] = Nonewriter_batch_size: typing.Optional[int] = Noneconfig_id: typing.Optional[str] = None**config_kwargs )
Trình tạo cho các kho tác vụ Harbor: một hàng cho mỗi thư mục tác vụ.
Nó tạo ra các tính năng sau:
- name (
str) — tên của tác vụ, dưới dạngorg/nametrong[task].namecủatask.toml, hoặc tên của thư mục tác vụ khitask.tomlkhông có phần[task]. - mô tả (
str) —[task].descriptioncủatask.toml. - instruction (
str) — nội dung củainstruction.md. - keywords (
listcủastr) —[task].keywordscủatask.toml. - schema_version (
str) —schema_versionđược khai báo trongtask.toml. - config (
dict) — toàn bộtask.toml, dưới dạng đối tượng JSON. - metadata (
dict) — phần[metadata]dạng tự do củatask.toml. - files (
listcủastr) — tất cả các tệp của tác vụ, tương đối so với thư mục tác vụ. - location (
str) — đường dẫn của thư mục tác vụ, tính từ gốc của bộ dữ liệu.