Datasets documentation
طرق التحميل
طرق التحميل
طرق سرد مجموعات البيانات وتحميلها:
مجموعات البيانات
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
المعاملات
- path (
str) — مسار أو اسم مجموعة البيانات. إذا كان المسار مستودع مجموعة بيانات على HF hub (يمكنك عرض جميع مجموعات البيانات المتاحة باستخدام huggingface_hub.list_datasets) -> يتم تحميل مجموعة البيانات من الملفات المدعومة في المستودع (csv، json، parquet، إلخ) مثل 'username/dataset_name'، وهو مستودع مجموعة بيانات على HF hub يحتوي على ملفات البيانات. إذا كان المسار مجلدًا داخل Storage Bucket على HF Hub (يمكنك عرض حاوياتك باستخدام huggingface_hub.list_buckets) -> يتم تحميل مجموعة البيانات من الملفات المدعومة في المجلد (csv، json، parquet، إلخ) مثل 'buckets/username/bucket_name/my_dataset'. إذا كان المسار مجلدًا محليًا -> يتم تحميل مجموعة البيانات من الملفات المدعومة في المجلد (csv، json، parquet، إلخ) مثل './path/to/directory/with/my/csv/data'. إذا كان المسار اسم منشئ مجموعة بيانات وتم تحديد data_files أو data_dir (المُنشِئون المتاحون هم "json"، "csv"، "parquet"، "arrow"، "text"، "xml"، "webdataset"، "imagefolder"، "audiofolder"، "videofolder"، "meshfolder") -> يتم تحميل مجموعة البيانات من الملفات في data_files أو data_dir مثل 'parquet'. استخدم مسارًا بصيغة hf:// مثل 'hf://datasets/username/dataset_name' للسماح بالوصول عن بُعد فقط. استخدم مسارًا مطلقًا للسماح بالوصول محليًا فقط.-
إذا كان
pathمستودع بيانات على HF hub (قائمة بجميع مجموعات البيانات المتاحة باستخدامhuggingface_hub.list_datasets) -> تحميل مجموعة البيانات من الملفات المدعومة في المستودع (csv، json، parquet، إلخ) مثال:'username/dataset_name'، وهو مستودع بيانات على HF hub يحتوي على ملفات البيانات. -
إذا كان
pathمجلدًا داخل حاوية تخزين على HF Hub (يمكنك عرض حاوياتك باستخدامhuggingface_hub.list_buckets) -> حمّل مجموعة البيانات من الملفات المدعومة داخل المجلد (csv، json، parquet، إلخ) مثال:'buckets/username/bucket_name/my_dataset'. -
إذا كان
pathمجلدًا محليًا -> حمّل مجموعة البيانات من الملفات المدعومة داخل المجلد (csv، json، parquet، إلخ) على سبيل المثال'./path/to/directory/with/my/csv/data'. -
إذا كان
pathاسمًا لبناء مجموعة بيانات وتم تحديدdata_filesأوdata_dir(البنّاءون المتاحون هم “json” و “csv” و “parquet” و “arrow” و “text” و “xml” و “webdataset” و “imagefolder” و “audiofolder” و “videofolder” و “meshfolder”) -> حمّل مجموعة البيانات من الملفات الموجودة فيdata_filesأوdata_dirعلى سبيل المثال'parquet'.
استخدم مسارًا بصيغة
hf://مثل'hf://datasets/username/dataset_name'للسماح بالوصول عن بُعد فقط. استخدم مسارًا مطلقًا للسماح بالوصول محليًا فقط. -
- name (
str، اختياري) — تحديد اسم تكوين مجموعة البيانات. - data_dir (
str، اختياري) — تحديدdata_dirلإعدادات مجموعة البيانات. إذا تم تحديده للمُنشئين العاميين (csv، text وما إلى ذلك) أو مجموعات بيانات Hub وكانتdata_filesهيNone، فإن السلوك يكون مساوياً لتمريرos.path.join(data_dir, **)كـdata_filesللإشارة إلى جميع الملفات في مجلد. - data_files (
strأوSequenceأوMapping، اختياري) — مسار(ات) إلى ملف(ات) البيانات المصدرية. - split (
Splitأوstr) — أي جزء من البيانات يُحمَّل. إذا كانNone، فسيُعادdictيحتوي على جميع الأجزاء (عادةًdatasets.Split.TRAINوdatasets.Split.TEST). إذا تم تقديمه، فسيُعاد Dataset واحد. يمكن دمج الأجزاء وتحديد طريقة كتابتها كما في tensorflow-datasets. - cache_dir (
str، اختياري) — المجلد الذي تتم فيه قراءة البيانات/كتابتها. القيمة الافتراضية هي"~/.cache/huggingface/datasets". - features (
Features، اختياري) — تعيين نوع الميزات المستخدمة لهذا مجموعة البيانات. - download_config (DownloadConfig، اختياري) — معلمات محددة لإعدادات التنزيل.
- download_mode (DownloadMode أو
str، الافتراضيREUSE_DATASET_IF_EXISTS) — وضع التنزيل/التوليد. - verification_mode (VerificationMode أو
str, الافتراضي هوBASIC_CHECKS) — وضع التحقق الذي يحدد الفحوصات التي يجب إجراؤها على معلومات المجموعة البيانات المُحمّلة/المعالجة (القيم التجزئة/الحجم/التقسيمات/...).أُضيف في 2.9.1
- keep_in_memory (
bool، القيمة الافتراضيةNone) — ما إذا كان سيتم نسخ مجموعة البيانات في الذاكرة. إذا كانتNone، فلن يتم نسخ مجموعة البيانات في الذاكرة ما لم يتم تفعيل ذلك صراحةً عن طريق تعيينdatasets.config.IN_MEMORY_MAX_SIZEإلى قيمة غير صفرية. راجع مزيدًا من التفاصيل في قسم تحسين الأداء. - revision (Version أو
str، اختياري) — إصدار مجموعة البيانات التي سيتم تحميلها. بما أن مجموعات البيانات تملك مستودع git خاصًا بها على Datasets Hub، فإن الإصدار الافتراضي “main” يتوافق مع فرع “main” الخاص بها. يمكنك تحديد إصدار مختلف عن الافتراضي “main” باستخدام SHA للالتزام أو وسم git لمستودع مجموعة البيانات. - token (
strأوbool، اختياري) — نص أو قيمة منطقية اختيارية لاستخدامها كرمز Bearer للملفات البعيدة على Datasets Hub. إذا كانتTrue، أو لم تُحدد، فسيتم الحصول على الرمز من"~/.huggingface". - streaming (
bool, الافتراضي هوFalse) — إذا تم تعيينه إلىTrue, لا يتم تنزيل ملفات البيانات. بدلاً من ذلك، يتم بث البيانات تدريجياً أثناء التكرار على مجموعة البيانات. يتم إرجاع IterableDataset أو IterableDatasetDict في هذه الحالة بدلاً من ذلك.لاحظ أن البث يعمل مع مجموعات البيانات التي تستخدم صيغ بيانات تدعم التكرار عليها، مثل txt وcsv وjsonl على سبيل المثال. قد يتم تنزيل ملفات Json بالكامل. كما يُدعم البث من ملفات zip أو gzip عن بُعد، لكن صيغ الضغط الأخرى مثل rar وxz غير مدعومة بعد. ولا تسمح صيغة tgz بالبث.
- num_proc (
int, اختياري, الافتراضي هوNone) — عدد العمليات عند تنزيل مجموعة البيانات وتوليدها محليًا. تُعطَّل المعالجة متعددة العمليات افتراضيًا.أُضيف في 2.7.0
- storage_options (
dict, اختياري, الافتراضي هوNone) — تجريبي. أزواج مفتاح/قيمة تُمرَّر إلى نظام ملفات مجموعة البيانات، إن وُجد.أُضيف في 2.11.0
- **config_kwargs (معلمات إضافية) —
معلمات تُمرَّر إلى
BuilderConfigوتُستخدم في DatasetBuilder.
يعيد
- إذا لم يكن
splitهوNone: مجموعة البيانات المطلوبة، - إذا كان
splitهوNone، فسيتم إرجاع DatasetDict يحتوي على كل تقسيم.
أو IterableDataset أو IterableDatasetDict: إذا كان streaming=True
- إذا لم يكن
splitهوNone، يتم طلب مجموعة البيانات - إذا كان
splitهوNone، فسيتم إرجاع~datasets.streaming.IterableDatasetDictيحتوي على كل تقسيم.
حمّل مجموعة بيانات من Hugging Face Hub أو مجموعة بيانات محلية.
يمكنك العثور على قائمة مجموعات البيانات على Hub أو باستخدام huggingface_hub.list_datasets.
مجموعة البيانات هي مجلد يحتوي على بعض ملفات البيانات بتنسيقات عامة (JSON وCSV وParquet وغيرها) وربما بهيكلية عامة (Webdataset وImageFolder وAudioFolder وVideoFolder وMeshFolder وغيرها)
تنفذ هذه الوظيفة ما يلي في الخلفية:
تحميل مُنشئ مجموعة بيانات:
- حدد صيغة البيانات الأكثر شيوعًا في مجموعة البيانات واختر المُنشئ المرتبط بها (JSON، CSV، Parquet، Webdataset، ImageFolder، AudioFolder، MeshFolder، إلخ.)
- حدد أي ملف ينتمي إلى أي تقسيم (مثل train/test) بناءً على أسماء الملفات والمجلدات أو على إعدادات YAML
- كما يمكن تحديد
data_filesيدويًا، وتحديد مُنشئ مجموعة البيانات الذي يجب استخدامه (مثل “parquet”).
شغّل مُنشئ مجموعة البيانات:
في الحالة العامة:
قم بتنزيل ملفات البيانات من مجموعة البيانات إذا لم تكن متاحة محليًا أو مخزنة مؤقتًا بالفعل.
معالجة مجموعة البيانات وتخزينها مؤقتًا في جداول Arrow مُنمّطة لأغراض التخزين المؤقت.
جداول Arrow هي جداول طويلة بشكل تعسّفي ومُعرَّفة الأنواع، يمكنها تخزين كائنات متداخلة، ويمكن ربطها بأنواع numpy/pandas/python العامة. يمكن الوصول إليها مباشرةً من القرص، أو تحميلها في الذاكرة العشوائية (RAM)، أو حتى بثّها عبر الويب.
في حالة البث:
- لا تقم بتنزيل أي شيء أو تخزينه مؤقتًا. بدلاً من ذلك، يتم تحميل مجموعة البيانات بشكل كسول وستُدفَع على الفور أثناء التكرار عليها.
إرجاع مجموعة بيانات مبنية من التقسيمات المطلوبة في
split(الافتراضي: الكل).
مثال:
تحميل مجموعة بيانات من 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')تحميل مجموعة بيانات من حاوية تخزين على Hugging Face Hub:
>>> from datasets import load_dataset
>>> ds = load_dataset('buckets/username/bucket_name/rotten_tomatoes', split='train')تحميل مجموعة بيانات محلية:
# 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')قم بتحميل 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
المعاملات
- dataset_path (
path-like) — المسار (مثل"dataset/train") أو عنوان URI عن بُعد (مثل"s3://my-bucket/dataset/train") لمجلد Dataset أو DatasetDict الذي سيتم تحميل مجموعة البيانات/قاموس مجموعات البيانات منه. - keep_in_memory (
bool، القيمة الافتراضيةNone) — ما إذا كان سيتم نسخ مجموعة البيانات في الذاكرة. إذا كانتNone، فلن يتم نسخ مجموعة البيانات في الذاكرة ما لم يتم تفعيل ذلك صراحةً عن طريق تعيينdatasets.config.IN_MEMORY_MAX_SIZEإلى قيمة غير صفرية. راجع مزيدًا من التفاصيل في قسم تحسين الأداء. - storage_options (
dict, اختياري) — أزواج مفتاح/قيمة تُمرَّر إلى نظام الملفات الخلفي، إن وُجد.أُضيف في 2.9.0
يعيد
- إذا كان
dataset_pathمسارًا لمجلد مجموعة بيانات: مجموعة البيانات المطلوبة. - إذا كان
dataset_pathمسارًا لمجلد قاموس مجموعة بيانات، فإن الناتج سيكون DatasetDict يحتوي على كل تقسيم.
تحمّل مجموعة بيانات تم حفظها سابقاً باستخدام save_to_disk() من مجلد مجموعة البيانات، أو
من نظام الملفات باستخدام أي تطبيق من تطبيقات 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 )
المعاملات
- path (
str) — مسار أو اسم مجموعة البيانات. إذا كان المسار مستودع مجموعة بيانات على HF hub (يمكنك عرض جميع مجموعات البيانات المتاحة باستخدام huggingface_hub.list_datasets) -> يتم تحميل منشئ مجموعة البيانات من الملفات المدعومة في المستودع (csv، json، parquet، إلخ) مثل 'username/dataset_name'، وهو مستودع مجموعة بيانات على HF hub يحتوي على ملفات البيانات. إذا كان المسار مجلدًا داخل Storage Bucket على HF Hub (يمكنك عرض حاوياتك باستخدام huggingface_hub.list_buckets) -> يتم تحميل مجموعة البيانات من الملفات المدعومة في المجلد (csv، json، parquet، إلخ) مثل 'buckets/username/bucket_name/my_dataset'. إذا كان المسار مجلدًا محليًا -> يتم تحميل منشئ مجموعة البيانات من الملفات المدعومة في المجلد (csv، json، parquet، إلخ) مثل './path/to/directory/with/my/csv/data'. إذا كان المسار اسم منشئ مجموعة بيانات وتم تحديد data_files أو data_dir (المنشئات المتاحة هي "json"، "csv"، "parquet"، "arrow"، "text"، "xml"، "webdataset"، "imagefolder"، "audiofolder"، "videofolder"، "meshfolder") -> يتم تحميل منشئ مجموعة البيانات من الملفات في data_files أو data_dir مثل 'parquet'. استخدم مسارًا بصيغة hf:// مثل 'hf://datasets/username/dataset_name' للسماح بالوصول عن بُعد فقط. استخدم مسارًا مطلقًا للسماح بالوصول محليًا فقط.-
إذا كان
pathمستودع بيانات على HF hub (قائمة بجميع مجموعات البيانات المتاحة باستخدامhuggingface_hub.list_datasets) -> تحميل منشئ مجموعة البيانات من الملفات المدعومة في المستودع (csv، json، parquet، إلخ) مثال:'username/dataset_name'، وهو مستودع بيانات على HF hub يحتوي على ملفات البيانات. -
إذا كان
pathمجلدًا داخل حاوية تخزين على HF Hub (يمكنك عرض حاوياتك باستخدامhuggingface_hub.list_buckets) -> حمّل مجموعة البيانات من الملفات المدعومة داخل المجلد (csv، json، parquet، إلخ) مثال:'buckets/username/bucket_name/my_dataset'. -
إذا كان
pathمجلدًا محليًا -> حمّل منشئ مجموعة البيانات من الملفات المدعومة داخل المجلد (csv، json، parquet، إلخ) على سبيل المثال'./path/to/directory/with/my/csv/data'. -
إذا كان
pathاسمًا لبناء مجموعة بيانات وتم تحديدdata_filesأوdata_dir(البنّاءون المتاحون هم “json” و “csv” و “parquet” و “arrow” و “text” و “xml” و “webdataset” و “imagefolder” و “audiofolder” و “videofolder” و “meshfolder”) -> حمّل بناء مجموعة البيانات من الملفات الموجودة فيdata_filesأوdata_dirعلى سبيل المثال'parquet'.
استخدم مسارًا بصيغة
hf://مثل'hf://datasets/username/dataset_name'للسماح بالوصول عن بُعد فقط. استخدم مسارًا مطلقًا للسماح بالوصول محليًا فقط. -
- name (
str، اختياري) — تحديد اسم تكوين مجموعة البيانات. - data_dir (
str، اختياري) — تحديدdata_dirلإعدادات مجموعة البيانات. إذا تم تحديده للمُنشئين العاميين (csv، text وما إلى ذلك) أو مجموعات بيانات Hub وكانتdata_filesهيNone، فإن السلوك يكون مساوياً لتمريرos.path.join(data_dir, **)كـdata_filesللإشارة إلى جميع الملفات في مجلد. - data_files (
strأوSequenceأوMapping، اختياري) — مسار(ات) إلى ملف(ات) البيانات المصدرية. - cache_dir (
str، اختياري) — المجلد الذي تتم فيه قراءة البيانات/كتابتها. القيمة الافتراضية هي"~/.cache/huggingface/datasets". - features (Features، اختياري) — تعيين نوع الميزات (features) المستخدمة لهذا مجموعة البيانات.
- download_config (DownloadConfig، اختياري) — معلمات محددة لإعدادات التنزيل.
- download_mode (DownloadMode أو
str، الافتراضيREUSE_DATASET_IF_EXISTS) — وضع التنزيل/التوليد. - revision (Version أو
str، اختياري) — إصدار مجموعة البيانات التي سيتم تحميلها. بما أن مجموعات البيانات تملك مستودع git خاصًا بها على Datasets Hub، فإن الإصدار الافتراضي “main” يتوافق مع فرع “main” الخاص بها. يمكنك تحديد إصدار مختلف عن الافتراضي “main” باستخدام SHA للالتزام أو وسم git لمستودع مجموعة البيانات. - token (
strأوbool، اختياري) — نص أو قيمة منطقية اختيارية لاستخدامها كرمز Bearer للملفات البعيدة على Datasets Hub. إذا كانتTrue، أو لم تُحدد، فسيتم الحصول على الرمز من"~/.huggingface". - storage_options (
dict, اختياري, الافتراضي هوNone) — تجريبي. أزواج مفتاح/قيمة تُمرَّر إلى نظام ملفات مجموعة البيانات، إن وُجد.أُضيف في 2.11.0
- **config_kwargs (حجج إضافية بالكلمات المفتاحية) — حجج بالكلمات المفتاحية تُمرَّر إلى BuilderConfig وتُستخدم في DatasetBuilder.
حمّل مُنشئ مجموعة بيانات يمكن استخدامه لـ:
- فحص المعلومات العامة المطلوبة لبناء مجموعة بيانات (مجلد التخزين المؤقت، الإعدادات، معلومات المجموعة، الميزات، ملفات البيانات، وما إلى ذلك)
- قم بتنزيل مجموعة البيانات وتجهيزها كملفات Arrow في ذاكرة التخزين المؤقت
- احصل على مجموعة بيانات متدفقة دون تنزيل أو تخزين مؤقت لأي شيء
يمكنك العثور على قائمة مجموعات البيانات على Hub أو باستخدام huggingface_hub.list_datasets.
مجموعة البيانات هي مجلد يحتوي على بعض ملفات البيانات بتنسيقات عامة (JSON وCSV وParquet وغيرها) وربما بهيكلية عامة (Webdataset وImageFolder وAudioFolder وVideoFolder وMeshFolder وغيرها)
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 )
المعاملات
- path (
str) — مسار مستودع مجموعة البيانات. يمكن أن يكون أحد ما يلي:- مسار محلي إلى دليل مجموعة البيانات الذي يحتوي على ملفات البيانات،
مثل
'./dataset/squad' - معرّف مجموعة بيانات على Hugging Face Hub (قائمة جميع مجموعات البيانات والمعرّفات المتاحة باستخدام
huggingface_hub.list_datasets)، مثل'rajpurkar/squad'أو'nyu-mll/glue'أو'openai/webtext'
- مسار محلي إلى دليل مجموعة البيانات الذي يحتوي على ملفات البيانات،
مثل
- revision (
Union[str, datasets.Version], اختياري) — إذا تم تحديده، فسيتم تحميل وحدة البيانات من مستودع datasets عند هذا الإصدار. افتراضيًا:- يتم ضبطه على النسخة المحلية من المكتبة.
- سيحاول أيضًا تحميله من الفرع الرئيسي إذا لم يكن متاحًا في النسخة المحلية من المكتبة. قد يؤدي تحديد نسخة مختلفة عن نسختك المحلية من المكتبة إلى مشاكل في التوافق.
- download_config (DownloadConfig، اختياري) — معلمات محددة لإعدادات التنزيل.
- download_mode (DownloadMode أو
str، الافتراضيREUSE_DATASET_IF_EXISTS) — وضع التنزيل/التوليد. - data_files (
Union[Dict, List, str]، اختياري) — تحديد ملفات البيانات data_files لإعداد مجموعة البيانات. - **download_kwargs (معلمات إضافية) —
خصائص اختيارية لـ DownloadConfig ستُلغي الخصائص الموجودة في
download_configإذا تم تقديمها، على سبيل المثالtoken.
احصل على قائمة أسماء الإعدادات المتاحة لمجموعة بيانات معينة.
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 )
المعاملات
- path (
str) — مسار مستودع مجموعة البيانات. يمكن أن يكون أحد ما يلي:- مسار محلي إلى دليل مجموعة البيانات الذي يحتوي على ملفات البيانات،
مثل
'./dataset/squad' - معرّف مجموعة بيانات على Hugging Face Hub (قائمة جميع مجموعات البيانات والمعرّفات المتاحة باستخدام
huggingface_hub.list_datasets)، مثل'rajpurkar/squad'أو'nyu-mll/glue'أو'openai/webtext'
- مسار محلي إلى دليل مجموعة البيانات الذي يحتوي على ملفات البيانات،
مثل
- revision (
Union[str, datasets.Version], اختياري) — إذا تم تحديده، فسيتم تحميل وحدة البيانات من مستودع datasets عند هذا الإصدار. افتراضيًا:- يتم ضبطه على النسخة المحلية من المكتبة.
- سيحاول أيضًا تحميله من الفرع الرئيسي إذا لم يكن متاحًا في النسخة المحلية من المكتبة. قد يؤدي تحديد نسخة مختلفة عن نسختك المحلية من المكتبة إلى مشاكل في التوافق.
- download_config (DownloadConfig، اختياري) — معلمات محددة لإعدادات التنزيل.
- download_mode (DownloadMode أو
str، الافتراضيREUSE_DATASET_IF_EXISTS) — وضع التنزيل/التوليد. - data_files (
Union[Dict, List, str]، اختياري) — تحديد ملفات البيانات data_files لإعداد مجموعة البيانات. - token (
strأوbool، اختياري) — نص أو قيمة منطقية اختيارية لاستخدامها كرمز Bearer للملفات البعيدة على Datasets Hub. إذا كانتTrue، أو لم تُحدد، فسيتم الحصول على الرمز من"~/.huggingface". - **config_kwargs (معلمات إضافية) — خصائص اختيارية لفئة المُنشئ (builder class) ستُلغي الخصائص الحالية إذا تم تقديمها.
احصل على المعلومات الوصفية عن مجموعة بيانات، وتُعاد كقاموس (dict) يربط اسم الإعداد (config name) بـ 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 )
المعاملات
- path (
str) — مسار مستودع مجموعة البيانات. يمكن أن يكون أحد ما يلي:- مسار محلي إلى دليل مجموعة البيانات الذي يحتوي على ملفات البيانات،
مثل
'./dataset/squad' - معرّف مجموعة بيانات على Hugging Face Hub (قائمة جميع مجموعات البيانات والمعرّفات المتاحة باستخدام
huggingface_hub.list_datasets)، مثل'rajpurkar/squad'أو'nyu-mll/glue'أو'openai/webtext'
- مسار محلي إلى دليل مجموعة البيانات الذي يحتوي على ملفات البيانات،
مثل
- config_name (
str، اختياري) — تحديد اسم تكوين مجموعة البيانات. - data_files (
strأوSequenceأوMapping، اختياري) — مسار(ات) إلى ملف(ات) البيانات المصدرية. - download_config (DownloadConfig، اختياري) — معلمات محددة لإعدادات التنزيل.
- download_mode (DownloadMode أو
str، الافتراضيREUSE_DATASET_IF_EXISTS) — وضع التنزيل/التوليد. - revision (Version أو
str، اختياري) — إصدار مجموعة البيانات التي سيتم تحميلها. بما أن مجموعات البيانات تملك مستودع git خاصًا بها على Datasets Hub، فإن الإصدار الافتراضي “main” يتوافق مع فرع “main” الخاص بها. يمكنك تحديد إصدار مختلف عن الافتراضي “main” باستخدام SHA للالتزام أو وسم git لمستودع مجموعة البيانات. - token (
strأوbool، اختياري) — نص أو قيمة منطقية اختيارية لاستخدامها كرمز Bearer للملفات البعيدة على Datasets Hub. إذا كانتTrue، أو لم تُحدد، فسيتم الحصول على الرمز من"~/.huggingface". - **config_kwargs (معلمات إضافية) — خصائص اختيارية لفئة المُنشئ (builder class) ستُلغي الخصائص الحالية إذا تم تقديمها.
احصل على قائمة التقسيمات المتاحة لإعداد معين ومجموعة بيانات.
من الملفات
التكوينات المستخدمة لتحميل ملفات البيانات. تُستخدم عند تحميل ملفات محلية أو مستودع مجموعة بيانات:
- الملفات المحلية:
load_dataset("parquet", data_dir="path/to/data/dir") - مستودع مجموعة البيانات:
load_dataset("allenai/c4")
يمكنك تمرير حُجج إلى load_dataset لضبط تحميل البيانات.
على سبيل المثال، يمكنك تحديد معامل sep لتعريف CsvConfig الذي يُستخدم لتحميل البيانات:
load_dataset("csv", data_dir="path/to/data/dir", sep="\t")نص
فئة 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' )
المعاملات
- features — (
Features، اختياري): تحويل البيانات إلىfeatures. - encoding — (
str، الافتراضي “utf-8”): ترميز لفك ترميز الملف. - encoding_errors — (
str، اختياري): حُجّة لتحديد الإجراء المتّبع في حال حدوث خطأ في الترميز. وهي نفسها الحُجّةerrorفيopen(). - chunksize — (
Features، اختياري، القيمة الافتراضية “10MB”): حجم الجزء المستخدم لقراءة البيانات. - keep_linebreaks — (
bool، الافتراضي False): ما إذا كان سيتم الإبقاء على علامات تبديل السطر. - sample_by (
Literal["line", "paragraph", "document"])، القيمة الافتراضية هي “line”) — ما إذا كان سيتم تحميل البيانات سطرًا سطرًا، أو فقرةً فقرةً، أو مستندًا مستندًا. افتراضيًا، كل صف في مجموعة البيانات = سطر واحد.
BuilderConfig لملفات النص.
class 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
class 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 لملفات CSV.
class 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
class 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 لملفات JSON.
class 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
class 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 لملفات xml.
class 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' )
المعاملات
- batch_size (
int، اختياري) — حجم مجموعات RecordBatches التي سيتم التكرار عليها. القيمة الافتراضية هي حجم مجموعة الصفوف (المعرّفة بواسطة مجموعة الصفوف الأولى). - columns (
list[str]، اختياري) — قائمة بالأعمدة التي سيتم تحميلها، وتُتجاهل الأعمدة الأخرى. يتم تحميل جميع الأعمدة افتراضيًا. - features — (
Features، اختياري): تحويل البيانات إلىfeatures. - filters (
Union[pyarrow.dataset.Expression, list[tuple], list[list[tuple]]]، اختياري) — إرجاع الصفوف المطابقة للمرشّح فقط. إذا كان ذلك ممكنًا، فسيتم دفع الشرط إلى الأسفل لاستغلال معلومات التقسيم أو البيانات الوصفية الداخلية الموجودة في مصدر البيانات، مثل إحصاءات Parquet. وإلا، فسيتم تصفية دفعات السجلات (RecordBatches) المحمّلة قبل تسليمها. - fragment_scan_options (
pyarrow.dataset.ParquetFragmentScanOptions, اختياري) — خيارات محددة للمسح الخاصة بقطع Parquet. هذا مفيد بشكل خاص لتكوين التخزين المؤقت والتخزين في الذاكرة.أُضيف في 4.2.0
- on_bad_files (
Literal["error", "warn", "skip"], اختياري, القيمة الافتراضية هي "error") — حدد الإجراء المتخذ عند مواجهة ملف معطوب (ملف لا يمكن قراءته). القيم المسموح بها هي:- ‘error’، ترمي استثناءً عند مواجهة ملف غير صالح.
- ‘warn’، إصدار تحذير عند مواجهة ملف غير صالح وتخطي ذلك الملف.
- ‘skip’، تخطي الملفات المعيبة دون رفع استثناء أو إصدار تحذير عند مواجهتها.
أُضيف في 4.2.0
BuilderConfig لـ Parquet.
مثال:
تحميل مجموعة فرعية من الأعمدة:
>>> ds = load_dataset(parquet_dataset_id, columns=["col_0", "col_1"])بث البيانات وفلترة البيانات بكفاءة، مع إمكانية تخطي ملفات كاملة أو مجموعات صفوف:
>>> filters = [("col_0", "==", 0)]
>>> ds = load_dataset(parquet_dataset_id, streaming=True, filters=filters)زيادة الحد الأدنى لحجم الطلب عند البث من 32MiB (الافتراضي) إلى 128MiB وتفعيل الجلب المسبق:
>>> 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
فئة 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 لـ 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' )
المعاملات
- batch_size (
int, اختياري) — حجم دفعات RecordBatches التي سيتم التكرار عليها. القيمة الافتراضية معرّفة بواسطة ماسح Vortex. - columns (
list[str]، اختياري) — قائمة بالأعمدة التي سيتم تحميلها، وتُتجاهل الأعمدة الأخرى. يتم تحميل جميع الأعمدة افتراضيًا. - features — (
Features، اختياري): تحويل البيانات إلىfeatures. - filters (
Union[vortex.expr.Expr, list[tuple], list[list[tuple]]]، اختياري) — تُرجع الصفوف المطابقة للمرشّح فقط. يتم دفع الشرط إلى مسح Vortex بحيث تُقرأ الصفوف المطابقة فقط. تُحوَّل المرشّحات المُعطاة كقائمة من السلاسل (DNF، كما يقبلها محمّل Parquet) إلى تعبير Vortex. تتبع القيم الفارغة (Nulls) دلالات SQL: القيمة الفارغة لا تحقق أي مقارنة، لذا لا يُرجع أبدًا صفًا تكون قيمته في العمود المرشَّح فارغة. لاحظ أنnot inيستبعد القيم الفارغة، بينما يحتفظ بها محمّل Parquet لأنه يبني~field.isin(values)والقيمة الفارغة ليست ضمن المجموعة. - on_bad_files (
Literal["error", "warn", "skip"], اختياري, القيمة الافتراضية هي "error") — حدد الإجراء المتخذ عند مواجهة ملف معطوب (ملف لا يمكن قراءته). القيم المسموح بها هي:- ‘error’، ترمي استثناءً عند مواجهة ملف غير صالح.
- ‘warn’، إصدار تحذير عند مواجهة ملف غير صالح وتخطي ذلك الملف.
- ‘skip’، تخطي الملفات المعيبة دون رفع استثناء أو إصدار تحذير عند مواجهتها.
BuilderConfig لـ Vortex.
مثال:
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 لـ 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 )
الصور
فئة 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 لـ 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 )
الصوت
فئة 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 )
إعدادات المُنشئ لـ 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 )
فيديوهات
فئة 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 لـ ImageFolder.
فئة 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
فئة 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 لـ HDF5.
class 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 الذي يحوّل ملفات HDF5 إلى جداول Arrow باستخدام أنواع الامتدادات الخاصة بـ 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 )
المعاملات
- table_name (str, اختياري) — اسم الجدول المطلوب قراءته. عند عدم تعيينه، يُستخدم أول جدول يُعثر عليه في أول ملف صالح. عمليات البحث غير حساسة لحالة الأحرف.
- columns (list[str]، اختياري) — مجموعة فرعية من أعمدة FIELD التي يجب الاحتفاظ بها. تُعاد أعمدة TAG وعمود TIME دائمًا (لأنها تحدد الجهاز / خطه الزمني ولا يمكن استبعادها). الأسماء التي تشير إلى أعمدة TAG أو TIME، أو إلى حقول غير موجودة في أي ملف، تُعالج بصمت: تُصدر TAGs/TIME كما هو معتاد، وتصبح الحقول غير المرئية أبدًا أعمدة قائمة فارغة (all-null). عند عدم التعيين، تُعاد جميع الحقول FIELD.
- start_time, end_time (datetime، date، pa.TimestampScalar، str بصيغة ISO-8601، أو int، اختياري) —
نطاق طوابع زمنية شامل. يمكن حذف أي من الحدين.
تُؤخذ قيم
datetimeفي نطاقها الزمني الخاص (UTC إذا كانت بدون نطاق زمني)؛ يُفسَّرintكقيمة خام للعصر (epoch) بوحدةtimestamp_unit. - input_batch_size (int، اختياري، القيمة الافتراضية 65_536) —
الحد الأقصى لعدد الصفوف المسترجعة لكل دفعة Arrow من
TsFileReader.query_table. يتحكم في ذروة الذاكرة أثناء بث جهاز واحد. - output_batch_size (int، اختياري، القيمة الافتراضية 32) — عدد الأجهزة (صفوف مجموعة البيانات الناتجة) المُجمَّعة في كل دفعة سجلات Arrow المُقدَّمة إلى الكاتب. وهو أيضًا الدقة التي تتقدم بها شريط تقدم مجموعة البيانات؛ فالقيم الأصغر توفر تغذية راجعة أكثر استجابة عند القراءة البطيئة لكل جهاز، بينما تقلل القيم الأكبر من النفقات لكل دفعة.
- features (Features، اختياري) — مخطط الميزات النهائي. عند تقديمه، يتم تجاوز مسح البيانات الوصفية على ملفات الإدخال.
- on_bad_files (Literal[“error”, “warn”, “skip”]، اختياري، القيمة الافتراضية هي “error”) — الإجراء المتّبع إذا تعذّر فتح ملف أو إذا كان يفتقر إلى الجدول المطلوب.
- timestamp_unit (Literal[“s”, “ms”, “us”, “ns”]، اختياري، الافتراضي “ms”) — وحدة الوقت لعمود الطابع الزمني. الافتراضي في IoTDB هو المللي ثانية.
- timestamp_tz (str، اختياري) —
منطقة التوقيت لعمود الطابع الزمني. تعني
Noneأن الطابع الزمني لا يحتوي على معلومات منطقة التوقيت.
BuilderConfig لـ TsFile (نموذج الجدول) — تنسيق عريض لكل جهاز.
منشئ واسع التنسيق لكل جهاز لـ TsFile (نموذج الجدول).
class 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 لـ ImageFolder.
فئة 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
فئة 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 لـ NiftiFolder.
فئة 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 )
المعاملات
- features (
Features، اختياري) — تعيين الميزات المستخدمة لصبّ الصفوف المولّدة. افتراضيًا، تُستخدم ميزات مهمة Harbor (انظرHarbor). - strip_canary (
bool، اختياري، القيمة الافتراضيةTrue) — إزالة أسطر التعليقات الافتتاحية “canary” لبيانات المعيار منinstruction.mdومن تعليمات الخطوات، كما يفعل Harbor عند إرسالها إلى الوكيل. - include_files (
bool، اختياري، القيمة الافتراضيةTrue) — قائمة بجميع ملفات كل مهمة (environment/،tests/،solution/…) في عمودfiles. اضبطه علىFalseلتخطي سرد دلائل المهام، وهو ما يكون أسرع عندما يكون مجموعة البيانات على نظام ملفات عن بُعد.
BuilderConfig لمستودعات مهام 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 )
أداة بناء لمستودعات مهام Harbor: صف واحد لكل مجلد مهام.
إنه يولّد الميزات التالية:
- name (
str) — اسم المهمة، على شكلorg/nameفي[task].nameمنtask.toml، أو اسم مجلد المهمة عندما لا يحتويtask.tomlعلى قسم[task]. - description (
str) —[task].descriptionالخاص بـtask.toml. - instruction (
str) — محتوىinstruction.md. - الكلمات المفتاحية (
listمنstr) —[task].keywordsفيtask.toml. - schema_version (
str) —schema_versionالمُعلَن فيtask.toml. - config (
dict) — ملفtask.tomlبالكامل، ككائن JSON. - metadata (
dict) — قسم[metadata]الحر فيtask.toml. - الملفات (
listمنstr) — جميع ملفات المهمة، نسبيًا إلى دليل المهمة. - location (
str) — مسار مجلد المهمة، نسبيًا إلى جذر مجموعة البيانات.