antecedent 0.3.0

Identification-first causal inference: identify → estimate → refute, with uncertainty about causal structure preserved
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
//! Graph interchange and durable artifacts.
//!
//! SPDX-License-Identifier: MIT OR Apache-2.0

use crate::error::CausalError;

/// Parse a DOT digraph into a [`antecedent_graph::Dag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed DOT or invalid DAG structure.
pub fn dag_from_dot(dot: &str) -> Result<antecedent_graph::Dag, CausalError> {
    antecedent_io::dag_from_dot(dot).map_err(CausalError::from)
}

/// Serialize a DAG to DOT.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn dag_to_dot(
    dag: &antecedent_graph::Dag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::dag_to_dot(dag, names).map_err(CausalError::from)
}

/// Parse a JSON DAG document into a [`antecedent_graph::Dag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed JSON or invalid DAG structure.
pub fn dag_from_json(json: &str) -> Result<antecedent_graph::Dag, CausalError> {
    antecedent_io::dag_from_json(json).map_err(CausalError::from)
}

/// Serialize a DAG to JSON.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn dag_to_json(
    dag: &antecedent_graph::Dag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::dag_to_json(dag, names).map_err(CausalError::from)
}

/// Parse a GML digraph into a [`antecedent_graph::Dag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed GML or invalid DAG structure.
pub fn dag_from_gml(gml: &str) -> Result<antecedent_graph::Dag, CausalError> {
    antecedent_io::dag_from_gml(gml).map_err(CausalError::from)
}

/// Serialize a DAG to GML.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn dag_to_gml(
    dag: &antecedent_graph::Dag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::dag_to_gml(dag, names).map_err(CausalError::from)
}

/// Parse `NetworkX` `node_link_data` JSON into a [`antecedent_graph::Dag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed JSON or invalid DAG structure.
pub fn dag_from_networkx_node_link(json: &str) -> Result<antecedent_graph::Dag, CausalError> {
    antecedent_io::dag_from_networkx_node_link(json).map_err(CausalError::from)
}

/// Serialize a DAG to `NetworkX` `node_link_data` JSON.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn dag_to_networkx_node_link(
    dag: &antecedent_graph::Dag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::dag_to_networkx_node_link(dag, names).map_err(CausalError::from)
}

/// Parse `NetworkX` `adjacency_data` JSON into a [`antecedent_graph::Dag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed JSON or invalid DAG structure.
pub fn dag_from_networkx_adjacency(json: &str) -> Result<antecedent_graph::Dag, CausalError> {
    antecedent_io::dag_from_networkx_adjacency(json).map_err(CausalError::from)
}

/// Serialize a DAG to `NetworkX` `adjacency_data` JSON.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn dag_to_networkx_adjacency(
    dag: &antecedent_graph::Dag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::dag_to_networkx_adjacency(dag, names).map_err(CausalError::from)
}

/// Parse DOT into a [`antecedent_graph::Pag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn pag_from_dot(dot: &str) -> Result<antecedent_graph::Pag, CausalError> {
    antecedent_io::pag_from_dot(dot).map_err(CausalError::from)
}
/// Serialize a PAG to DOT.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn pag_to_dot(
    pag: &antecedent_graph::Pag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::pag_to_dot(pag, names).map_err(CausalError::from)
}
/// Parse JSON into a [`antecedent_graph::Pag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn pag_from_json(json: &str) -> Result<antecedent_graph::Pag, CausalError> {
    antecedent_io::pag_from_json(json).map_err(CausalError::from)
}
/// Serialize a PAG to JSON.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn pag_to_json(
    pag: &antecedent_graph::Pag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::pag_to_json(pag, names).map_err(CausalError::from)
}
/// Parse GML into a [`antecedent_graph::Pag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn pag_from_gml(gml: &str) -> Result<antecedent_graph::Pag, CausalError> {
    antecedent_io::pag_from_gml(gml).map_err(CausalError::from)
}
/// Serialize a PAG to GML.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn pag_to_gml(
    pag: &antecedent_graph::Pag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::pag_to_gml(pag, names).map_err(CausalError::from)
}
/// Parse `NetworkX` node-link JSON into a [`antecedent_graph::Pag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn pag_from_networkx_node_link(json: &str) -> Result<antecedent_graph::Pag, CausalError> {
    antecedent_io::pag_from_networkx_node_link(json).map_err(CausalError::from)
}
/// Serialize a PAG to `NetworkX` node-link JSON.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn pag_to_networkx_node_link(
    pag: &antecedent_graph::Pag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::pag_to_networkx_node_link(pag, names).map_err(CausalError::from)
}

