DatasetCardData class
Dataset Card Metadata that is used by Hugging Face Hub when included at the top of your README.md
Args:
language (List[str]
, optional):
Language of dataset's data or metadata. It must be an ISO 639-1, 639-2 or
639-3 code (two/three letters), or a special value like "code", "multilingual".
license (Union[str, List[str]]
, optional):
License(s) of this dataset. Example: apache-2.0 or any license from
https://huggingface.co/docs/hub/repositories-licenses.
annotations_creators (Union[str, List[str]]
, optional):
How the annotations for the dataset were created.
Options are: 'found', 'crowdsourced', 'expert-generated', 'machine-generated', 'no-annotation', 'other'.
language_creators (Union[str, List[str]]
, optional):
How the text-based data in the dataset was created.
Options are: 'found', 'crowdsourced', 'expert-generated', 'machine-generated', 'other'
multilinguality (Union[str, List[str]]
, optional):
Whether the dataset is multilingual.
Options are: 'monolingual', 'multilingual', 'translation', 'other'.
size_categories (Union[str, List[str]]
, optional):
The number of examples in the dataset. Options are: 'n<1K', '1K<n<10K', '10K<n<100K',
'100K<n<1M', '1M<n<10M', '10M<n<100M', '100M<n<1B', '1B<n<10B', '10B<n<100B', '100B<n<1T', 'n>1T', and 'other'.
source_datasets (List[str]]
, optional):
Indicates whether the dataset is an original dataset or extended from another existing dataset.
Options are: 'original' and 'extended'.
task_categories (Union[str, List[str]]
, optional):
What categories of task does the dataset support?
task_ids (Union[str, List[str]]
, optional):
What specific tasks does the dataset support?
paperswithcode_id (str
, optional):
ID of the dataset on PapersWithCode.
pretty_name (str
, optional):
A more human-readable name for the dataset. (ex. "Cats vs. Dogs")
train_eval_index (Dict
, optional):
A dictionary that describes the necessary spec for doing evaluation on the Hub.
If not provided, it will be gathered from the 'train-eval-index' key of the kwargs.
config_names (Union[str, List[str]]
, optional):
A list of the available dataset configs for the dataset.
Constructors
-
DatasetCardData({List<
String> ? language, List<String> ? license, List<String> ? annotationsCreators, List<String> ? languageCreators, List<String> ? multilinguality, List<String> ? sizeCategories, List<String> ? sourceDatasets, List<String> ? taskCategories, List<String> ? taskIds, String? paperswithcodeId, String? prettyName, Map<String, dynamic> ? trainEvalIndex, List<String> ? configNames, bool ignoreMetadataErrors = false, Map<String, dynamic> ? kwargs}) -
DatasetCardData.fromJson(Map<
String, dynamic> data, {bool ignoreMetadataErrors = false}) -
factory
Properties
-
annotationsCreators
↔ List<
String> ? -
getter/setter pair
-
configNames
↔ List<
String> ? -
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
-
language
↔ List<
String> ? -
getter/setter pair
-
languageCreators
↔ List<
String> ? -
getter/setter pair
-
license
↔ List<
String> ? -
getter/setter pair
-
multilinguality
↔ List<
String> ? -
getter/setter pair
- paperswithcodeId ↔ String?
-
getter/setter pair
- prettyName ↔ String?
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sizeCategories
↔ List<
String> ? -
getter/setter pair
-
sourceDatasets
↔ List<
String> ? -
getter/setter pair
-
taskCategories
↔ List<
String> ? -
getter/setter pair
-
taskIds
↔ List<
String> ? -
getter/setter pair
-
trainEvalIndex
↔ Map<
String, dynamic> ? -
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited