DeepLatent
DeepLatent is a unified latent variable modeling framework for analyzing large multimodal and multilingual datasets. It relies on variational inference using deep neural networks for estimation.
The package currently supports:
- Generic latent factor models
- Topic models: The latent variables are a mixture of topics within documents.
- Ideal point models: The latent variables are interpreted as ideological dimensions.
🌟 Key Features
-
Multilingual and multimodal support
- Learn topics / ideal points across multiple modalities (e.g., texts and images, texts and votes, etc.)
- Learn the weight of each modality in determining the latent variables per observation
-
Flexible metadata handling:
prevalence: covariates that influence the latent variablescontent: covariates that influence the response variables conditional on the latent variables (e.g., topic-word distributions)labels: outcomes for classification or regression tasksprediction: additional predictors for the labels
-
Flexible input/output representations:
- Document embeddings (for texts, images, audio-visual data)
- Word frequencies (BoW)
- Raw images
- Discrete choice data
- Voting records
📦 Models
GTM (Generalized Topic Model)
- Learns topics on the simplex
- Supports
dirichletorlogistic_normalpriors (optionally conditioned on covariates)
IdealPointNN
- Learns unconstrained latent variables (ℝ️ⁿ) for ideal point modeling
- Designed for political texts, images, audio and video recordings, surveys, and votes
- Uses a
gaussianprior (optionally conditioned on covariates)
Installation
From PyPI (Recommended)
pip install deeplatent
From Source
git clone https://github.com/PinchOfData/DeepLatent.git
cd deeplatent
pip install -e .
Development Installation
git clone https://github.com/PinchOfData/DeepLatent.git
cd deeplatent
python setup_dev.py
🚀 Getting Started
1. Prepare Your Data with Corpus()
Supports text, embeddings, votes, and survey questions:
import sys
sys.path.append('../src/')
from corpus import Corpus
modalities = {
"text": {
"column": "doc_clean",
"views": {
"bow": {
"type": "bow",
"vectorizer": CountVectorizer()
}
}
},
"image": {
"column": "image_path",
"views": {
"embedding": {
"type": "embedding",
"embed_fn": my_image_embedder
}
}
}
}
my_dataset = Corpus(df, modalities=modalities)
Optionally include metadata:
prevalence,content,labels,prediction
2. Train a Model
For Topic Models:
from models import GTM
model = GTM(
n_topics=20,
doc_topic_prior="logistic_normal",
ae_type="wae"
)
For Ideal Point Models:
from models import IdealPointNN
model = IdealPointNN(
n_ideal_points=1, # one-dimensional ideal point model
ae_type="vae"
)
🔧 Common Options
| Argument | Description |
|---|---|
ae_type |
"wae" (Wasserstein autoencoder) or "vae" (variational autoencoder) or "ae" (plain autoencoder) |
fusion |
"poe" (Product of Experts), "moe_gating" (Mixture of Experts), or "moe_average" (Simple averaging across modalities) |
update_prior |
Learn a structured prior conditioned on prevalence covariates |
w_prior |
Strength of prior alignment for wae |
w_pred_loss |
Weight of supervised loss predicting label |
kl_annealing_* |
Strength of prior alignment for vae. Helps preventing posterior collapse. |
🔍 Analysis and Utilities
📚 Topic Models (GTM)
get_topic_words()– top words per topicget_covariate_words()– word shifts bycontentcovariatesget_top_docs()– representative documentsget_topic_word_distribution()– topic-word matrixget_covariate_word_distribution()– word shift matrixplot_topic_word_distribution()– word clouds / bar plotsvisualize_docs()– document embeddings (UMAP, t-SNE, PCA)visualize_words()– word embeddingsvisualize_topics()– topic embeddings
👤 Ideal Point Models (IdealPointNN)
get_ideal_points()– ℝ️ⁿ latent spaceget_predictions()– supervised outputget_modality_weights()– fusion weights (PoE or gating)
📁 Tutorials
Check out the example notebooks to get started.
Download sample data to run some notebooks: Congressional Speeches CSV
📖 References
-
Deep Latent Variable Models for Unstructured Data , Germain Gauthier, Philine Widmer, Elliott Ash (2025)
-
The Neural Ideal Point Model , Germain Gauthier, Hugo Subtil, Philine Widmer (2025)
⚠️ Disclaimer
This package is under active development 🚧 — feedback and contributions welcome!
Metadata
Release files for deeplatent 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| deeplatent-0.1.3.tar.gz | 13.7 MB | Without provenance | Details for deeplatent-0.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| deeplatent-0.1.3-py3-none-any.whl | Python 3 | none | any | Details for deeplatent-0.1.3-py3-none-any.whl |
Total release size: 13.8 MB
Release files / deeplatent-0.1.3.tar.gz
| Download URL | deeplatent-0.1.3.tar.gz |
|---|---|
| Size | 13.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b66f3a5af24446f8f6fb5fd084579aec1b053389e624d439191a3df238ee8689
|
|
BLAKE2b-256 checksum How to use checksums |
321ab8d2674ec81bb48fde5ae0f37a55341e65417afca1f7730f8629c4dfb040
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Release files / deeplatent-0.1.3-py3-none-any.whl
| Download URL | deeplatent-0.1.3-py3-none-any.whl |
|---|---|
| Size | 62.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9eae683b28e30a3cd813a5c6e3caf1cf2e7604e4f3c57dc9583d305cbc2cad8c
|
|
BLAKE2b-256 checksum How to use checksums |
0670e8d08892854561f4d34491102fc61f4770f4f4b352d83546d2f4ac434c33
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Security for deeplatent 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.