/// Parse DOT into a [`antecedent_graph::Cpdag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn cpdag_from_dot(dot: &str) -> Result<antecedent_graph::Cpdag, CausalError> {
    antecedent_io::cpdag_from_dot(dot).map_err(CausalError::from)
}
/// Serialize a CPDAG to DOT.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn cpdag_to_dot(
    cpdag: &antecedent_graph::Cpdag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::cpdag_to_dot(cpdag, names).map_err(CausalError::from)
}
/// Parse JSON into a [`antecedent_graph::Cpdag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn cpdag_from_json(json: &str) -> Result<antecedent_graph::Cpdag, CausalError> {
    antecedent_io::cpdag_from_json(json).map_err(CausalError::from)
}
/// Serialize a CPDAG to JSON.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn cpdag_to_json(
    cpdag: &antecedent_graph::Cpdag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::cpdag_to_json(cpdag, names).map_err(CausalError::from)
}
/// Parse GML into a [`antecedent_graph::Cpdag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn cpdag_from_gml(gml: &str) -> Result<antecedent_graph::Cpdag, CausalError> {
    antecedent_io::cpdag_from_gml(gml).map_err(CausalError::from)
}
/// Serialize a CPDAG to GML.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn cpdag_to_gml(
    cpdag: &antecedent_graph::Cpdag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::cpdag_to_gml(cpdag, names).map_err(CausalError::from)
}
/// Parse `NetworkX` node-link JSON into a [`antecedent_graph::Cpdag`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn cpdag_from_networkx_node_link(json: &str) -> Result<antecedent_graph::Cpdag, CausalError> {
    antecedent_io::cpdag_from_networkx_node_link(json).map_err(CausalError::from)
}
/// Serialize a CPDAG to `NetworkX` node-link JSON.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn cpdag_to_networkx_node_link(
    cpdag: &antecedent_graph::Cpdag,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::cpdag_to_networkx_node_link(cpdag, names).map_err(CausalError::from)
}

/// Parse DOT into a [`antecedent_graph::Admg`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn admg_from_dot(dot: &str) -> Result<antecedent_graph::Admg, CausalError> {
    antecedent_io::admg_from_dot(dot).map_err(CausalError::from)
}
/// Serialize an ADMG to DOT.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn admg_to_dot(
    admg: &antecedent_graph::Admg,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::admg_to_dot(admg, names).map_err(CausalError::from)
}
/// Parse JSON into a [`antecedent_graph::Admg`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn admg_from_json(json: &str) -> Result<antecedent_graph::Admg, CausalError> {
    antecedent_io::admg_from_json(json).map_err(CausalError::from)
}
/// Serialize an ADMG to JSON.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn admg_to_json(
    admg: &antecedent_graph::Admg,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::admg_to_json(admg, names).map_err(CausalError::from)
}
/// Parse GML into a [`antecedent_graph::Admg`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn admg_from_gml(gml: &str) -> Result<antecedent_graph::Admg, CausalError> {
    antecedent_io::admg_from_gml(gml).map_err(CausalError::from)
}
/// Serialize an ADMG to GML.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn admg_to_gml(
    admg: &antecedent_graph::Admg,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::admg_to_gml(admg, names).map_err(CausalError::from)
}
/// Parse `NetworkX` node-link JSON into a [`antecedent_graph::Admg`].
///
/// # Errors
///
/// [`CausalError::Serialization`] on malformed input.
pub fn admg_from_networkx_node_link(json: &str) -> Result<antecedent_graph::Admg, CausalError> {
    antecedent_io::admg_from_networkx_node_link(json).map_err(CausalError::from)
}
/// Serialize an ADMG to `NetworkX` node-link JSON.
///
/// # Errors
///
/// [`CausalError::Serialization`] on conversion failure.
pub fn admg_to_networkx_node_link(
    admg: &antecedent_graph::Admg,
    names: Option<&[String]>,
) -> Result<String, CausalError> {
    antecedent_io::admg_to_networkx_node_link(admg, names).map_err(CausalError::from)
}

