-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathdocumentation.html
More file actions
971 lines (699 loc) · 34.9 KB
/
documentation.html
File metadata and controls
971 lines (699 loc) · 34.9 KB
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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="Task-oriented pgmpy guides for causal discovery, parameter estimation, probabilistic inference, simulations, and model building." name="description" />
<meta property="og:title" content="User Guide" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://pgmpy.org/documentation.html" />
<meta property="og:site_name" content="pgmpy" />
<meta property="og:description" content="Use these guides when you want workflow-oriented documentation before diving into the API reference. Each page focuses on a concrete task and links to the relevant examples and public APIs. Core Wo..." />
<meta property="og:image" content="https://pgmpy.org/_static/images/logo.png" />
<meta property="og:image:alt" content="pgmpy" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:description" content="Task-oriented pgmpy guides for causal discovery, parameter estimation, probabilistic inference, simulations, and model building." />
<meta name="twitter:image" content="https://pgmpy.org/_static/images/logo.png" />
<meta name="robots" content="index,follow,max-image-preview:large" />
<link rel="canonical" href="https://pgmpy.org/documentation.html" />
<title>User Guide — pgmpy</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=7f76b32a3354e82990f2" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=7f76b32a3354e82990f2" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=18a852c8" />
<!-- So that users can add custom icons -->
<script defer src="_static/scripts/fontawesome.js?digest=7f76b32a3354e82990f2"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=7f76b32a3354e82990f2" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=7f76b32a3354e82990f2" />
<script src="_static/documentation_options.js?v=45183d27"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'documentation';</script>
<script>DOCUMENTATION_OPTIONS.search_as_you_type = false;</script>
<link rel="canonical" href="https://pgmpy.org/documentation.html" />
<link rel="icon" href="_static/logo_favi.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Causal Discovery and Structure Learning" href="guides/causal_discovery.html" />
<link rel="prev" title="License" href="started/license.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="stable" />
<script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script>
<script src="searchindex.js"></script>
<script type="application/ld+json">{"@context": "https://schema.org", "@id": "https://pgmpy.org/#organization", "@type": "Organization", "logo": "https://pgmpy.org/_static/images/logo.png", "name": "pgmpy", "sameAs": ["https://github.com/pgmpy/pgmpy", "https://pypi.org/project/pgmpy/", "https://www.linkedin.com/company/pgmpy/"], "url": "https://pgmpy.org"}</script>
<script type="application/ld+json">{"@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [{"@type": "ListItem", "item": "https://pgmpy.org/index.html", "name": "Key Features", "position": 1}, {"@type": "ListItem", "item": "https://pgmpy.org/documentation.html", "name": "User Guide", "position": 2}]}</script>
<!-- Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-HCFR07M31W"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-HCFR07M31W');
</script>
<!-- EthicalAds -->
<script async src="https://media.ethicalads.io/media/client/ethicalads.min.js"></script>
</head>
<body data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header id="pst-header" class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/logo.png" class="logo__image only-light" alt=""/>
<img src="_static/logo.png" class="logo__image only-dark pst-js-only" alt=""/>
<p class="title logo__title">pgmpy</p>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="started/index.html">
Getting Started
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="examples.html">
Examples
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="reference.html">
API Reference
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="citation.html">
Citation
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="development.html">
Getting Involved
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<div class="version-switcher__container pgmpy-version-switcher">
<select
class="form-select form-select-sm pgmpy-version-select"
aria-label="Select Version"
data-current-version="stable"
data-current-label="v1.1 (stable)"
data-target-uri="documentation.html"
>
<optgroup label="Releases">
<option value="stable" data-url="https://pgmpy.org/" selected>
v1.1 (stable)
</option>
<option value="v1.1" data-url="https://pgmpy.org/v1.1/" >
v1.1
</option>
</optgroup>
<optgroup label="In Development">
<option value="dev" data-url="https://pgmpy.org/dev/" >
dev
</option>
</optgroup>
</select>
</div>
<script>
(function() {
const selects = document.querySelectorAll(".pgmpy-version-select:not([data-pgmpy-version-init])");
selects.forEach(function(select) {
select.dataset.pgmpyVersionInit = "true";
const currentVersion = select.dataset.currentVersion;
const currentLabel = select.dataset.currentLabel || currentVersion;
const currentTargetUri = (select.dataset.targetUri || "").replace(/^\/+/, "");
if (!Array.from(select.options).some(function(option) { return option.value === currentVersion; })) {
const option = document.createElement("option");
option.value = currentVersion;
option.textContent = currentLabel;
option.selected = true;
select.insertBefore(option, select.firstChild);
}
const buildTargetUrl = function(baseUrl) {
if (!currentTargetUri || currentTargetUri === "index.html") {
return baseUrl;
}
return new URL(currentTargetUri, baseUrl).toString();
};
const navigateToVersion = async function(option) {
const baseUrl = option.dataset.url;
if (!baseUrl) {
return;
}
const targetUrl = buildTargetUrl(baseUrl);
if (targetUrl === baseUrl) {
window.location.href = baseUrl;
return;
}
try {
const response = await fetch(targetUrl, { method: "HEAD" });
window.location.href = response.ok ? targetUrl : baseUrl;
} catch (error) {
window.location.href = targetUrl;
}
};
select.addEventListener("change", function(event) {
const option = event.target.selectedOptions[0];
if (!option) {
return;
}
navigateToVersion(option);
});
});
})();
</script></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/pgmpy/pgmpy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://discord.gg/DRkdKaumBs" title="Discord" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discord fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discord</span></a>
</li>
<li class="nav-item">
<a href="https://www.linkedin.com/company/pgmpy/" title="LinkedIn" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-linkedin fa-lg" aria-hidden="true"></i>
<span class="sr-only">LinkedIn</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="started/index.html">
Getting Started
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="examples.html">
Examples
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="reference.html">
API Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="citation.html">
Citation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="development.html">
Getting Involved
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<div class="version-switcher__container pgmpy-version-switcher">
<select
class="form-select form-select-sm pgmpy-version-select"
aria-label="Select Version"
data-current-version="stable"
data-current-label="v1.1 (stable)"
data-target-uri="documentation.html"
>
<optgroup label="Releases">
<option value="stable" data-url="https://pgmpy.org/" selected>
v1.1 (stable)
</option>
<option value="v1.1" data-url="https://pgmpy.org/v1.1/" >
v1.1
</option>
</optgroup>
<optgroup label="In Development">
<option value="dev" data-url="https://pgmpy.org/dev/" >
dev
</option>
</optgroup>
</select>
</div>
<script>
(function() {
const selects = document.querySelectorAll(".pgmpy-version-select:not([data-pgmpy-version-init])");
selects.forEach(function(select) {
select.dataset.pgmpyVersionInit = "true";
const currentVersion = select.dataset.currentVersion;
const currentLabel = select.dataset.currentLabel || currentVersion;
const currentTargetUri = (select.dataset.targetUri || "").replace(/^\/+/, "");
if (!Array.from(select.options).some(function(option) { return option.value === currentVersion; })) {
const option = document.createElement("option");
option.value = currentVersion;
option.textContent = currentLabel;
option.selected = true;
select.insertBefore(option, select.firstChild);
}
const buildTargetUrl = function(baseUrl) {
if (!currentTargetUri || currentTargetUri === "index.html") {
return baseUrl;
}
return new URL(currentTargetUri, baseUrl).toString();
};
const navigateToVersion = async function(option) {
const baseUrl = option.dataset.url;
if (!baseUrl) {
return;
}
const targetUrl = buildTargetUrl(baseUrl);
if (targetUrl === baseUrl) {
window.location.href = baseUrl;
return;
}
try {
const response = await fetch(targetUrl, { method: "HEAD" });
window.location.href = response.ok ? targetUrl : baseUrl;
} catch (error) {
window.location.href = targetUrl;
}
};
select.addEventListener("change", function(event) {
const option = event.target.selectedOptions[0];
if (!option) {
return;
}
navigateToVersion(option);
});
});
})();
</script></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/pgmpy/pgmpy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://discord.gg/DRkdKaumBs" title="Discord" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discord fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discord</span></a>
</li>
<li class="nav-item">
<a href="https://www.linkedin.com/company/pgmpy/" title="LinkedIn" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-linkedin fa-lg" aria-hidden="true"></i>
<span class="sr-only">LinkedIn</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="guides/causal_discovery.html">Causal Discovery and Structure Learning</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/parameter_estimation.html">Parameter Estimation</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/probabilistic_inference.html">Probabilistic Inference</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/causal_identification.html">Causal Identification</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/causal_estimation.html">Causal Estimation</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/datasets.html">Example Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/example_models.html">Example Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/simulations.html">Simulations</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/io.html">Exporting / Importing Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/custom_model.html">Defining a Custom Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/plotting.html">Plotting Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="guides/extensibility.html">Extensibility</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div class="pgmpy-primary-sidebar-ad">
<div
id="ethical-ad-placement"
class="flat adaptive-css"
data-ea-publisher="pgmpyorg"
data-ea-type="image">
</div>
</div>
</div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">User Guide</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="user-guide">
<h1>User Guide<a class="headerlink" href="#user-guide" title="Link to this heading">#</a></h1>
<p>Use these guides when you want workflow-oriented documentation before diving into
the API reference. Each page focuses on a concrete task and links to the
relevant examples and public APIs.</p>
<section id="core-workflow">
<h2>Core Workflow<a class="headerlink" href="#core-workflow" title="Link to this heading">#</a></h2>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 pgmpy-card-grid docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-3 sd-g-3 sd-g-xs-3 sd-g-sm-3 sd-g-md-3 sd-g-lg-3 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Causal Discovery and Structure Learning</div>
<p class="sd-card-text">Learn causal graphs from data with constraint-based, score-based, and expert-guided algorithms.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/causal_discovery.html"><span class="doc">Causal Discovery and Structure Learning</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Parameter Estimation</div>
<p class="sd-card-text">Learn CPDs from data using MLE, Bayesian priors, or EM for missing data.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/parameter_estimation.html"><span class="doc">Parameter Estimation</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Probabilistic Inference</div>
<p class="sd-card-text">Compute posteriors, marginals, and MAP assignments with exact or approximate methods.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/probabilistic_inference.html"><span class="doc">Probabilistic Inference</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Simulations</div>
<p class="sd-card-text">Sample observational, interventional, and conditional data from fitted models.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/simulations.html"><span class="doc">Simulations</span></a></div>
</div>
</div>
</div>
</section>
<section id="causal-inference">
<h2>Causal Inference<a class="headerlink" href="#causal-inference" title="Link to this heading">#</a></h2>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 pgmpy-card-grid docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-3 sd-g-3 sd-g-xs-3 sd-g-sm-3 sd-g-md-3 sd-g-lg-3 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Causal Identification</div>
<p class="sd-card-text">Determine identifiability using backdoor adjustment and frontdoor criteria.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/causal_identification.html"><span class="doc">Causal Identification</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Causal Estimation</div>
<p class="sd-card-text">Estimate treatment effects and interventional distributions from causal graphs and data.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/causal_estimation.html"><span class="doc">Causal Estimation</span></a></div>
</div>
</div>
</div>
</section>
<section id="evaluation-data">
<h2>Evaluation & Data<a class="headerlink" href="#evaluation-data" title="Link to this heading">#</a></h2>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 pgmpy-card-grid docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-3 sd-g-3 sd-g-xs-3 sd-g-sm-3 sd-g-md-3 sd-g-lg-3 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Metrics</div>
<p class="sd-card-text">Evaluate learned graphs with supervised and unsupervised metrics.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/metrics.html"><span class="doc">Metrics</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Example Datasets</div>
<p class="sd-card-text">Curated benchmark datasets with ground-truth graphs and expert knowledge.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/datasets.html"><span class="doc">Example Datasets</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Example Models</div>
<p class="sd-card-text">Ready-made networks from bnlearn, bnrep, and dagitty for benchmarking and exploration.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/example_models.html"><span class="doc">Example Models</span></a></div>
</div>
</div>
</div>
</section>
<section id="utilities">
<h2>Utilities<a class="headerlink" href="#utilities" title="Link to this heading">#</a></h2>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 pgmpy-card-grid docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-3 sd-g-3 sd-g-xs-3 sd-g-sm-3 sd-g-md-3 sd-g-lg-3 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Exporting / Importing Models</div>
<p class="sd-card-text">Save and load models in BIF, NET, XMLBIF, XDSL, and other formats.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/io.html"><span class="doc">Exporting / Importing Models</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Defining a Custom Model</div>
<p class="sd-card-text">Define graphs and CPDs directly for discrete, continuous, or dynamic models.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/custom_model.html"><span class="doc">Defining a Custom Model</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Plotting Models</div>
<p class="sd-card-text">Visualize model structure with Graphviz, daft, and networkx backends.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/plotting.html"><span class="doc">Plotting Models</span></a></div>
</div>
</div>
</div>
</section>
<section id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Link to this heading">#</a></h2>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 pgmpy-card-grid docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-3 sd-g-3 sd-g-xs-3 sd-g-sm-3 sd-g-md-3 sd-g-lg-3 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Extensibility</div>
<p class="sd-card-text">Add new algorithms, datasets, and metrics using the built-in extension templates.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="guides/extensibility.html"><span class="doc">Extensibility</span></a></div>
</div>
</div>
</div>
<div class="toctree-wrapper compound">
</div>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="started/license.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">License</p>
</div>
</a>
<a class="right-next"
href="guides/causal_discovery.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Causal Discovery and Structure Learning</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav id="pst-page-toc-nav" class="page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="pst-show_toc_level nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#core-workflow">Core Workflow</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#causal-inference">Causal Inference</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#evaluation-data">Evaluation & Data</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#utilities">Utilities</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contributing">Contributing</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=7f76b32a3354e82990f2"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=7f76b32a3354e82990f2"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2025, pgmpy developers.
<br/>
</p>
</div>
</div>
</div>
</footer>
</body>
</html>