Spaces:
Paused
Paused
File size: 46,970 Bytes
f6686e1 | 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 1001 1002 1003 1004 | <!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>tinytroupe.steering.intervention API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>tinytroupe.steering.intervention</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">from typing import Union, List
from tinytroupe.extraction import logger
from tinytroupe.utils import JsonSerializableRegistry
from tinytroupe.experimentation import Proposition
from tinytroupe.environment import TinyWorld
from tinytroupe.agent import TinyPerson
import tinytroupe.utils as utils
DEFAULT_FIRST_N = 10
DEFAULT_LAST_N = 100
class InterventionBatch:
"""
A wrapper around multiple Intervention instances that allows chaining set_* methods.
"""
def __init__(self, interventions):
self.interventions = interventions
def __iter__(self):
"""Makes the batch iterable and compatible with list()"""
return iter(self.interventions)
def set_textual_precondition(self, text):
for intervention in self.interventions:
intervention.set_textual_precondition(text)
return self
def set_functional_precondition(self, func):
for intervention in self.interventions:
intervention.set_functional_precondition(func)
return self
def set_effect(self, effect_func):
for intervention in self.interventions:
intervention.set_effect(effect_func)
return self
def set_propositional_precondition(self, proposition, threshold=None):
for intervention in self.interventions:
intervention.set_propositional_precondition(proposition, threshold)
return self
def as_list(self):
"""Return the list of individual interventions."""
return self.interventions
class Intervention:
def __init__(self, targets: Union[TinyPerson, TinyWorld, List[TinyPerson], List[TinyWorld]],
first_n:int=DEFAULT_FIRST_N, last_n:int=DEFAULT_LAST_N,
name: str = None):
"""
Initialize the intervention.
Args:
target (Union[TinyPerson, TinyWorld, List[TinyPerson], List[TinyWorld]]): the target to intervene on
first_n (int): the number of first interactions to consider in the context
last_n (int): the number of last interactions (most recent) to consider in the context
name (str): the name of the intervention
"""
self.targets = targets
# initialize the possible preconditions
self.text_precondition = None
self.precondition_func = None
# effects
self.effect_func = None
# which events to pay attention to?
self.first_n = first_n
self.last_n = last_n
# name
if name is None:
self.name = self.name = f"Intervention {utils.fresh_id(self.__class__.__name__)}"
else:
self.name = name
# the most recent precondition proposition used to check the precondition
self._last_text_precondition_proposition = None
self._last_functional_precondition_check = None
# propositional precondition (optional)
self.propositional_precondition = None
self.propositional_precondition_threshold = None
self._last_propositional_precondition_check = None
################################################################################################
# Intervention flow
################################################################################################
@classmethod
def create_for_each(cls, targets, first_n=DEFAULT_FIRST_N, last_n=DEFAULT_LAST_N, name=None):
"""
Create separate interventions for each target in the list.
Args:
targets (list): List of targets (TinyPerson or TinyWorld instances)
first_n (int): the number of first interactions to consider in the context
last_n (int): the number of last interactions (most recent) to consider in the context
name (str): the name of the intervention
Returns:
InterventionBatch: A wrapper that allows chaining set_* methods that will apply to all interventions
"""
if not isinstance(targets, list):
targets = [targets]
interventions = [cls(target, first_n=first_n, last_n=last_n,
name=f"{name}_{i}" if name else None)
for i, target in enumerate(targets)]
return InterventionBatch(interventions)
def __call__(self):
"""
Execute the intervention.
Returns:
bool: whether the intervention effect was applied.
"""
return self.execute()
def execute(self):
"""
Execute the intervention. It first checks the precondition, and if it is met, applies the effect.
This is the simplest method to run the intervention.
Returns:
bool: whether the intervention effect was applied.
"""
logger.debug(f"Executing intervention: {self}")
if self.check_precondition():
self.apply_effect()
logger.debug(f"Precondition was true, intervention effect was applied.")
return True
logger.debug(f"Precondition was false, intervention effect was not applied.")
return False
def check_precondition(self):
"""
Check if the precondition for the intervention is met.
"""
#
# Textual precondition
#
if self.text_precondition is not None:
self._last_text_precondition_proposition = Proposition(claim=self.text_precondition, target=self.targets, first_n=self.first_n, last_n=self.last_n)
llm_precondition_check = self._last_text_precondition_proposition.check()
else:
llm_precondition_check = True
#
# Functional precondition
#
if self.precondition_func is not None:
self._last_functional_precondition_check = self.precondition_func(self.targets)
else:
self._last_functional_precondition_check = True # default to True if no functional precondition is set
#
# Propositional precondition
#
self._last_propositional_precondition_check = True
if self.propositional_precondition is not None:
if self.propositional_precondition_threshold is not None:
score = self.propositional_precondition.score(target=self.targets)
if score >= self.propositional_precondition_threshold:
self._last_propositional_precondition_check = False
else:
if not self.propositional_precondition.check(target=self.targets):
self._last_propositional_precondition_check = False
return llm_precondition_check and self._last_functional_precondition_check and self._last_propositional_precondition_check
def apply_effect(self):
"""
Apply the intervention's effects. This won't check the precondition,
so it should be called after check_precondition.
"""
self.effect_func(self.targets)
################################################################################################
# Pre and post conditions
################################################################################################
def set_textual_precondition(self, text):
"""
Set a precondition as text, to be interpreted by a language model.
Args:
text (str): the text of the precondition
"""
self.text_precondition = text
return self # for chaining
def set_functional_precondition(self, func):
"""
Set a precondition as a function, to be evaluated by the code.
Args:
func (function): the function of the precondition.
Must have the a single argument, targets (either a TinyWorld or TinyPerson, or a list). Must return a boolean.
"""
self.precondition_func = func
return self # for chaining
def set_effect(self, effect_func):
"""
Set the effect of the intervention.
Args:
effect (str): the effect function of the intervention
"""
self.effect_func = effect_func
return self # for chaining
def set_propositional_precondition(self, proposition:Proposition, threshold:int=None):
"""
Set a propositional precondition using the Proposition class,
optionally with a score threshold.
"""
self.propositional_precondition = proposition
self.propositional_precondition_threshold = threshold
return self
################################################################################################
# Inspection
################################################################################################
def precondition_justification(self):
"""
Get the justification for the precondition.
"""
justification = ""
# text precondition justification
if self._last_text_precondition_proposition is not None:
justification += f"{self._last_text_precondition_proposition.justification} (confidence = {self._last_text_precondition_proposition.confidence})\n\n"
# functional precondition justification
if self.precondition_func is not None:
if self._last_functional_precondition_check == True:
justification += f"Functional precondition was met.\n\n"
else:
justification += "Preconditions do not appear to be met.\n\n"
# propositional precondition justification
if self.propositional_precondition is not None:
if self._last_propositional_precondition_check == True:
justification += f"Propositional precondition was met.\n\n"
else:
justification += "Propositional precondition was not met.\n\n"
return justification
return justification</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="tinytroupe.steering.intervention.Intervention"><code class="flex name class">
<span>class <span class="ident">Intervention</span></span>
<span>(</span><span>targets: Union[<a title="tinytroupe.agent.tiny_person.TinyPerson" href="../agent/tiny_person.html#tinytroupe.agent.tiny_person.TinyPerson">TinyPerson</a>, <a title="tinytroupe.environment.tiny_world.TinyWorld" href="../environment/tiny_world.html#tinytroupe.environment.tiny_world.TinyWorld">TinyWorld</a>, List[<a title="tinytroupe.agent.tiny_person.TinyPerson" href="../agent/tiny_person.html#tinytroupe.agent.tiny_person.TinyPerson">TinyPerson</a>], List[<a title="tinytroupe.environment.tiny_world.TinyWorld" href="../environment/tiny_world.html#tinytroupe.environment.tiny_world.TinyWorld">TinyWorld</a>]], first_n: int = 10, last_n: int = 100, name: str = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Initialize the intervention.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>target</code></strong> : <code>Union[TinyPerson, TinyWorld, List[TinyPerson], List[TinyWorld]]</code></dt>
<dd>the target to intervene on</dd>
<dt><strong><code>first_n</code></strong> : <code>int</code></dt>
<dd>the number of first interactions to consider in the context</dd>
<dt><strong><code>last_n</code></strong> : <code>int</code></dt>
<dd>the number of last interactions (most recent) to consider in the context</dd>
<dt><strong><code>name</code></strong> : <code>str</code></dt>
<dd>the name of the intervention</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Intervention:
def __init__(self, targets: Union[TinyPerson, TinyWorld, List[TinyPerson], List[TinyWorld]],
first_n:int=DEFAULT_FIRST_N, last_n:int=DEFAULT_LAST_N,
name: str = None):
"""
Initialize the intervention.
Args:
target (Union[TinyPerson, TinyWorld, List[TinyPerson], List[TinyWorld]]): the target to intervene on
first_n (int): the number of first interactions to consider in the context
last_n (int): the number of last interactions (most recent) to consider in the context
name (str): the name of the intervention
"""
self.targets = targets
# initialize the possible preconditions
self.text_precondition = None
self.precondition_func = None
# effects
self.effect_func = None
# which events to pay attention to?
self.first_n = first_n
self.last_n = last_n
# name
if name is None:
self.name = self.name = f"Intervention {utils.fresh_id(self.__class__.__name__)}"
else:
self.name = name
# the most recent precondition proposition used to check the precondition
self._last_text_precondition_proposition = None
self._last_functional_precondition_check = None
# propositional precondition (optional)
self.propositional_precondition = None
self.propositional_precondition_threshold = None
self._last_propositional_precondition_check = None
################################################################################################
# Intervention flow
################################################################################################
@classmethod
def create_for_each(cls, targets, first_n=DEFAULT_FIRST_N, last_n=DEFAULT_LAST_N, name=None):
"""
Create separate interventions for each target in the list.
Args:
targets (list): List of targets (TinyPerson or TinyWorld instances)
first_n (int): the number of first interactions to consider in the context
last_n (int): the number of last interactions (most recent) to consider in the context
name (str): the name of the intervention
Returns:
InterventionBatch: A wrapper that allows chaining set_* methods that will apply to all interventions
"""
if not isinstance(targets, list):
targets = [targets]
interventions = [cls(target, first_n=first_n, last_n=last_n,
name=f"{name}_{i}" if name else None)
for i, target in enumerate(targets)]
return InterventionBatch(interventions)
def __call__(self):
"""
Execute the intervention.
Returns:
bool: whether the intervention effect was applied.
"""
return self.execute()
def execute(self):
"""
Execute the intervention. It first checks the precondition, and if it is met, applies the effect.
This is the simplest method to run the intervention.
Returns:
bool: whether the intervention effect was applied.
"""
logger.debug(f"Executing intervention: {self}")
if self.check_precondition():
self.apply_effect()
logger.debug(f"Precondition was true, intervention effect was applied.")
return True
logger.debug(f"Precondition was false, intervention effect was not applied.")
return False
def check_precondition(self):
"""
Check if the precondition for the intervention is met.
"""
#
# Textual precondition
#
if self.text_precondition is not None:
self._last_text_precondition_proposition = Proposition(claim=self.text_precondition, target=self.targets, first_n=self.first_n, last_n=self.last_n)
llm_precondition_check = self._last_text_precondition_proposition.check()
else:
llm_precondition_check = True
#
# Functional precondition
#
if self.precondition_func is not None:
self._last_functional_precondition_check = self.precondition_func(self.targets)
else:
self._last_functional_precondition_check = True # default to True if no functional precondition is set
#
# Propositional precondition
#
self._last_propositional_precondition_check = True
if self.propositional_precondition is not None:
if self.propositional_precondition_threshold is not None:
score = self.propositional_precondition.score(target=self.targets)
if score >= self.propositional_precondition_threshold:
self._last_propositional_precondition_check = False
else:
if not self.propositional_precondition.check(target=self.targets):
self._last_propositional_precondition_check = False
return llm_precondition_check and self._last_functional_precondition_check and self._last_propositional_precondition_check
def apply_effect(self):
"""
Apply the intervention's effects. This won't check the precondition,
so it should be called after check_precondition.
"""
self.effect_func(self.targets)
################################################################################################
# Pre and post conditions
################################################################################################
def set_textual_precondition(self, text):
"""
Set a precondition as text, to be interpreted by a language model.
Args:
text (str): the text of the precondition
"""
self.text_precondition = text
return self # for chaining
def set_functional_precondition(self, func):
"""
Set a precondition as a function, to be evaluated by the code.
Args:
func (function): the function of the precondition.
Must have the a single argument, targets (either a TinyWorld or TinyPerson, or a list). Must return a boolean.
"""
self.precondition_func = func
return self # for chaining
def set_effect(self, effect_func):
"""
Set the effect of the intervention.
Args:
effect (str): the effect function of the intervention
"""
self.effect_func = effect_func
return self # for chaining
def set_propositional_precondition(self, proposition:Proposition, threshold:int=None):
"""
Set a propositional precondition using the Proposition class,
optionally with a score threshold.
"""
self.propositional_precondition = proposition
self.propositional_precondition_threshold = threshold
return self
################################################################################################
# Inspection
################################################################################################
def precondition_justification(self):
"""
Get the justification for the precondition.
"""
justification = ""
# text precondition justification
if self._last_text_precondition_proposition is not None:
justification += f"{self._last_text_precondition_proposition.justification} (confidence = {self._last_text_precondition_proposition.confidence})\n\n"
# functional precondition justification
if self.precondition_func is not None:
if self._last_functional_precondition_check == True:
justification += f"Functional precondition was met.\n\n"
else:
justification += "Preconditions do not appear to be met.\n\n"
# propositional precondition justification
if self.propositional_precondition is not None:
if self._last_propositional_precondition_check == True:
justification += f"Propositional precondition was met.\n\n"
else:
justification += "Propositional precondition was not met.\n\n"
return justification
return justification</code></pre>
</details>
<h3>Static methods</h3>
<dl>
<dt id="tinytroupe.steering.intervention.Intervention.create_for_each"><code class="name flex">
<span>def <span class="ident">create_for_each</span></span>(<span>targets, first_n=10, last_n=100, name=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Create separate interventions for each target in the list.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>targets</code></strong> : <code>list</code></dt>
<dd>List of targets (TinyPerson or TinyWorld instances)</dd>
<dt><strong><code>first_n</code></strong> : <code>int</code></dt>
<dd>the number of first interactions to consider in the context</dd>
<dt><strong><code>last_n</code></strong> : <code>int</code></dt>
<dd>the number of last interactions (most recent) to consider in the context</dd>
<dt><strong><code>name</code></strong> : <code>str</code></dt>
<dd>the name of the intervention</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code><a title="tinytroupe.steering.intervention.InterventionBatch" href="#tinytroupe.steering.intervention.InterventionBatch">InterventionBatch</a></code></dt>
<dd>A wrapper that allows chaining set_* methods that will apply to all interventions</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@classmethod
def create_for_each(cls, targets, first_n=DEFAULT_FIRST_N, last_n=DEFAULT_LAST_N, name=None):
"""
Create separate interventions for each target in the list.
Args:
targets (list): List of targets (TinyPerson or TinyWorld instances)
first_n (int): the number of first interactions to consider in the context
last_n (int): the number of last interactions (most recent) to consider in the context
name (str): the name of the intervention
Returns:
InterventionBatch: A wrapper that allows chaining set_* methods that will apply to all interventions
"""
if not isinstance(targets, list):
targets = [targets]
interventions = [cls(target, first_n=first_n, last_n=last_n,
name=f"{name}_{i}" if name else None)
for i, target in enumerate(targets)]
return InterventionBatch(interventions)</code></pre>
</details>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="tinytroupe.steering.intervention.Intervention.apply_effect"><code class="name flex">
<span>def <span class="ident">apply_effect</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Apply the intervention's effects. This won't check the precondition,
so it should be called after check_precondition.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def apply_effect(self):
"""
Apply the intervention's effects. This won't check the precondition,
so it should be called after check_precondition.
"""
self.effect_func(self.targets)</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.Intervention.check_precondition"><code class="name flex">
<span>def <span class="ident">check_precondition</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Check if the precondition for the intervention is met.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def check_precondition(self):
"""
Check if the precondition for the intervention is met.
"""
#
# Textual precondition
#
if self.text_precondition is not None:
self._last_text_precondition_proposition = Proposition(claim=self.text_precondition, target=self.targets, first_n=self.first_n, last_n=self.last_n)
llm_precondition_check = self._last_text_precondition_proposition.check()
else:
llm_precondition_check = True
#
# Functional precondition
#
if self.precondition_func is not None:
self._last_functional_precondition_check = self.precondition_func(self.targets)
else:
self._last_functional_precondition_check = True # default to True if no functional precondition is set
#
# Propositional precondition
#
self._last_propositional_precondition_check = True
if self.propositional_precondition is not None:
if self.propositional_precondition_threshold is not None:
score = self.propositional_precondition.score(target=self.targets)
if score >= self.propositional_precondition_threshold:
self._last_propositional_precondition_check = False
else:
if not self.propositional_precondition.check(target=self.targets):
self._last_propositional_precondition_check = False
return llm_precondition_check and self._last_functional_precondition_check and self._last_propositional_precondition_check</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.Intervention.execute"><code class="name flex">
<span>def <span class="ident">execute</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Execute the intervention. It first checks the precondition, and if it is met, applies the effect.
This is the simplest method to run the intervention.</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>bool</code></dt>
<dd>whether the intervention effect was applied.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def execute(self):
"""
Execute the intervention. It first checks the precondition, and if it is met, applies the effect.
This is the simplest method to run the intervention.
Returns:
bool: whether the intervention effect was applied.
"""
logger.debug(f"Executing intervention: {self}")
if self.check_precondition():
self.apply_effect()
logger.debug(f"Precondition was true, intervention effect was applied.")
return True
logger.debug(f"Precondition was false, intervention effect was not applied.")
return False</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.Intervention.precondition_justification"><code class="name flex">
<span>def <span class="ident">precondition_justification</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Get the justification for the precondition.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def precondition_justification(self):
"""
Get the justification for the precondition.
"""
justification = ""
# text precondition justification
if self._last_text_precondition_proposition is not None:
justification += f"{self._last_text_precondition_proposition.justification} (confidence = {self._last_text_precondition_proposition.confidence})\n\n"
# functional precondition justification
if self.precondition_func is not None:
if self._last_functional_precondition_check == True:
justification += f"Functional precondition was met.\n\n"
else:
justification += "Preconditions do not appear to be met.\n\n"
# propositional precondition justification
if self.propositional_precondition is not None:
if self._last_propositional_precondition_check == True:
justification += f"Propositional precondition was met.\n\n"
else:
justification += "Propositional precondition was not met.\n\n"
return justification
return justification</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.Intervention.set_effect"><code class="name flex">
<span>def <span class="ident">set_effect</span></span>(<span>self, effect_func)</span>
</code></dt>
<dd>
<div class="desc"><p>Set the effect of the intervention.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>effect</code></strong> : <code>str</code></dt>
<dd>the effect function of the intervention</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_effect(self, effect_func):
"""
Set the effect of the intervention.
Args:
effect (str): the effect function of the intervention
"""
self.effect_func = effect_func
return self # for chaining</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.Intervention.set_functional_precondition"><code class="name flex">
<span>def <span class="ident">set_functional_precondition</span></span>(<span>self, func)</span>
</code></dt>
<dd>
<div class="desc"><p>Set a precondition as a function, to be evaluated by the code.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>func</code></strong> : <code>function</code></dt>
<dd>the function of the precondition.
Must have the a single argument, targets (either a TinyWorld or TinyPerson, or a list). Must return a boolean.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_functional_precondition(self, func):
"""
Set a precondition as a function, to be evaluated by the code.
Args:
func (function): the function of the precondition.
Must have the a single argument, targets (either a TinyWorld or TinyPerson, or a list). Must return a boolean.
"""
self.precondition_func = func
return self # for chaining</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.Intervention.set_propositional_precondition"><code class="name flex">
<span>def <span class="ident">set_propositional_precondition</span></span>(<span>self, proposition: <a title="tinytroupe.experimentation.proposition.Proposition" href="../experimentation/proposition.html#tinytroupe.experimentation.proposition.Proposition">Proposition</a>, threshold: int = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Set a propositional precondition using the Proposition class,
optionally with a score threshold.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_propositional_precondition(self, proposition:Proposition, threshold:int=None):
"""
Set a propositional precondition using the Proposition class,
optionally with a score threshold.
"""
self.propositional_precondition = proposition
self.propositional_precondition_threshold = threshold
return self</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.Intervention.set_textual_precondition"><code class="name flex">
<span>def <span class="ident">set_textual_precondition</span></span>(<span>self, text)</span>
</code></dt>
<dd>
<div class="desc"><p>Set a precondition as text, to be interpreted by a language model.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>text</code></strong> : <code>str</code></dt>
<dd>the text of the precondition</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_textual_precondition(self, text):
"""
Set a precondition as text, to be interpreted by a language model.
Args:
text (str): the text of the precondition
"""
self.text_precondition = text
return self # for chaining</code></pre>
</details>
</dd>
</dl>
</dd>
<dt id="tinytroupe.steering.intervention.InterventionBatch"><code class="flex name class">
<span>class <span class="ident">InterventionBatch</span></span>
<span>(</span><span>interventions)</span>
</code></dt>
<dd>
<div class="desc"><p>A wrapper around multiple Intervention instances that allows chaining set_* methods.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class InterventionBatch:
"""
A wrapper around multiple Intervention instances that allows chaining set_* methods.
"""
def __init__(self, interventions):
self.interventions = interventions
def __iter__(self):
"""Makes the batch iterable and compatible with list()"""
return iter(self.interventions)
def set_textual_precondition(self, text):
for intervention in self.interventions:
intervention.set_textual_precondition(text)
return self
def set_functional_precondition(self, func):
for intervention in self.interventions:
intervention.set_functional_precondition(func)
return self
def set_effect(self, effect_func):
for intervention in self.interventions:
intervention.set_effect(effect_func)
return self
def set_propositional_precondition(self, proposition, threshold=None):
for intervention in self.interventions:
intervention.set_propositional_precondition(proposition, threshold)
return self
def as_list(self):
"""Return the list of individual interventions."""
return self.interventions</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="tinytroupe.steering.intervention.InterventionBatch.as_list"><code class="name flex">
<span>def <span class="ident">as_list</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Return the list of individual interventions.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def as_list(self):
"""Return the list of individual interventions."""
return self.interventions</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.InterventionBatch.set_effect"><code class="name flex">
<span>def <span class="ident">set_effect</span></span>(<span>self, effect_func)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_effect(self, effect_func):
for intervention in self.interventions:
intervention.set_effect(effect_func)
return self</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.InterventionBatch.set_functional_precondition"><code class="name flex">
<span>def <span class="ident">set_functional_precondition</span></span>(<span>self, func)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_functional_precondition(self, func):
for intervention in self.interventions:
intervention.set_functional_precondition(func)
return self</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.InterventionBatch.set_propositional_precondition"><code class="name flex">
<span>def <span class="ident">set_propositional_precondition</span></span>(<span>self, proposition, threshold=None)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_propositional_precondition(self, proposition, threshold=None):
for intervention in self.interventions:
intervention.set_propositional_precondition(proposition, threshold)
return self</code></pre>
</details>
</dd>
<dt id="tinytroupe.steering.intervention.InterventionBatch.set_textual_precondition"><code class="name flex">
<span>def <span class="ident">set_textual_precondition</span></span>(<span>self, text)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def set_textual_precondition(self, text):
for intervention in self.interventions:
intervention.set_textual_precondition(text)
return self</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="tinytroupe.steering" href="index.html">tinytroupe.steering</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="tinytroupe.steering.intervention.Intervention" href="#tinytroupe.steering.intervention.Intervention">Intervention</a></code></h4>
<ul class="">
<li><code><a title="tinytroupe.steering.intervention.Intervention.apply_effect" href="#tinytroupe.steering.intervention.Intervention.apply_effect">apply_effect</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.Intervention.check_precondition" href="#tinytroupe.steering.intervention.Intervention.check_precondition">check_precondition</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.Intervention.create_for_each" href="#tinytroupe.steering.intervention.Intervention.create_for_each">create_for_each</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.Intervention.execute" href="#tinytroupe.steering.intervention.Intervention.execute">execute</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.Intervention.precondition_justification" href="#tinytroupe.steering.intervention.Intervention.precondition_justification">precondition_justification</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.Intervention.set_effect" href="#tinytroupe.steering.intervention.Intervention.set_effect">set_effect</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.Intervention.set_functional_precondition" href="#tinytroupe.steering.intervention.Intervention.set_functional_precondition">set_functional_precondition</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.Intervention.set_propositional_precondition" href="#tinytroupe.steering.intervention.Intervention.set_propositional_precondition">set_propositional_precondition</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.Intervention.set_textual_precondition" href="#tinytroupe.steering.intervention.Intervention.set_textual_precondition">set_textual_precondition</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="tinytroupe.steering.intervention.InterventionBatch" href="#tinytroupe.steering.intervention.InterventionBatch">InterventionBatch</a></code></h4>
<ul class="">
<li><code><a title="tinytroupe.steering.intervention.InterventionBatch.as_list" href="#tinytroupe.steering.intervention.InterventionBatch.as_list">as_list</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.InterventionBatch.set_effect" href="#tinytroupe.steering.intervention.InterventionBatch.set_effect">set_effect</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.InterventionBatch.set_functional_precondition" href="#tinytroupe.steering.intervention.InterventionBatch.set_functional_precondition">set_functional_precondition</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.InterventionBatch.set_propositional_precondition" href="#tinytroupe.steering.intervention.InterventionBatch.set_propositional_precondition">set_propositional_precondition</a></code></li>
<li><code><a title="tinytroupe.steering.intervention.InterventionBatch.set_textual_precondition" href="#tinytroupe.steering.intervention.InterventionBatch.set_textual_precondition">set_textual_precondition</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html> |