📊 Optimal Transport LiNGAM
otlingam is a Python package for causal discovery in linear non-Gaussian structural equation models. It learns causal orders by maximizing the Wasserstein non-Gaussianity of standardized regression residuals and estimates edge weights with adaptive lasso.
✨ Features
- Exhaustive causal-order learning:
ExhaustiveOTLiNGAMuses subset dynamic programming to find a globally optimal order. - Scalable greedy learning:
GreedyOTLiNGAMconstructs an order by sequentially selecting the most non-Gaussian residual. - Optimal transport ICA:
OTICALiNGAMusesOTICAwith FastICA initialization in the classical ICA-LiNGAM pipeline. - Exact empirical criterion: Computes one-dimensional Wasserstein scores directly from ordered residuals and Gaussian quantiles.
- LiNGAM integration: Exposes causal orders and weighted adjacency matrices through the established LiNGAM estimator API.
⚡ Method
The estimators assume the linear structural equation model
$$ X_j = \sum_{k \in \mathrm{Pa}(j)} B_{jk} X_k + \varepsilon_j, $$
where the graph is acyclic and the structural noises are mutually independent, centered, and have finite nonzero variances. Causal-order identification additionally requires at most one Gaussian structural noise.
For a candidate order $\sigma$, let $R_j(\sigma)$ be the population residual obtained by regressing $X_j$ on its predecessors under $\sigma$. The oracle Wasserstein order objective is
$$ G(\sigma) = \sum_{j = 1}^{d} \mathcal{W}_2(\mathrm{std}(R_j(\sigma)), \mathcal{N}(0, 1))^2. $$
Given $n$ observations, let $\widehat{R}_j^{(i)}(\sigma)$ be the ordinary least-squares residual for observation $i$. OTLiNGAM maximizes the empirical order objective
$$ \widehat{G}n(\sigma) = \sum{j = 1}^{d} \mathcal{W}2(\mathrm{std}(\frac{1}{n} \sum{i = 1}^{n} \delta_{\widehat{R}_j^{(i)}(\sigma)}), \mathcal{N}(0, 1))^2. $$
At the population level, the maximizers of $G$ are exactly the topological orders under the stated assumptions. A topological order exposes the independent structural noises as regression residuals, whereas an incorrect order may mix several noises and reduce the total objective. Each empirical one-dimensional Wasserstein distance is evaluated exactly by sorting the standardized residuals and comparing them with the Gaussian reference quantiles.
🚀 Installation
pip install otlingam
🔧 Usage
Example
The following example simulates a linear non-Gaussian structural equation model, learns a causal order with GreedyOTLiNGAM, and compares the true and estimated weighted adjacency matrices.
import matplotlib.pyplot as plt
import numpy as np
from otlingam import GreedyOTLiNGAM, disorder
rng = np.random.default_rng(42)
n_samples = 5_000
adjacency_matrix = np.array(
[
[0.0, 0.0, 0.0, 0.0, 0.0],
[0.8, 0.0, 0.0, 0.0, 0.0],
[0.0, -0.7, 0.0, 0.0, 0.0],
[0.5, 0.0, 0.9, 0.0, 0.0],
[0.0, -0.6, 0.0, 0.7, 0.0],
]
)
noise = rng.uniform(-1.0, 1.0, size=(n_samples, 5))
X = noise @ np.linalg.inv(np.eye(5) - adjacency_matrix).T
model = GreedyOTLiNGAM().fit(X)
print("Estimated causal order:", model.causal_order_)
print("Disorder:", disorder(model.causal_order_, adjacency_matrix))
fig, axes = plt.subplots(1, 2, figsize=(10, 4), layout="constrained")
matrices = (adjacency_matrix, model.adjacency_matrix_)
titles = ("True adjacency matrix", "Estimated adjacency matrix")
for ax, matrix, title in zip(axes, matrices, titles, strict=True):
image = ax.imshow(matrix, cmap="RdBu_r", vmin=-1.0, vmax=1.0)
ax.set_title(title)
ax.set_xlabel("Parent")
ax.set_ylabel("Child")
fig.colorbar(image, ax=axes, label="Edge weight")
plt.show()
ExhaustiveOTLiNGAM provides global order optimization at an exponential cost in the number of variables. GreedyOTLiNGAM provides a quadratic-time alternative. Set fit_intercept=False when the observations are already centered. The default fit_intercept=True centers the data and exposes the fitted intercepts through intercept_.
📖 Learn More
For configuration details and the API reference, visit otlingam's documentation.
Metadata
Release files for otlingam 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| otlingam-0.2.0.tar.gz | 85.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| otlingam-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 108.7 kB
Release files / otlingam-0.2.0.tar.gz
| Download URL | otlingam-0.2.0.tar.gz |
|---|---|
| Size | 85.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
552536f3252b5567f6bcbb9e87a1838b658983b45a2891bd607ee6961d34316a
|
|
BLAKE2b-256 checksum How to use checksums |
77047c53d7c01a5053017dde63ac833f632a7e8963287563c8c09bd1b4a31328
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.14
|
Release files / otlingam-0.2.0-py3-none-any.whl
| Download URL | otlingam-0.2.0-py3-none-any.whl |
|---|---|
| Size | 23.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c386411c1bd0f170b33d551adb5ac5cbb97370da1f5cd88c9b50a1bbc92fc115
|
|
BLAKE2b-256 checksum How to use checksums |
8536e6c50a9df83cded117762d9fe4a1247c68816e5d1aaf77d3c7bd2de16195
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.14
|