Skip to content

Clarify installation requirements in quickstart.ipynb #194

Description

@ArijanaBohr

Hi! I was trying out the quickstart.ipynb notebook and ran into some installation friction with:

pip install "dpsynth[pipeline,examples] @ git+https://github.com/google/dpsynth.git"

In a Linux environment (Python 3.12), this pulled a very large dependency tree, including many Google Cloud packages, and appeared to stall while resolving/installing dependencies, so I stopped it after about an hour.

I also tried DPSynth on Google Colab (Python 3.13), where installation eventually failed while building pydantic-core; this also happened with the minimal installation, so it may be a separate compatibility issue.

I later noticed that detailed_example_theory_and_in_memory_api.ipynb uses the lighter [examples] installation. For the in-memory API, I tried the minimal installation:

pip install "dpsynth @ git+https://github.com/google/dpsynth.git"

This worked successfully in the same Linux environment, and I was able to generate synthetic data without any issues. :)

Since many users may only need the in-memory API to get started, perhaps the quickstart could begin with the minimal installation/example?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions