Spaces:
Paused
Paused
File size: 40,297 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 | <!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 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">Package <code>tinytroupe</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import os
import logging
import configparser
import rich # for rich console output
import rich.jupyter
# add current path to sys.path
import sys
sys.path.append('.')
from tinytroupe import utils # now we can import our utils
# AI disclaimers
print(\
"""
!!!!
DISCLAIMER: TinyTroupe relies on Artificial Intelligence (AI) models to generate content.
The AI models are not perfect and may produce inappropriate or inacurate results.
For any serious or consequential use, please review the generated content before using it.
!!!!
""")
###########################################################################
# Configuration Management System
###########################################################################
class ConfigManager:
"""
Manages configuration values with the ability to override defaults.
Provides dynamic access to the latest config values.
"""
def __init__(self):
self._config = {}
self._initialize_from_config()
def _initialize_from_config(self):
"""Initialize default values from config file"""
config = utils.read_config_file()
self._config["model"] = config["OpenAI"].get("MODEL", "gpt-4o")
self._config["embedding_model"] = config["OpenAI"].get("EMBEDDING_MODEL", "text-embedding-3-small")
if config["OpenAI"].get("API_TYPE") == "azure":
self._config["azure_embedding_model_api_version"] = config["OpenAI"].get("AZURE_EMBEDDING_MODEL_API_VERSION", "2023-05-15")
self._config["reasoning_model"] = config["OpenAI"].get("REASONING_MODEL", "o3-mini")
self._config["max_tokens"] = int(config["OpenAI"].get("MAX_TOKENS", "1024"))
self._config["temperature"] = float(config["OpenAI"].get("TEMPERATURE", "1.0"))
self._config["top_p"] = int(config["OpenAI"].get("TOP_P", "0"))
self._config["frequency_penalty"] = float(config["OpenAI"].get("FREQ_PENALTY", "0.0"))
self._config["presence_penalty"] = float(
config["OpenAI"].get("PRESENCE_PENALTY", "0.0"))
self._config["reasoning_effort"] = config["OpenAI"].get("REASONING_EFFORT", "high")
self._config["timeout"] = float(config["OpenAI"].get("TIMEOUT", "30.0"))
self._config["max_attempts"] = float(config["OpenAI"].get("MAX_ATTEMPTS", "0.0"))
self._config["waiting_time"] = float(config["OpenAI"].get("WAITING_TIME", "1"))
self._config["exponential_backoff_factor"] = float(config["OpenAI"].get("EXPONENTIAL_BACKOFF_FACTOR", "5"))
self._config["cache_api_calls"] = config["OpenAI"].getboolean("CACHE_API_CALLS", False)
self._config["cache_file_name"] = config["OpenAI"].get("CACHE_FILE_NAME", "openai_api_cache.pickle")
self._config["max_content_display_length"] = config["OpenAI"].getint("MAX_CONTENT_DISPLAY_LENGTH", 1024)
self._config["parallel_agent_actions"] = config["Simulation"].getboolean("PARALLEL_AGENT_ACTIONS", True)
self._config["parallel_agent_generation"] = config["Simulation"].getboolean("PARALLEL_AGENT_GENERATION", True)
self._config["enable_memory_consolidation"] = config["Cognition"].get("ENABLE_MEMORY_CONSOLIDATION", True)
self._config["min_episode_length"] = config["Cognition"].getint("MIN_EPISODE_LENGTH", 30)
self._config["max_episode_length"] = config["Cognition"].getint("MAX_EPISODE_LENGTH", 100)
self._config["episodic_memory_fixed_prefix_length"] = config["Cognition"].getint("EPISODIC_MEMORY_FIXED_PREFIX_LENGTH", 20)
self._config["episodic_memory_lookback_length"] = config["Cognition"].getint("EPISODIC_MEMORY_LOOKBACK_LENGTH", 20)
self._config["action_generator_max_attempts"] = config["ActionGenerator"].getint("MAX_ATTEMPTS", 2)
self._config["action_generator_enable_quality_checks"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECKS", False)
self._config["action_generator_enable_regeneration"] = config["ActionGenerator"].getboolean("ENABLE_REGENERATION", False)
self._config["action_generator_enable_direct_correction"] = config["ActionGenerator"].getboolean("ENABLE_DIRECT_CORRECTION", False)
self._config["action_generator_enable_quality_check_for_persona_adherence"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_PERSONA_ADHERENCE", False)
self._config["action_generator_enable_quality_check_for_selfconsistency"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_SELFCONSISTENCY", False)
self._config["action_generator_enable_quality_check_for_fluency"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_FLUENCY", False)
self._config["action_generator_enable_quality_check_for_suitability"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_SUITABILITY", False)
self._config["action_generator_enable_quality_check_for_similarity"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_SIMILARITY", False)
self._config["action_generator_continue_on_failure"] = config["ActionGenerator"].getboolean("CONTINUE_ON_FAILURE", True)
self._config["action_generator_quality_threshold"] = config["ActionGenerator"].getint("QUALITY_THRESHOLD", 2)
self._raw_config = config
def update(self, key, value):
"""
Update a configuration value.
Args:
key (str): The configuration key to update
value: The new value to set
Returns:
None
"""
if key in self._config:
self._config[key] = value
logging.info(f"Updated config: {key} = {value}")
else:
logging.warning(f"Attempted to update unknown config key: {key}")
def update_multiple(self, config_dict):
"""
Update multiple configuration values at once.
Args:
config_dict (dict): Dictionary of key-value pairs to update
Returns:
None
"""
for key, value in config_dict.items():
self.update(key, value)
def get(self, key, default=None):
"""
Get a configuration value.
Args:
key (str): The configuration key to retrieve
default: The default value to return if key is not found
Returns:
The configuration value
"""
return self._config.get(key, default)
def reset(self):
"""Reset all configuration values to their original values from the config file."""
self._initialize_from_config()
logging.info("All configuration values have been reset to defaults")
def __getitem__(self, key):
"""Allow dictionary-like access to configuration values."""
return self.get(key)
def config_defaults(self, **config_mappings):
"""
Returns a decorator that replaces None default values with current config values.
Args:
**config_mappings: Mapping of parameter names to config keys
Example:
@config_manager.config_defaults(model="model", temp="temperature")
def generate(prompt, model=None, temp=None):
# model will be the current config value for "model" if None is passed
# ...
"""
import functools
import inspect
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
# Get the function's signature
sig = inspect.signature(func)
bound_args = sig.bind_partial(*args, **kwargs)
bound_args.apply_defaults()
# For each parameter that maps to a config key
for param_name, config_key in config_mappings.items():
# If the parameter is None, replace with config value
if param_name in bound_args.arguments and bound_args.arguments[param_name] is None:
kwargs[param_name] = self.get(config_key)
return func(*args, **kwargs)
return wrapper
return decorator
# Create global instance of the configuration manager
config = utils.read_config_file()
utils.pretty_print_tinytroupe_version()
utils.pretty_print_datetime()
utils.pretty_print_config(config)
utils.start_logger(config)
config_manager = ConfigManager()
# For backwards compatibility, maintain the default dict
# but it's recommended to use config_manager instead
default = config_manager._config
# Helper function for method signatures
def get_config(key, override_value=None):
"""
Get a configuration value, with optional override.
Used in method signatures to get current config values.
Args:
key (str): The configuration key
override_value: If provided, this value is used instead of the config value
Returns:
The configuration value or the override value
"""
if override_value is not None:
return override_value
return config_manager.get(key)
## LLaMa-Index configs ########################################################
#from llama_index.embeddings.huggingface import HuggingFaceEmbedding
if config["OpenAI"].get("API_TYPE") == "azure":
from llama_index.embeddings.azure_openai import AzureOpenAIEmbedding
else:
from llama_index.embeddings.openai import OpenAIEmbedding
from llama_index.core import Settings, Document, VectorStoreIndex, SimpleDirectoryReader
from llama_index.readers.web import SimpleWebPageReader
# this will be cached locally by llama-index, in a OS-dependend location
##Settings.embed_model = HuggingFaceEmbedding(
## model_name="BAAI/bge-small-en-v1.5"
##)
if config["OpenAI"].get("API_TYPE") == "azure":
llamaindex_openai_embed_model = AzureOpenAIEmbedding(model=default["embedding_model"],
deployment_name=default["embedding_model"],
api_version=default["azure_embedding_model_api_version"],
embed_batch_size=10)
else:
llamaindex_openai_embed_model = OpenAIEmbedding(model=default["embedding_model"], embed_batch_size=10)
Settings.embed_model = llamaindex_openai_embed_model
###########################################################################
# Fixes and tweaks
###########################################################################
# fix an issue in the rich library: we don't want margins in Jupyter!
rich.jupyter.JUPYTER_HTML_FORMAT = \
utils.inject_html_css_style_prefix(rich.jupyter.JUPYTER_HTML_FORMAT, "margin:0px;")</code></pre>
</details>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="tinytroupe.agent" href="agent/index.html">tinytroupe.agent</a></code></dt>
<dd>
<div class="desc"><p>This module provides the main classes and functions for TinyTroupe's
agents …</p></div>
</dd>
<dt><code class="name"><a title="tinytroupe.control" href="control.html">tinytroupe.control</a></code></dt>
<dd>
<div class="desc"><p>Simulation controlling mechanisms.</p></div>
</dd>
<dt><code class="name"><a title="tinytroupe.enrichment" href="enrichment/index.html">tinytroupe.enrichment</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="tinytroupe.environment" href="environment/index.html">tinytroupe.environment</a></code></dt>
<dd>
<div class="desc"><p>Environments provide a structured way to define the world in which the
agents interact with each other as well as external entities (e.g., search …</p></div>
</dd>
<dt><code class="name"><a title="tinytroupe.examples" href="examples/index.html">tinytroupe.examples</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="tinytroupe.experimentation" href="experimentation/index.html">tinytroupe.experimentation</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="tinytroupe.extraction" href="extraction/index.html">tinytroupe.extraction</a></code></dt>
<dd>
<div class="desc"><p>Simulations produce a lot of data, and it is often useful to extract these data in a structured way. For instance, you might wish to:
- Extract the …</p></div>
</dd>
<dt><code class="name"><a title="tinytroupe.factory" href="factory/index.html">tinytroupe.factory</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="tinytroupe.openai_utils" href="openai_utils.html">tinytroupe.openai_utils</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="tinytroupe.profiling" href="profiling.html">tinytroupe.profiling</a></code></dt>
<dd>
<div class="desc"><p>Provides mechanisms for creating understanding the characteristics of agent populations, such as
their age distribution, typical interests, and so on …</p></div>
</dd>
<dt><code class="name"><a title="tinytroupe.steering" href="steering/index.html">tinytroupe.steering</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="tinytroupe.tools" href="tools/index.html">tinytroupe.tools</a></code></dt>
<dd>
<div class="desc"><p>Tools allow agents to accomplish specialized tasks.</p></div>
</dd>
<dt><code class="name"><a title="tinytroupe.utils" href="utils/index.html">tinytroupe.utils</a></code></dt>
<dd>
<div class="desc"><p>General utilities and convenience functions.</p></div>
</dd>
<dt><code class="name"><a title="tinytroupe.validation" href="validation/index.html">tinytroupe.validation</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="tinytroupe.get_config"><code class="name flex">
<span>def <span class="ident">get_config</span></span>(<span>key, override_value=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Get a configuration value, with optional override.
Used in method signatures to get current config values.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>key</code></strong> : <code>str</code></dt>
<dd>The configuration key</dd>
<dt><strong><code>override_value</code></strong></dt>
<dd>If provided, this value is used instead of the config value</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>The configuration value or the override value</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_config(key, override_value=None):
"""
Get a configuration value, with optional override.
Used in method signatures to get current config values.
Args:
key (str): The configuration key
override_value: If provided, this value is used instead of the config value
Returns:
The configuration value or the override value
"""
if override_value is not None:
return override_value
return config_manager.get(key)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="tinytroupe.ConfigManager"><code class="flex name class">
<span>class <span class="ident">ConfigManager</span></span>
</code></dt>
<dd>
<div class="desc"><p>Manages configuration values with the ability to override defaults.
Provides dynamic access to the latest config values.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class ConfigManager:
"""
Manages configuration values with the ability to override defaults.
Provides dynamic access to the latest config values.
"""
def __init__(self):
self._config = {}
self._initialize_from_config()
def _initialize_from_config(self):
"""Initialize default values from config file"""
config = utils.read_config_file()
self._config["model"] = config["OpenAI"].get("MODEL", "gpt-4o")
self._config["embedding_model"] = config["OpenAI"].get("EMBEDDING_MODEL", "text-embedding-3-small")
if config["OpenAI"].get("API_TYPE") == "azure":
self._config["azure_embedding_model_api_version"] = config["OpenAI"].get("AZURE_EMBEDDING_MODEL_API_VERSION", "2023-05-15")
self._config["reasoning_model"] = config["OpenAI"].get("REASONING_MODEL", "o3-mini")
self._config["max_tokens"] = int(config["OpenAI"].get("MAX_TOKENS", "1024"))
self._config["temperature"] = float(config["OpenAI"].get("TEMPERATURE", "1.0"))
self._config["top_p"] = int(config["OpenAI"].get("TOP_P", "0"))
self._config["frequency_penalty"] = float(config["OpenAI"].get("FREQ_PENALTY", "0.0"))
self._config["presence_penalty"] = float(
config["OpenAI"].get("PRESENCE_PENALTY", "0.0"))
self._config["reasoning_effort"] = config["OpenAI"].get("REASONING_EFFORT", "high")
self._config["timeout"] = float(config["OpenAI"].get("TIMEOUT", "30.0"))
self._config["max_attempts"] = float(config["OpenAI"].get("MAX_ATTEMPTS", "0.0"))
self._config["waiting_time"] = float(config["OpenAI"].get("WAITING_TIME", "1"))
self._config["exponential_backoff_factor"] = float(config["OpenAI"].get("EXPONENTIAL_BACKOFF_FACTOR", "5"))
self._config["cache_api_calls"] = config["OpenAI"].getboolean("CACHE_API_CALLS", False)
self._config["cache_file_name"] = config["OpenAI"].get("CACHE_FILE_NAME", "openai_api_cache.pickle")
self._config["max_content_display_length"] = config["OpenAI"].getint("MAX_CONTENT_DISPLAY_LENGTH", 1024)
self._config["parallel_agent_actions"] = config["Simulation"].getboolean("PARALLEL_AGENT_ACTIONS", True)
self._config["parallel_agent_generation"] = config["Simulation"].getboolean("PARALLEL_AGENT_GENERATION", True)
self._config["enable_memory_consolidation"] = config["Cognition"].get("ENABLE_MEMORY_CONSOLIDATION", True)
self._config["min_episode_length"] = config["Cognition"].getint("MIN_EPISODE_LENGTH", 30)
self._config["max_episode_length"] = config["Cognition"].getint("MAX_EPISODE_LENGTH", 100)
self._config["episodic_memory_fixed_prefix_length"] = config["Cognition"].getint("EPISODIC_MEMORY_FIXED_PREFIX_LENGTH", 20)
self._config["episodic_memory_lookback_length"] = config["Cognition"].getint("EPISODIC_MEMORY_LOOKBACK_LENGTH", 20)
self._config["action_generator_max_attempts"] = config["ActionGenerator"].getint("MAX_ATTEMPTS", 2)
self._config["action_generator_enable_quality_checks"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECKS", False)
self._config["action_generator_enable_regeneration"] = config["ActionGenerator"].getboolean("ENABLE_REGENERATION", False)
self._config["action_generator_enable_direct_correction"] = config["ActionGenerator"].getboolean("ENABLE_DIRECT_CORRECTION", False)
self._config["action_generator_enable_quality_check_for_persona_adherence"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_PERSONA_ADHERENCE", False)
self._config["action_generator_enable_quality_check_for_selfconsistency"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_SELFCONSISTENCY", False)
self._config["action_generator_enable_quality_check_for_fluency"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_FLUENCY", False)
self._config["action_generator_enable_quality_check_for_suitability"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_SUITABILITY", False)
self._config["action_generator_enable_quality_check_for_similarity"] = config["ActionGenerator"].getboolean("ENABLE_QUALITY_CHECK_FOR_SIMILARITY", False)
self._config["action_generator_continue_on_failure"] = config["ActionGenerator"].getboolean("CONTINUE_ON_FAILURE", True)
self._config["action_generator_quality_threshold"] = config["ActionGenerator"].getint("QUALITY_THRESHOLD", 2)
self._raw_config = config
def update(self, key, value):
"""
Update a configuration value.
Args:
key (str): The configuration key to update
value: The new value to set
Returns:
None
"""
if key in self._config:
self._config[key] = value
logging.info(f"Updated config: {key} = {value}")
else:
logging.warning(f"Attempted to update unknown config key: {key}")
def update_multiple(self, config_dict):
"""
Update multiple configuration values at once.
Args:
config_dict (dict): Dictionary of key-value pairs to update
Returns:
None
"""
for key, value in config_dict.items():
self.update(key, value)
def get(self, key, default=None):
"""
Get a configuration value.
Args:
key (str): The configuration key to retrieve
default: The default value to return if key is not found
Returns:
The configuration value
"""
return self._config.get(key, default)
def reset(self):
"""Reset all configuration values to their original values from the config file."""
self._initialize_from_config()
logging.info("All configuration values have been reset to defaults")
def __getitem__(self, key):
"""Allow dictionary-like access to configuration values."""
return self.get(key)
def config_defaults(self, **config_mappings):
"""
Returns a decorator that replaces None default values with current config values.
Args:
**config_mappings: Mapping of parameter names to config keys
Example:
@config_manager.config_defaults(model="model", temp="temperature")
def generate(prompt, model=None, temp=None):
# model will be the current config value for "model" if None is passed
# ...
"""
import functools
import inspect
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
# Get the function's signature
sig = inspect.signature(func)
bound_args = sig.bind_partial(*args, **kwargs)
bound_args.apply_defaults()
# For each parameter that maps to a config key
for param_name, config_key in config_mappings.items():
# If the parameter is None, replace with config value
if param_name in bound_args.arguments and bound_args.arguments[param_name] is None:
kwargs[param_name] = self.get(config_key)
return func(*args, **kwargs)
return wrapper
return decorator</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="tinytroupe.ConfigManager.config_defaults"><code class="name flex">
<span>def <span class="ident">config_defaults</span></span>(<span>self, **config_mappings)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns a decorator that replaces None default values with current config values.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>**config_mappings</code></strong></dt>
<dd>Mapping of parameter names to config keys</dd>
</dl>
<h2 id="example">Example</h2>
<p>@config_manager.config_defaults(model="model", temp="temperature")
def generate(prompt, model=None, temp=None):
# model will be the current config value for "model" if None is passed
# …</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def config_defaults(self, **config_mappings):
"""
Returns a decorator that replaces None default values with current config values.
Args:
**config_mappings: Mapping of parameter names to config keys
Example:
@config_manager.config_defaults(model="model", temp="temperature")
def generate(prompt, model=None, temp=None):
# model will be the current config value for "model" if None is passed
# ...
"""
import functools
import inspect
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
# Get the function's signature
sig = inspect.signature(func)
bound_args = sig.bind_partial(*args, **kwargs)
bound_args.apply_defaults()
# For each parameter that maps to a config key
for param_name, config_key in config_mappings.items():
# If the parameter is None, replace with config value
if param_name in bound_args.arguments and bound_args.arguments[param_name] is None:
kwargs[param_name] = self.get(config_key)
return func(*args, **kwargs)
return wrapper
return decorator</code></pre>
</details>
</dd>
<dt id="tinytroupe.ConfigManager.get"><code class="name flex">
<span>def <span class="ident">get</span></span>(<span>self, key, default=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Get a configuration value.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>key</code></strong> : <code>str</code></dt>
<dd>The configuration key to retrieve</dd>
<dt><strong><code>default</code></strong></dt>
<dd>The default value to return if key is not found</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>The configuration value</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get(self, key, default=None):
"""
Get a configuration value.
Args:
key (str): The configuration key to retrieve
default: The default value to return if key is not found
Returns:
The configuration value
"""
return self._config.get(key, default)</code></pre>
</details>
</dd>
<dt id="tinytroupe.ConfigManager.reset"><code class="name flex">
<span>def <span class="ident">reset</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Reset all configuration values to their original values from the config file.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def reset(self):
"""Reset all configuration values to their original values from the config file."""
self._initialize_from_config()
logging.info("All configuration values have been reset to defaults")</code></pre>
</details>
</dd>
<dt id="tinytroupe.ConfigManager.update"><code class="name flex">
<span>def <span class="ident">update</span></span>(<span>self, key, value)</span>
</code></dt>
<dd>
<div class="desc"><p>Update a configuration value.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>key</code></strong> : <code>str</code></dt>
<dd>The configuration key to update</dd>
<dt><strong><code>value</code></strong></dt>
<dd>The new value to set</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>None</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def update(self, key, value):
"""
Update a configuration value.
Args:
key (str): The configuration key to update
value: The new value to set
Returns:
None
"""
if key in self._config:
self._config[key] = value
logging.info(f"Updated config: {key} = {value}")
else:
logging.warning(f"Attempted to update unknown config key: {key}")</code></pre>
</details>
</dd>
<dt id="tinytroupe.ConfigManager.update_multiple"><code class="name flex">
<span>def <span class="ident">update_multiple</span></span>(<span>self, config_dict)</span>
</code></dt>
<dd>
<div class="desc"><p>Update multiple configuration values at once.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>config_dict</code></strong> : <code>dict</code></dt>
<dd>Dictionary of key-value pairs to update</dd>
</dl>
<h2 id="returns">Returns</h2>
<p>None</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def update_multiple(self, config_dict):
"""
Update multiple configuration values at once.
Args:
config_dict (dict): Dictionary of key-value pairs to update
Returns:
None
"""
for key, value in config_dict.items():
self.update(key, value)</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><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="tinytroupe.agent" href="agent/index.html">tinytroupe.agent</a></code></li>
<li><code><a title="tinytroupe.control" href="control.html">tinytroupe.control</a></code></li>
<li><code><a title="tinytroupe.enrichment" href="enrichment/index.html">tinytroupe.enrichment</a></code></li>
<li><code><a title="tinytroupe.environment" href="environment/index.html">tinytroupe.environment</a></code></li>
<li><code><a title="tinytroupe.examples" href="examples/index.html">tinytroupe.examples</a></code></li>
<li><code><a title="tinytroupe.experimentation" href="experimentation/index.html">tinytroupe.experimentation</a></code></li>
<li><code><a title="tinytroupe.extraction" href="extraction/index.html">tinytroupe.extraction</a></code></li>
<li><code><a title="tinytroupe.factory" href="factory/index.html">tinytroupe.factory</a></code></li>
<li><code><a title="tinytroupe.openai_utils" href="openai_utils.html">tinytroupe.openai_utils</a></code></li>
<li><code><a title="tinytroupe.profiling" href="profiling.html">tinytroupe.profiling</a></code></li>
<li><code><a title="tinytroupe.steering" href="steering/index.html">tinytroupe.steering</a></code></li>
<li><code><a title="tinytroupe.tools" href="tools/index.html">tinytroupe.tools</a></code></li>
<li><code><a title="tinytroupe.utils" href="utils/index.html">tinytroupe.utils</a></code></li>
<li><code><a title="tinytroupe.validation" href="validation/index.html">tinytroupe.validation</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="tinytroupe.get_config" href="#tinytroupe.get_config">get_config</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="tinytroupe.ConfigManager" href="#tinytroupe.ConfigManager">ConfigManager</a></code></h4>
<ul class="">
<li><code><a title="tinytroupe.ConfigManager.config_defaults" href="#tinytroupe.ConfigManager.config_defaults">config_defaults</a></code></li>
<li><code><a title="tinytroupe.ConfigManager.get" href="#tinytroupe.ConfigManager.get">get</a></code></li>
<li><code><a title="tinytroupe.ConfigManager.reset" href="#tinytroupe.ConfigManager.reset">reset</a></code></li>
<li><code><a title="tinytroupe.ConfigManager.update" href="#tinytroupe.ConfigManager.update">update</a></code></li>
<li><code><a title="tinytroupe.ConfigManager.update_multiple" href="#tinytroupe.ConfigManager.update_multiple">update_multiple</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> |