YData SDK API Reference

This page gives an overview of all public ydata-sdk objects, functions and methods.

The following subpackages are public.

• ydata.dataset: Dataset and MultiDataset public API
• ydata.metadata: Metadata and MultiMetadata public API
• ydata.profiling: Functions that are useful to profile and understand the quality of your data
• ydata.synthesizers: Synthetic data generators (RegularSynthesizer, TimeSeriesSynthesizer, MultiTableSynthesizer, FakerSynthesizer, LLMSynthesizer) and text generators (Q&A, Document) public API.
• ydata.report: Synthetic data quality PDF generation methods

Use the API reference documentation to explore all available modules, classes, and functions.

API reference by topic

Links below point to pages that pull references from the code (classes, methods, parameters).

Datasets

• Dataset
• MultiDataset
• Holdout

Metadata

• Metadata

Synthesizers

• Tabular synthetic generator — RegularSynthesizer
• Time-series synthetic generator — TimeSeriesSynthesizer
• Multi-Table synthetic generator — MultiTableSynthesizer
• Faker synthetic generator — FakerSynthesizer
• LLM synthetic generator — LLMSynthesizer (text to dataset)
• Q&A pairs generator — Q&A generation from documents
• Document generator — DocumentGenerator, DocumentFormat

For a more guided experience for particular use-cases please check ydata-sdk examples (add here the link).