-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlanguage.html
More file actions
1741 lines (1583 loc) · 144 KB
/
language.html
File metadata and controls
1741 lines (1583 loc) · 144 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
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>tyche.language — Tyche v1.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="tyche.individuals" href="individuals.html" />
<link rel="prev" title="Tyche Documentation" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-tyche.language">
<span id="tyche-language"></span><h1>tyche.language<a class="headerlink" href="#module-tyche.language" title="Permalink to this heading">¶</a></h1>
<p>This module contains the classes for representing aleatoric description
logic (ADL) sentences, and the maths for their evaluation.</p>
<dl class="py exception">
<dt class="sig sig-object py" id="tyche.language.TycheLanguageException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tyche.language.</span></span><span class="sig-name descname"><span class="pre">TycheLanguageException</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#TycheLanguageException"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheLanguageException" title="Permalink to this definition">¶</a></dt>
<dd><p>An exception type that is thrown when errors occur in
the construction or use of the ADL language constructs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>message</strong> (<em>str</em>) – A description of the error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="tyche.language.RoleDist">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tyche.language.</span></span><span class="sig-name descname"><span class="pre">RoleDist</span></span><a class="reference internal" href="_modules/tyche/language.html#RoleDist"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.RoleDist" title="Permalink to this definition">¶</a></dt>
<dd><p>A probability distribution of related contexts.</p>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.RoleDist.is_empty">
<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#RoleDist.is_empty"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.RoleDist.is_empty" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether no individuals (including None) have been added to this role.
If None was explicitly added, then this will return False.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.RoleDist.clear">
<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#RoleDist.clear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.RoleDist.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes all individuals from this distribution.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.RoleDist.contains">
<span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">individual</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#RoleDist.contains"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.RoleDist.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether this role distribution contains the given individual.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>individual</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a><em>]</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.RoleDist.contexts">
<span class="sig-name descname"><span class="pre">contexts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#RoleDist.contexts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.RoleDist.contexts" title="Permalink to this definition">¶</a></dt>
<dd><p>Yields all the contexts within this role, including
the None-individual if it is present.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.RoleDist.calculate_expectation">
<span class="sig-name descname"><span class="pre">calculate_expectation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">given</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#RoleDist.calculate_expectation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.RoleDist.calculate_expectation" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates an expectation over this role. This evaluation contains an
implicit given that the role has at least one related individual. If the
role contains no non-null entries, then this will evaluate to vacuously True.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>given</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.RoleDist.reverse_expectation_learning_params">
<span class="sig-name descname"><span class="pre">reverse_expectation_learning_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">given</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">likelihood</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#RoleDist.reverse_expectation_learning_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.RoleDist.reverse_expectation_learning_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculates the influence and learning rate of each related individual in this role
for the truth of an expectation with the given parameters. The likelihood gives the
chance that the observation was true (i.e., a likelihood of 0 represents that the
observation of this expectation was false).</p>
<p>Returns a tuple of each related context that could have been selected, its likelihood,
and its influence.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>given</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>likelihood</strong> (<em>float</em>) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list[tuple[‘TycheContext’, float, float]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.RoleDist.calculate_exists">
<span class="sig-name descname"><span class="pre">calculate_exists</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#RoleDist.calculate_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.RoleDist.calculate_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates the likelihood that this role has at least one related individual.
The null individual is considered to represent “no relation”.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.RoleDist.to_str">
<span class="sig-name descname"><span class="pre">to_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#RoleDist.to_str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.RoleDist.to_str" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a text representation of the contents of this role distribution.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>detail_lvl</strong> (<em>int</em>) – </p></li>
<li><p><strong>indent_lvl</strong> (<em>int</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tyche.language.</span></span><span class="sig-name descname"><span class="pre">ExclusiveRoleDist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entries</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#tyche.language.RoleDist" title="tyche.language.RoleDist"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleDist</span></code></a></p>
<p>A probability distribution of contexts for a role, where either
zero or one related contexts are related when the role is observed.
The zero in this case refers to the possibility of selecting the
None-individual. However, exactly one individual is always selected
if you include the None-individual. The items in the probability
distribution use weights to represent their relative likelihood of
being selected.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>entries</strong> (<em>Union</em><em>[</em><em>None</em><em>, </em><em>list</em><em>[</em><em>Union</em><em>[</em><em>ForwardRef</em><em>(</em><em>'TycheContext'</em><em>)</em><em>, </em><em>Tuple</em><em>[</em><em>ForwardRef</em><em>(</em><em>'TycheContext'</em><em>)</em><em>, </em><em>float</em><em>]</em><em>]</em><em>]</em><em>, </em><em>dict</em><em>[</em><em>'TycheContext'</em><em>, </em><em>float</em><em>]</em><em>]</em>) – </p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.is_empty">
<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.is_empty"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.is_empty" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether no individuals (including None) have been added to this role.
If None was explicitly added, then this will return False.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.total_weight">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">total_weight</span></span><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.total_weight" title="Permalink to this definition">¶</a></dt>
<dd><p>The sum of the weights of all entries in this role distribution.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.clear">
<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.clear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes all individuals from this distribution.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.contains">
<span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">individual</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.contains"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether this role distribution contains the given individual.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>individual</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a><em>]</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">individual</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an individual to this distribution with the given weighting.
The weightings of individuals are relative to one another. If
an individual already exists in the distribution, then its
weighting will be _replaced_.</p>
<p>If no weight is supplied, then the default of 1 will be used.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>individual</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a><em>]</em>) – </p></li>
<li><p><strong>weight</strong> (<em>float</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.add_combining_weights">
<span class="sig-name descname"><span class="pre">add_combining_weights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">individual</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.add_combining_weights"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.add_combining_weights" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an individual to this distribution. If the individual already
exists in this role, then the given weight will be added to their
existing weight. Otherwise, the given weight will be used as the
weight of the individual.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>individual</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a><em>]</em>) – </p></li>
<li><p><strong>weight</strong> (<em>float</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">individual</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.remove"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes the given individual from this distribution.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>individual</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a><em>]</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.contexts">
<span class="sig-name descname"><span class="pre">contexts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.contexts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.contexts" title="Permalink to this definition">¶</a></dt>
<dd><p>Yields all the contexts within this role, including
the None-individual if it is present.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.apply_bayes_rule">
<span class="sig-name descname"><span class="pre">apply_bayes_rule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">observation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">likelihood</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">learning_rate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.apply_bayes_rule"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.apply_bayes_rule" title="Permalink to this definition">¶</a></dt>
<dd><p>Applies Bayes’ rule to update the probabilities of the individuals
mapped within this role based upon an uncertain observation. This
cannot learn anything about the None individual. Returns an updated
role distribution.</p>
<p>The likelihood works by applying bayes rule to the event that the observation occurred
or was incorrectly observed ((event with likelihood) OR (NOT event with 1 - likelihood)).
Therefore, a likelihood of 0 represents that the observation was observed to be false
(this is equivalent to observing NOT observation).
See: <a class="reference external" href="https://stats.stackexchange.com/questions/345200/applying-bayess-theorem-when-evidence-is-uncertain">https://stats.stackexchange.com/questions/345200/applying-bayess-theorem-when-evidence-is-uncertain</a></p>
<p>The learning_rate works by acting as a weight for the result of Bayes’ rule, and the
original weight. A learning_rate of 1 represents to just use the result of Bayes’ rule.
A learning_rate of 0 represents that the weight of each individual in the role should
remain unchanged.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>observation</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>likelihood</strong> (<em>float</em>) – </p></li>
<li><p><strong>learning_rate</strong> (<em>float</em>) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#tyche.language.ExclusiveRoleDist" title="tyche.language.ExclusiveRoleDist"><em>ExclusiveRoleDist</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.calculate_expectation">
<span class="sig-name descname"><span class="pre">calculate_expectation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">given</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.calculate_expectation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.calculate_expectation" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates an expectation over this role. This evaluation contains an
implicit given that the role has at least one related individual. If the
role contains no non-null entries, then this will evaluate to vacuously True.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>given</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.reverse_expectation_learning_params">
<span class="sig-name descname"><span class="pre">reverse_expectation_learning_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">given</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">likelihood</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.reverse_expectation_learning_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.reverse_expectation_learning_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculates the influence and learning rate of each related individual in this role
for the truth of an expectation with the given parameters. The likelihood gives the
chance that the observation was true (i.e., a likelihood of 0 represents that the
observation of this expectation was false).</p>
<p>Returns a tuple of each related context that could have been selected, its likelihood,
and its influence.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>given</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>likelihood</strong> (<em>float</em>) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list[tuple[‘TycheContext’, float, float]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.calculate_exists">
<span class="sig-name descname"><span class="pre">calculate_exists</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.calculate_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.calculate_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates the likelihood that this role has at least one related individual.
The null individual is considered to represent “no relation”.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.sample">
<span class="sig-name descname"><span class="pre">sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rng</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.sample" title="Permalink to this definition">¶</a></dt>
<dd><p>Selects a random individual from this role based upon their weights.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>rng</strong> (<em>Generator</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><em>Optional</em>[<a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ExclusiveRoleDist.to_str">
<span class="sig-name descname"><span class="pre">to_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ExclusiveRoleDist.to_str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ExclusiveRoleDist.to_str" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a text representation of the contents of this role distribution.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>detail_lvl</strong> (<em>int</em>) – </p></li>
<li><p><strong>indent_lvl</strong> (<em>int</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tyche.language.</span></span><span class="sig-name descname"><span class="pre">IndependentRoleDist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entries</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#tyche.language.RoleDist" title="tyche.language.RoleDist"><code class="xref py py-class docutils literal notranslate"><span class="pre">RoleDist</span></code></a></p>
<p>A probability distribution of contexts for a role, where each
relation to the contexts is independent. That is, zero, one,
or many contexts may be related when the role is observed.
Each relation has an independent probability of existing when
sampled. IndependentRoleDist cannot contain the None-individual.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>entries</strong> (<em>Union</em><em>[</em><em>None</em><em>, </em><em>list</em><em>[</em><em>Union</em><em>[</em><em>ForwardRef</em><em>(</em><em>'TycheContext'</em><em>)</em><em>, </em><em>Tuple</em><em>[</em><em>ForwardRef</em><em>(</em><em>'TycheContext'</em><em>)</em><em>, </em><em>float</em><em>]</em><em>]</em><em>]</em><em>, </em><em>dict</em><em>[</em><em>'TycheContext'</em><em>, </em><em>float</em><em>]</em><em>]</em>) – </p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.is_empty">
<span class="sig-name descname"><span class="pre">is_empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.is_empty"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.is_empty" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether no individuals (including None) have been added to this role.
If None was explicitly added, then this will return False.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.clear">
<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.clear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes all individuals from this distribution.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.contains">
<span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">individual</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.contains"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether this role distribution contains the given individual.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>individual</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a><em>]</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.add">
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">individual</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prob</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an individual to this distribution with the given probability.
The probability must fall within the range [0, 1].</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>individual</strong> (<a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a>) – </p></li>
<li><p><strong>prob</strong> (<em>float</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">individual</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.remove"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes the given individual from this distribution.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>individual</strong> (<a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.contexts">
<span class="sig-name descname"><span class="pre">contexts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.contexts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.contexts" title="Permalink to this definition">¶</a></dt>
<dd><p>Yields all the contexts within this role, including
the None-individual if it is present.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.calculate_expectation">
<span class="sig-name descname"><span class="pre">calculate_expectation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">given</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.calculate_expectation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.calculate_expectation" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates an expectation over this role. This evaluation contains an
implicit given that the role has at least one related individual. If the
role contains no non-null entries, then this will evaluate to vacuously True.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>given</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.reverse_expectation_learning_params">
<span class="sig-name descname"><span class="pre">reverse_expectation_learning_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">given</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">likelihood</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.reverse_expectation_learning_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.reverse_expectation_learning_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculates the influence and learning rate of each related individual in this role
for the truth of an expectation with the given parameters. The likelihood gives the
chance that the observation was true (i.e., a likelihood of 0 represents that the
observation of this expectation was false).</p>
<p>Returns a tuple of each related context that could have been selected, its likelihood,
and its influence.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>given</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>likelihood</strong> (<em>float</em>) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list[tuple[‘TycheContext’, float, float]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.calculate_exists">
<span class="sig-name descname"><span class="pre">calculate_exists</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.calculate_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.calculate_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates the likelihood that this role has at least one related individual.
The null individual is considered to represent “no relation”.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.sample">
<span class="sig-name descname"><span class="pre">sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rng</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.sample" title="Permalink to this definition">¶</a></dt>
<dd><p>Selects a random set of related individuals based upon their probabilities.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>rng</strong> (<em>Generator</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list[‘TycheContext’]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.IndependentRoleDist.to_str">
<span class="sig-name descname"><span class="pre">to_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#IndependentRoleDist.to_str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.IndependentRoleDist.to_str" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a text representation of the contents of this role distribution.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>detail_lvl</strong> (<em>int</em>) – </p></li>
<li><p><strong>indent_lvl</strong> (<em>int</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="tyche.language.TycheContext">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tyche.language.</span></span><span class="sig-name descname"><span class="pre">TycheContext</span></span><a class="reference internal" href="_modules/tyche/language.html#TycheContext"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Provides context for relating variables in formulas
(e.g. a, b, c, etc…) to their related objects.
Each individual may supply their own context for
their variables and roles.</p>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.TycheContext.eval">
<span class="sig-name descname"><span class="pre">eval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">concept</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#TycheContext.eval"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheContext.eval" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates the given concept to a probability of
it being true if sampled within this context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>concept</strong> (<em>CompatibleWithADLNode</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.TycheContext.eval_role">
<span class="sig-name descname"><span class="pre">eval_role</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#TycheContext.eval_role"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheContext.eval_role" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates the given role to a distribution of possible
other contexts if it were sampled within this context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>role</strong> (<em>CompatibleWithRole</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#tyche.language.RoleDist" title="tyche.language.RoleDist"><em>RoleDist</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.TycheContext.observe">
<span class="sig-name descname"><span class="pre">observe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">observation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">likelihood</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">learning_rate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#TycheContext.observe"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheContext.observe" title="Permalink to this definition">¶</a></dt>
<dd><p>Attempts to update the beliefs of this individual based upon
an observation of the given concept.</p>
<p>The optional likelihood parameter provides a degree of certainty
about the observation. By default, the observation is assumed to
be reliable.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>observation</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
<li><p><strong>likelihood</strong> (<em>float</em>) – </p></li>
<li><p><strong>learning_rate</strong> (<em>float</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.TycheContext.get_concept">
<span class="sig-name descname"><span class="pre">get_concept</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#TycheContext.get_concept"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheContext.get_concept" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the probability of the atom with the given symbol
being true, without modification by the context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>symbol</strong> (<em>str</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.TycheContext.get_role">
<span class="sig-name descname"><span class="pre">get_role</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#TycheContext.get_role"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheContext.get_role" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the role distribution of the role with the
given symbol, without modification by the context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>symbol</strong> (<em>str</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#tyche.language.RoleDist" title="tyche.language.RoleDist"><em>RoleDist</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.TycheContext.get_concept_reference">
<span class="sig-name descname"><span class="pre">get_concept_reference</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#TycheContext.get_concept_reference"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheContext.get_concept_reference" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a mutable reference to the probability of the atom with the given symbol
being true. This reference can be used to get and set the value of the atom.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>symbol</strong> (<em>str</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="references.html#tyche.references.BakedSymbolReference" title="tyche.references.BakedSymbolReference"><em>BakedSymbolReference</em></a>[float]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.TycheContext.get_role_reference">
<span class="sig-name descname"><span class="pre">get_role_reference</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#TycheContext.get_role_reference"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheContext.get_role_reference" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a mutable reference to the role distribution of the role with the
given symbol. This reference can be used to get and set the value of the role.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>symbol</strong> (<em>str</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="references.html#tyche.references.BakedSymbolReference" title="tyche.references.BakedSymbolReference"><em>BakedSymbolReference</em></a>[<a class="reference internal" href="#tyche.language.RoleDist" title="tyche.language.RoleDist"><em>RoleDist</em></a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.TycheContext.to_str">
<span class="sig-name descname"><span class="pre">to_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#TycheContext.to_str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.TycheContext.to_str" title="Permalink to this definition">¶</a></dt>
<dd><p>A version of str() that allows additional formatting options to be specified.
Allows specifying the number of levels of detail to include, and the
indentation to use while formatting.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>detail_lvl</strong> (<em>int</em>) – </p></li>
<li><p><strong>indent_lvl</strong> (<em>int</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="tyche.language.EmptyContext">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tyche.language.</span></span><span class="sig-name descname"><span class="pre">EmptyContext</span></span><a class="reference internal" href="_modules/tyche/language.html#EmptyContext"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.EmptyContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">TycheContext</span></code></a></p>
<p>Provides an empty context for evaluating constant expressions.</p>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.EmptyContext.eval">
<span class="sig-name descname"><span class="pre">eval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">concept</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#EmptyContext.eval"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.EmptyContext.eval" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates the given concept to a probability of
it being true if sampled within this context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>concept</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.EmptyContext.eval_role">
<span class="sig-name descname"><span class="pre">eval_role</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#EmptyContext.eval_role"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.EmptyContext.eval_role" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluates the given role to a distribution of possible
other contexts if it were sampled within this context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>role</strong> (<a class="reference internal" href="#tyche.language.Role" title="tyche.language.Role"><em>Role</em></a>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#tyche.language.RoleDist" title="tyche.language.RoleDist"><em>RoleDist</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.EmptyContext.get_concept">
<span class="sig-name descname"><span class="pre">get_concept</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#EmptyContext.get_concept"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.EmptyContext.get_concept" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the probability of the atom with the given symbol
being true, without modification by the context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>symbol</strong> (<em>str</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.EmptyContext.get_role">
<span class="sig-name descname"><span class="pre">get_role</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#EmptyContext.get_role"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.EmptyContext.get_role" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the role distribution of the role with the
given symbol, without modification by the context.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>symbol</strong> (<em>str</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#tyche.language.RoleDist" title="tyche.language.RoleDist"><em>RoleDist</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.EmptyContext.get_concept_reference">
<span class="sig-name descname"><span class="pre">get_concept_reference</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#EmptyContext.get_concept_reference"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.EmptyContext.get_concept_reference" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a mutable reference to the probability of the atom with the given symbol
being true. This reference can be used to get and set the value of the atom.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>symbol</strong> (<em>str</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.EmptyContext.get_role_reference">
<span class="sig-name descname"><span class="pre">get_role_reference</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#EmptyContext.get_role_reference"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.EmptyContext.get_role_reference" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a mutable reference to the role distribution of the role with the
given symbol. This reference can be used to get and set the value of the role.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>symbol</strong> (<em>str</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#tyche.language.RoleDist" title="tyche.language.RoleDist"><em>RoleDist</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.EmptyContext.to_str">
<span class="sig-name descname"><span class="pre">to_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent_lvl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#EmptyContext.to_str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.EmptyContext.to_str" title="Permalink to this definition">¶</a></dt>
<dd><p>A version of str() that allows additional formatting options to be specified.
Allows specifying the number of levels of detail to include, and the
indentation to use while formatting.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>detail_lvl</strong> (<em>int</em>) – </p></li>
<li><p><strong>indent_lvl</strong> (<em>int</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="tyche.language.ADLNode">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tyche.language.</span></span><span class="sig-name descname"><span class="pre">ADLNode</span></span><a class="reference internal" href="_modules/tyche/language.html#ADLNode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode" title="Permalink to this definition">¶</a></dt>
<dd><p>The base class of all nodes in aleatoric description logic formulas.</p>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.cast">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.cast"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.cast" title="Permalink to this definition">¶</a></dt>
<dd><p>This provides the canonicalization of several supported ADL representations
into ADLNode objects. For example, strings are automatically considered to
represent concepts, and as such they may be converted into concept nodes
automatically by this function.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>node</strong> (<em>CompatibleWithADLNode</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.get_child_nodes_in_eval_context">
<span class="sig-name descname"><span class="pre">get_child_nodes_in_eval_context</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.get_child_nodes_in_eval_context"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.get_child_nodes_in_eval_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an ordered list of the child nodes of this node that would be
evaluated in the same context as this node is evaluated. Nodes that
are evaluated in related contexts should not be returned here.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list[‘ADLNode’]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.copy_with_new_child_node_from_eval_context">
<span class="sig-name descname"><span class="pre">copy_with_new_child_node_from_eval_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.copy_with_new_child_node_from_eval_context"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.copy_with_new_child_node_from_eval_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a copy of this node with the child node at the given index in
the list returned by get_children_in_eval_context replaced with the given
node.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>index</strong> (<em>int</em>) – </p></li>
<li><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.direct_eval">
<span class="sig-name descname"><span class="pre">direct_eval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.direct_eval"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.direct_eval" title="Permalink to this definition">¶</a></dt>
<dd><p>Disclaimer:
This should _NOT_ be called to evaluate nodes using your model, as the
TycheContext objects should be given the control over the method of
evaluation. Therefore, TycheContext#eval should usually be used instead.</p>
<p>Evaluates the probability of this node evaluating to true when sampled
using the values of concepts and roles from the given context and related
contexts.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>context</strong> (<a class="reference internal" href="#tyche.language.TycheContext" title="tyche.language.TycheContext"><em>TycheContext</em></a>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>float</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.normal_form">
<span class="sig-name descname"><span class="pre">normal_form</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.normal_form"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.normal_form" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the tree normal form of the formula, where atoms are ordered alphabetically.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.is_equivalent">
<span class="sig-name descname"><span class="pre">is_equivalent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.is_equivalent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.is_equivalent" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if this node is provably equivalent to the given node.
Delegates to normal_form function. Two nodes have the same normal form
if and only if they have the same evaluation function</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.is_weaker">
<span class="sig-name descname"><span class="pre">is_weaker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.is_weaker"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.is_weaker" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if the probability of this node is provably necessarily
less than or equal to the probability of the given node.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.is_stronger">
<span class="sig-name descname"><span class="pre">is_stronger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.is_stronger"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.is_stronger" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if the probability of this node is provably necessarily
greater than or equal to the probability of the given node.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.when">
<span class="sig-name descname"><span class="pre">when</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">condition</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.when"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.when" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a formula that represents (condition ? self : Always).
This is equivalent to the formula self -> condition.
You can use a.when(b).otherwise(c) to represent (b ? a : c).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>condition</strong> (<em>CompatibleWithADLNode</em>) – </p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#tyche.language.ConditionalWithoutElse" title="tyche.language.ConditionalWithoutElse"><em>ConditionalWithoutElse</em></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.ADLNode.complement">
<span class="sig-name descname"><span class="pre">complement</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#ADLNode.complement"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.ADLNode.complement" title="Permalink to this definition">¶</a></dt>
<dd><p>Produces a new node that represents the complement (negation) of this node.
i.e., this performs a logical NOT operation to this node.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="tyche.language.Atom">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">tyche.language.</span></span><span class="sig-name descname"><span class="pre">Atom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">special_symbol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#Atom"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.Atom" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">ADLNode</span></code></a></p>
<p>Represents indivisible nodes such as concepts and constants such as always or never.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>symbol</strong> (<em>str</em>) – </p></li>
<li><p><strong>special_symbol</strong> (<em>bool</em>) – </p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.Atom.get_child_nodes_in_eval_context">
<span class="sig-name descname"><span class="pre">get_child_nodes_in_eval_context</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#Atom.get_child_nodes_in_eval_context"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.Atom.get_child_nodes_in_eval_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an ordered list of the child nodes of this node that would be
evaluated in the same context as this node is evaluated. Nodes that
are evaluated in related contexts should not be returned here.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list[<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode">tyche.language.ADLNode</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.Atom.copy_with_new_child_node_from_eval_context">
<span class="sig-name descname"><span class="pre">copy_with_new_child_node_from_eval_context</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#Atom.copy_with_new_child_node_from_eval_context"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.Atom.copy_with_new_child_node_from_eval_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a copy of this node with the child node at the given index in
the list returned by get_children_in_eval_context replaced with the given
node.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>index</strong> (<em>int</em>) – </p></li>
<li><p><strong>node</strong> (<a class="reference internal" href="#tyche.language.ADLNode" title="tyche.language.ADLNode"><em>ADLNode</em></a>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.Atom.check_symbol">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_symbol</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">symbol</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">symbol_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'symbol'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">symbol_type_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Atom'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#Atom.check_symbol"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.Atom.check_symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks a string contains only alphanumeric characters or underscore.
Raises an error if the symbol is an invalid atom symbol.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>symbol</strong> (<em>str</em>) – </p></li>
<li><p><strong>symbol_type_name</strong> (<em>str</em>) – </p></li>
<li><p><strong>context</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.Atom.normal_form">
<span class="sig-name descname"><span class="pre">normal_form</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#Atom.normal_form"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.Atom.normal_form" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the tree normal form of the formula, where atoms are ordered alphabetically.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="tyche.language.Atom.is_equivalent">
<span class="sig-name descname"><span class="pre">is_equivalent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tyche/language.html#Atom.is_equivalent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tyche.language.Atom.is_equivalent" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if this node is provably equivalent to the given node.