Skip to contents

Read and write

read_croissant()
Read Croissant metadata
write_croissant()
Write Croissant metadata
croissant_context()
Croissant JSON-LD context

Validate

validate_croissant()
Validate Croissant metadata
is_valid()
Test whether validation found no errors
CroissantIssues()
CroissantIssues: problems found in Croissant metadata

Records

read_record_set()
Read the records of a record set
croissant_from_data()
Create Croissant metadata for a table

Hugging Face

read_croissant_hf()
Read the Croissant metadata of a Hugging Face dataset
hf_download()
Download a file from a Hugging Face dataset

Metadata classes

Croissant()
Croissant: metadata of one dataset
FileObject()
FileObject: a single file of the dataset
FileSet()
FileSet: a set of files matched by glob patterns
RecordSet()
RecordSet: a set of records with a common structure
Field()
Field: one column or attribute of a record set
ParentField()
ParentField: the field a nested field joins to
Source()
Source: where a field's values come from
Extract()
Extract: how a field's values are read from a source
Transform()
Transform: a transformation applied to extracted values
Person()
Person: a person who created or published a dataset
Organization()
Organization: an organization that created or published a dataset
CreativeWork()
CreativeWork: a license or other work named by a dataset

Package

croissant croissant-package
croissant: Read and Write 'Croissant' Metadata