HfHub.Cards.DatasetCardData (HfHub v0.2.0)

Copy Markdown View Source

Structured metadata for Dataset Cards.

Contains fields from the YAML frontmatter of a dataset's README.md.

Summary

Functions

Creates a DatasetCardData struct from a parsed YAML frontmatter map.

Types

t()

@type t() :: %HfHub.Cards.DatasetCardData{
  annotations_creators: [String.t()] | nil,
  configs: [map()] | nil,
  extra: map(),
  language: String.t() | [String.t()] | nil,
  language_creators: [String.t()] | nil,
  license: String.t() | nil,
  multilinguality: String.t() | nil,
  pretty_name: String.t() | nil,
  size_categories: [String.t()] | nil,
  source_datasets: [String.t()] | nil,
  tags: [String.t()] | nil,
  task_categories: [String.t()] | nil,
  task_ids: [String.t()] | nil
}

Functions

from_map(map)

@spec from_map(map()) :: t()

Creates a DatasetCardData struct from a parsed YAML frontmatter map.