/// Encode a model bundle to durable bytes.
///
/// # Errors
///
/// [`CausalError::Serialization`] on IO failures.
pub fn encode_model_bundle_bytes(
    input: &antecedent_io::ModelBundleEncode<'_>,
) -> Result<Vec<u8>, CausalError> {
    let art = antecedent_io::encode_model_bundle(input).map_err(CausalError::from)?;
    let mut buf = Vec::new();
    art.write_to(&mut buf).map_err(CausalError::from)?;
    Ok(buf)
}

/// Decode a model bundle from durable bytes (migrates format if needed).
///
/// # Errors
///
/// [`CausalError::Serialization`] on IO failures.
pub fn decode_model_bundle_bytes(bytes: &[u8]) -> Result<antecedent_io::ModelBundle, CausalError> {
    let art = antecedent_io::read_and_migrate(bytes).map_err(CausalError::from)?;
    antecedent_io::decode_model_bundle(&art).map_err(CausalError::from)
}

/// Encode a [`antecedent_estimate::CausalPosterior`] to durable bytes.
///
/// # Errors
///
/// [`CausalError::Serialization`] on IO failures.
pub fn encode_causal_posterior_bytes(
    posterior: &antecedent_estimate::CausalPosterior,
    artifact_id: &str,
) -> Result<Vec<u8>, CausalError> {
    antecedent_io::encode_causal_posterior_bytes(posterior, artifact_id).map_err(CausalError::from)
}

/// Encode a [`antecedent_estimate::CausalPosterior`] to a durable artifact.
///
/// # Errors
///
/// [`CausalError::Serialization`] on IO failures.
pub fn encode_causal_posterior(
    posterior: &antecedent_estimate::CausalPosterior,
    artifact_id: &str,
) -> Result<antecedent_io::EncodedArtifact, CausalError> {
    antecedent_io::encode_causal_posterior(posterior, artifact_id).map_err(CausalError::from)
}

/// Decode posterior wire metadata + draws.
///
/// # Errors
///
/// [`CausalError::Serialization`] on IO failures.
pub fn decode_causal_posterior_bytes(
    bytes: &[u8],
) -> Result<(antecedent_io::CausalPosteriorWire, Vec<f64>), CausalError> {
    antecedent_io::decode_causal_posterior_bytes(bytes).map_err(CausalError::from)
}

/// Hydrate a coefficient [`antecedent_prob::PriorSet`] from posterior artifact bytes.
///
/// Uses per-coefficient posterior means and SDs (identical-subspace mapping).
/// Effect columns are ignored. Prefer [`hydrate_prior_from_posterior_bytes`] when
/// a heterogeneous mapping is required.
///
/// # Errors
///
/// Decode failures or hydrate failures (no coefficients / non-finite summaries).
pub fn prior_set_from_posterior_bytes(
    bytes: &[u8],
) -> Result<antecedent_prob::PriorSet, CausalError> {
    use std::sync::Arc;

    use antecedent_estimate::hydrate_prior_from_quantity_summaries;
    use antecedent_io::PosteriorQuantityWire;
    use antecedent_prob::PosteriorQuantityKind;

    let (wire, _) = decode_causal_posterior_bytes(bytes)?;
    let quantities: Vec<PosteriorQuantityKind> = wire
        .quantities
        .iter()
        .map(|q| match q {
            PosteriorQuantityWire::Coefficient { index, name } => {
                PosteriorQuantityKind::Coefficient {
                    index: *index as usize,
                    name: name.as_ref().map(|s| Arc::<str>::from(s.as_str())),
                }
            }
            PosteriorQuantityWire::ResidualVariance => PosteriorQuantityKind::ResidualVariance,
            PosteriorQuantityWire::Effect { name } => {
                PosteriorQuantityKind::Effect { name: Arc::from(name.as_str()) }
            }
            PosteriorQuantityWire::Scalar { name } => {
                PosteriorQuantityKind::Scalar { name: Arc::from(name.as_str()) }
            }
        })
        .collect();
    hydrate_prior_from_quantity_summaries(&quantities, &wire.mean, &wire.sd, None)
        .map_err(CausalError::from)
}