Installation

YData SDK is generally available through both PyPi and Conda allowing an easy process of installation. This experience allows combining YData SDK with other packages such as Pandas, Numpy or Scikit-Learn.

YData SDK is available for the public through a token-based authentication system. If you don’t have one yet, you can get your license key by signing up at ydata.ai/register

Installing the package

YData SDK supports python versions newer than python 3.10, and can be installed in Windows, Linux or MacOS operating systems.

Prior to the package installation, it is recommended the creation of a Python virtual environment or conda environment:

pyenvconda

pyenv virtualenv 3.12 ydata
pyenv activate ydata

conda create -n ydata python=3.12
conda activate ydata

Environment Pre-requisites

Before installing ydata-sdk, certain dependencies must be installed beforehand.

This guide walks you through the step-by-step installation of psycopg2—a PostgreSQL adapter for Python required by YData's PostgreSQLConnector—and WeasyPrint, which is essential for generating PDF reports with SyntheticDataProfileReport. The instructions cover Ubuntu, macOS, and Windows to ensure a smooth setup across different operating systems.

Ubuntu

sudo apt update
    sudo apt install -y \
    libpq-dev python3-dev \
    libpango-1.0-0 libcairo2 libpangoft2-1.0-0 libpangocairo-1.0-0 libgdk-pixbuf2.0-0

MacOS

brew install postgresql pango cairo gdk-pixbuf

Windows

On Windows, WeasyPrint requires GTK+ and Pango, and psycopg2 needs Microsoft Build Tools.

• Microsoft Visual C++ Build Tools
  • Download from Microsoft Build Tools
• Install GTK+ for WeasyPrint
  • Download and install the GTK for windows
  • Add the bin/ folder to the system PATH to ensure it can be accessed.
• Install PostgreSQL for psycopg2
  • Download and install PostgreSQL for Windows

Installing ydata-sdk

You can easily install the ydata-sdk package using pip. The SDK is modular, so you can install only what you need — or everything at once for full functionality.

🛠️ Basic Installation

For core features such as tabular, time-series, and multi-table synthetic data generation:

pypi

pip install ydata-sdk

✍️ For Synthetic Text and Document Generation (LLMs)

To enable synthetic document creation and automatic generation of Q&A pairs from documents — ideal for working with LLMs and foundation models:

pypi

pip install "ydata-sdk[text]"

To work specifically with Microsoft Word document formats:

pypi

pip install "ydata-sdk[docx]"

✅ Full Installation (All Features)

To unlock all features, including text, documents, and tabular synthesis:

pypi

pip install "ydata-sdk[text,docx]"

Python environment

💡 Make sure your environment uses Python 3.10, 3.11, or 3.12 for full compatibility.