edsl 0.1.29.dev2__tar.gz → 0.1.29.dev5__tar.gz

{edsl-0.1.29.dev2 → edsl-0.1.29.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edsl
-Version: 0.1.29.dev2
+Version: 0.1.29.dev5
 Summary: Create and analyze LLM-based surveys
 Home-page: https://www.expectedparrot.com/
 License: MIT
@@ -57,15 +57,6 @@ The Expected Parrot Domain-Specific Language (EDSL) package lets you conduct com
 - [LinkedIn](https://www.linkedin.com/company/expectedparrot/)
 - [Blog](https://blog.expectedparrot.com)
 
-## 💡 Contributions, feature requests & bugs
-Interested in contributing? Want us to add a new feature? Found a bug for us to squash? 
-Please send us an email at [info@expectedparrot.com](mailto:info@expectedparrot.com) or message us at our [Discord channel](https://discord.com/invite/mxAYkjfy9m).
-
-## 💻 Requirements
-* EDSL is compatible with Python 3.9 - 3.12.
-* API keys for large language models that you want to use, stored in a `.env` file.
-See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html).
-
 ## 🌎 Hello, World!
 A quick example:
 
@@ -96,3 +87,13 @@ Output:
 │ Good              │
 └───────────────────┘
 ```
+
+## 💻 Requirements
+* EDSL is compatible with Python 3.9 - 3.12.
+* API keys for large language models that you want to use, stored in a `.env` file.
+See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html).
+
+## 💡 Contributions, feature requests & bugs
+Interested in contributing? Want us to add a new feature? Found a bug for us to squash? 
+Please send us an email at [info@expectedparrot.com](mailto:info@expectedparrot.com) or message us at our [Discord channel](https://discord.com/invite/mxAYkjfy9m).
+

{edsl-0.1.29.dev2 → edsl-0.1.29.dev5}/README.md

@@ -14,15 +14,6 @@ The Expected Parrot Domain-Specific Language (EDSL) package lets you conduct com
 - [LinkedIn](https://www.linkedin.com/company/expectedparrot/)
 - [Blog](https://blog.expectedparrot.com)
 
-## 💡 Contributions, feature requests & bugs
-Interested in contributing? Want us to add a new feature? Found a bug for us to squash? 
-Please send us an email at [info@expectedparrot.com](mailto:info@expectedparrot.com) or message us at our [Discord channel](https://discord.com/invite/mxAYkjfy9m).
-
-## 💻 Requirements
-* EDSL is compatible with Python 3.9 - 3.12.
-* API keys for large language models that you want to use, stored in a `.env` file.
-See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html).
-
 ## 🌎 Hello, World!
 A quick example:
 
@@ -52,4 +43,13 @@ Output:
 ┡━━━━━━━━━━━━━━━━━━━┩
 │ Good              │
 └───────────────────┘
-```
+```
+
+## 💻 Requirements
+* EDSL is compatible with Python 3.9 - 3.12.
+* API keys for large language models that you want to use, stored in a `.env` file.
+See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html).
+
+## 💡 Contributions, feature requests & bugs
+Interested in contributing? Want us to add a new feature? Found a bug for us to squash? 
+Please send us an email at [info@expectedparrot.com](mailto:info@expectedparrot.com) or message us at our [Discord channel](https://discord.com/invite/mxAYkjfy9m).

edsl-0.1.29.dev5/edsl/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.1.29.dev5"

{edsl-0.1.29.dev2 → edsl-0.1.29.dev5}/edsl/agents/Agent.py

@@ -273,6 +273,7 @@ class Agent(Base):
         *,
         question: QuestionBase,
         cache,
+        survey: Optional["Survey"] = None,
         scenario: Optional[Scenario] = None,
         model: Optional[LanguageModel] = None,
         debug: bool = False,
@@ -301,6 +302,7 @@ class Agent(Base):
         invigilator = self._create_invigilator(
             question=question,
             scenario=scenario,
+            survey=survey,
             model=model,
             debug=debug,
             memory_plan=memory_plan,
@@ -317,6 +319,7 @@ class Agent(Base):
         question: QuestionBase,
         cache: Cache,
         scenario: Optional[Scenario] = None,
+        survey: Optional["Survey"] = None,
         model: Optional[LanguageModel] = None,
         debug: bool = False,
         memory_plan: Optional[MemoryPlan] = None,
@@ -349,6 +352,7 @@ class Agent(Base):
             question=question,
             cache=cache,
             scenario=scenario,
+            survey=survey,
             model=model,
             debug=debug,
             memory_plan=memory_plan,
@@ -366,6 +370,7 @@ class Agent(Base):
         cache: Optional[Cache] = None,
         scenario: Optional[Scenario] = None,
         model: Optional[LanguageModel] = None,
+        survey: Optional["Survey"] = None,
         debug: bool = False,
         memory_plan: Optional[MemoryPlan] = None,
         current_answers: Optional[dict] = None,
@@ -404,6 +409,7 @@ class Agent(Base):
             self,
             question=question,
             scenario=scenario,
+            survey=survey,
             model=model,
             memory_plan=memory_plan,
             current_answers=current_answers,
@@ -479,6 +485,12 @@ class Agent(Base):
         """
         return self.data == other.data
 
+    def __getattr__(self, name):
+        # This will be called only if 'name' is not found in the usual places
+        if name in self.traits:
+            return self.traits[name]
+        raise AttributeError(f"'{type(self).__name__}' object has no attribute '{name}'")
+  
     def print(self) -> None:
         from rich import print_json
         import json

{edsl-0.1.29.dev2 → edsl-0.1.29.dev5}/edsl/agents/AgentList.py

@@ -241,16 +241,16 @@ class AgentList(UserList, Base):
 
         """
         return cls([Agent.example(), Agent.example()])
-    
+
     @classmethod
-    def from_list(self, trait_name:str, values: List[Any]):
+    def from_list(self, trait_name: str, values: List[Any]):
         """Create an AgentList from a list of values.
 
         :param trait_name: The name of the trait.
         :param values: A list of values.
         """
         return AgentList([Agent({trait_name: value}) for value in values])
-    
+
     def __mul__(self, other: AgentList) -> AgentList:
         """Takes the cross product of two AgentLists."""
         from itertools import product
@@ -260,7 +260,6 @@ class AgentList(UserList, Base):
             new_sl.append(s1 + s2)
         return AgentList(new_sl)
 
-
     def code(self, string=True) -> Union[str, list[str]]:
         """Return code to construct an AgentList.
 

{edsl-0.1.29.dev2 → edsl-0.1.29.dev5}/edsl/agents/InvigilatorBase.py

@@ -46,6 +46,7 @@ class InvigilatorBase(ABC):
         model: LanguageModel,
         memory_plan: MemoryPlan,
         current_answers: dict,
+        survey: Optional["Survey"],
         cache: Optional[Cache] = None,
         iteration: Optional[int] = 1,
         additional_prompt_data: Optional[dict] = None,
@@ -57,11 +58,12 @@ class InvigilatorBase(ABC):
         self.scenario = scenario
         self.model = model
         self.memory_plan = memory_plan
-        self.current_answers = current_answers
+        self.current_answers = current_answers or {}
         self.iteration = iteration
         self.additional_prompt_data = additional_prompt_data
         self.cache = cache
         self.sidecar_model = sidecar_model
+        self.survey = survey
 
     def __repr__(self) -> str:
         """Return a string representation of the Invigilator.
@@ -76,7 +78,7 @@ class InvigilatorBase(ABC):
         """Return an AgentResponseDict used in case the question-asking fails.
 
         >>> InvigilatorBase.example().get_failed_task_result()
-        {'answer': None, 'comment': 'Failed to get response', 'question_name': 'how_feeling', ...}
+        {'answer': None, 'comment': 'Failed to get response', ...}
         """
         return AgentResponseDict(
             answer=None,
@@ -86,11 +88,8 @@ class InvigilatorBase(ABC):
         )
 
     def get_prompts(self) -> Dict[str, Prompt]:
-        """Return the prompt used.
+        """Return the prompt used."""
 
-        >>> InvigilatorBase.example().get_prompts()
-        {'user_prompt': Prompt(text=\"""NA\"""), 'system_prompt': Prompt(text=\"""NA\""")}
-        """
         return {
             "user_prompt": Prompt("NA"),
             "system_prompt": Prompt("NA"),
@@ -129,7 +128,7 @@ class InvigilatorBase(ABC):
         )
 
     @classmethod
-    def example(cls, throw_an_exception=False):
+    def example(cls, throw_an_exception=False, question=None, scenario=None):
         """Return an example invigilator.
 
         >>> InvigilatorBase.example()
@@ -167,15 +166,20 @@ class InvigilatorBase(ABC):
         if throw_an_exception:
             model.throw_an_exception = True
         agent = Agent.example()
-        question = QuestionMultipleChoice.example()
-        scenario = Scenario.example()
+        # question = QuestionMultipleChoice.example()
+        from edsl.surveys import Survey
+
+        survey = Survey.example()
+        question = question or survey.questions[0]
+        scenario = scenario or Scenario.example()
         # memory_plan = None #memory_plan = MemoryPlan()
         from edsl import Survey
 
         memory_plan = MemoryPlan(survey=Survey.example())
         current_answers = None
+        from edsl.agents.PromptConstructionMixin import PromptConstructorMixin
 
-        class InvigilatorExample(InvigilatorBase):
+        class InvigilatorExample(PromptConstructorMixin, InvigilatorBase):
             """An example invigilator."""
 
             async def async_answer_question(self):
@@ -188,6 +192,7 @@ class InvigilatorBase(ABC):
             agent=agent,
             question=question,
             scenario=scenario,
+            survey=survey,
             model=model,
             memory_plan=memory_plan,
             current_answers=current_answers,

edsl-0.1.29.dev5/edsl/agents/PromptConstructionMixin.py

@@ -0,0 +1,374 @@
+from typing import Dict, Any, Optional
+from collections import UserList
+
+# from functools import reduce
+from edsl.prompts.Prompt import Prompt
+
+# from edsl.utilities.decorators import sync_wrapper, jupyter_nb_handler
+from edsl.prompts.registry import get_classes as prompt_lookup
+from edsl.exceptions import QuestionScenarioRenderError
+
+import enum
+
+
+class PromptComponent(enum.Enum):
+    AGENT_INSTRUCTIONS = "agent_instructions"
+    AGENT_PERSONA = "agent_persona"
+    QUESTION_INSTRUCTIONS = "question_instructions"
+    PRIOR_QUESTION_MEMORY = "prior_question_memory"
+
+
+class PromptList(UserList):
+    separator = Prompt(" ")
+
+    def reduce(self):
+        """Reduce the list of prompts to a single prompt.
+
+        >>> p = PromptList([Prompt("You are a happy-go lucky agent."), Prompt("You are an agent with the following persona: {'age': 22, 'hair': 'brown', 'height': 5.5}")])
+        >>> p.reduce()
+        Prompt(text=\"""You are a happy-go lucky agent. You are an agent with the following persona: {'age': 22, 'hair': 'brown', 'height': 5.5}\""")
+
+        """
+        p = self[0]
+        for prompt in self[1:]:
+            if len(prompt) > 0:
+                p = p + self.separator + prompt
+        return p
+
+
+class PromptPlan:
+    """A plan for constructing prompts for the LLM call.
+    Every prompt plan has a user prompt order and a system prompt order.
+    It must contain each of the values in the PromptComponent enum.
+
+
+    >>> p = PromptPlan(user_prompt_order=(PromptComponent.AGENT_INSTRUCTIONS, PromptComponent.AGENT_PERSONA),system_prompt_order=(PromptComponent.QUESTION_INSTRUCTIONS, PromptComponent.PRIOR_QUESTION_MEMORY))
+    >>> p._is_valid_plan()
+    True
+
+    >>> p.arrange_components(agent_instructions=1, agent_persona=2, question_instructions=3, prior_question_memory=4)
+    {'user_prompt': ..., 'system_prompt': ...}
+
+    >>> p = PromptPlan(user_prompt_order=("agent_instructions", ), system_prompt_order=("question_instructions", "prior_question_memory"))
+    Traceback (most recent call last):
+    ...
+    ValueError: Invalid plan: must contain each value of PromptComponent exactly once.
+
+    """
+
+    def __init__(
+        self,
+        user_prompt_order: Optional[tuple] = None,
+        system_prompt_order: Optional[tuple] = None,
+    ):
+        """Initialize the PromptPlan."""
+
+        if user_prompt_order is None:
+            user_prompt_order = (
+                PromptComponent.QUESTION_INSTRUCTIONS,
+                PromptComponent.PRIOR_QUESTION_MEMORY,
+            )
+        if system_prompt_order is None:
+            system_prompt_order = (
+                PromptComponent.AGENT_INSTRUCTIONS,
+                PromptComponent.AGENT_PERSONA,
+            )
+
+        # very commmon way to screw this up given how python treats single strings as iterables
+        if isinstance(user_prompt_order, str):
+            user_prompt_order = (user_prompt_order,)
+
+        if isinstance(system_prompt_order, str):
+            system_prompt_order = (system_prompt_order,)
+
+        if not isinstance(user_prompt_order, tuple):
+            raise TypeError(
+                f"Expected a tuple, but got {type(user_prompt_order).__name__}"
+            )
+
+        if not isinstance(system_prompt_order, tuple):
+            raise TypeError(
+                f"Expected a tuple, but got {type(system_prompt_order).__name__}"
+            )
+
+        self.user_prompt_order = self._convert_to_enum(user_prompt_order)
+        self.system_prompt_order = self._convert_to_enum(system_prompt_order)
+        if not self._is_valid_plan():
+            raise ValueError(
+                "Invalid plan: must contain each value of PromptComponent exactly once."
+            )
+
+    def _convert_to_enum(self, prompt_order: tuple):
+        """Convert string names to PromptComponent enum values."""
+        return tuple(
+            PromptComponent(component) if isinstance(component, str) else component
+            for component in prompt_order
+        )
+
+    def _is_valid_plan(self):
+        """Check if the plan is valid."""
+        combined = self.user_prompt_order + self.system_prompt_order
+        return set(combined) == set(PromptComponent)
+
+    def arrange_components(self, **kwargs) -> Dict[PromptComponent, Prompt]:
+        """Arrange the components in the order specified by the plan."""
+        # check is valid components passed
+        component_strings = set([pc.value for pc in PromptComponent])
+        if not set(kwargs.keys()) == component_strings:
+            raise ValueError(
+                f"Invalid components passed: {set(kwargs.keys())} but expected {PromptComponent}"
+            )
+
+        user_prompt = PromptList(
+            [kwargs[component.value] for component in self.user_prompt_order]
+        )
+        system_prompt = PromptList(
+            [kwargs[component.value] for component in self.system_prompt_order]
+        )
+        return {"user_prompt": user_prompt, "system_prompt": system_prompt}
+
+    def get_prompts(self, **kwargs) -> Dict[str, Prompt]:
+        """Get both prompts for the LLM call."""
+        prompts = self.arrange_components(**kwargs)
+        return {
+            "user_prompt": prompts["user_prompt"].reduce(),
+            "system_prompt": prompts["system_prompt"].reduce(),
+        }
+
+
+class PromptConstructorMixin:
+    """Mixin for constructing prompts for the LLM call.
+
+    The pieces of a prompt are:
+    - The agent instructions - "You are answering questions as if you were a human. Do not break character."
+    - The persona prompt - "You are an agent with the following persona: {'age': 22, 'hair': 'brown', 'height': 5.5}"
+    - The question instructions - "You are being asked the following question: Do you like school? The options are 0: yes 1: no Return a valid JSON formatted like this, selecting only the number of the option: {"answer": <put answer code here>, "comment": "<put explanation here>"} Only 1 option may be selected."
+    - The memory prompt - "Before the question you are now answering, you already answered the following question(s): Question: Do you like school? Answer: Prior answer"
+
+    This is mixed into the Invigilator class.
+    """
+
+    prompt_plan = PromptPlan()
+
+    @property
+    def agent_instructions_prompt(self) -> Prompt:
+        """
+        >>> from edsl.agents.InvigilatorBase import InvigilatorBase
+        >>> i = InvigilatorBase.example()
+        >>> i.agent_instructions_prompt
+        Prompt(text=\"""You are answering questions as if you were a human. Do not break character.\""")
+        """
+        if not hasattr(self, "_agent_instructions_prompt"):
+            applicable_prompts = prompt_lookup(
+                component_type="agent_instructions",
+                model=self.model.model,
+            )
+            if len(applicable_prompts) == 0:
+                raise Exception("No applicable prompts found")
+            self._agent_instructions_prompt = applicable_prompts[0](
+                text=self.agent.instruction
+            )
+        return self._agent_instructions_prompt
+
+    @property
+    def agent_persona_prompt(self) -> Prompt:
+        """
+        >>> from edsl.agents.InvigilatorBase import InvigilatorBase
+        >>> i = InvigilatorBase.example()
+        >>> i.agent_persona_prompt
+        Prompt(text=\"""You are an agent with the following persona:
+        {'age': 22, 'hair': 'brown', 'height': 5.5}\""")
+
+        """
+        if not hasattr(self, "_agent_persona_prompt"):
+            if not hasattr(self.agent, "agent_persona"):
+                applicable_prompts = prompt_lookup(
+                    component_type="agent_persona",
+                    model=self.model.model,
+                )
+                persona_prompt_template = applicable_prompts[0]()
+            else:
+                persona_prompt_template = self.agent.agent_persona
+
+            # TODO: This multiple passing of agent traits - not sure if it is necessary. Not harmful.
+            if undefined := persona_prompt_template.undefined_template_variables(
+                self.agent.traits
+                | {"traits": self.agent.traits}
+                | {"codebook": self.agent.codebook}
+                | {"traits": self.agent.traits}
+            ):
+                raise QuestionScenarioRenderError(
+                    f"Agent persona still has variables that were not rendered: {undefined}"
+                )
+
+            persona_prompt = persona_prompt_template.render(
+                self.agent.traits | {"traits": self.agent.traits},
+                codebook=self.agent.codebook,
+                traits=self.agent.traits,
+            )
+            if persona_prompt.has_variables:
+                raise QuestionScenarioRenderError(
+                    "Agent persona still has variables that were not rendered."
+                )
+            self._agent_persona_prompt = persona_prompt
+
+        return self._agent_persona_prompt
+
+    @property
+    def question_instructions_prompt(self) -> Prompt:
+        """
+        >>> from edsl.agents.InvigilatorBase import InvigilatorBase
+        >>> i = InvigilatorBase.example()
+        >>> i.question_instructions_prompt
+        Prompt(text=\"""You are being asked the following question: Do you like school?
+        The options are
+        <BLANKLINE>
+        0: yes
+        <BLANKLINE>
+        1: no
+        <BLANKLINE>
+        Return a valid JSON formatted like this, selecting only the number of the option:
+        {"answer": <put answer code here>, "comment": "<put explanation here>"}
+        Only 1 option may be selected.\""")
+
+        >>> from edsl import QuestionFreeText
+        >>> q = QuestionFreeText(question_text = "Consider {{ X }}. What is your favorite color?", question_name = "q_color")
+        >>> from edsl.agents.InvigilatorBase import InvigilatorBase
+        >>> i = InvigilatorBase.example(question = q)
+        >>> i.question_instructions_prompt
+        Traceback (most recent call last):
+        ...
+        edsl.exceptions.questions.QuestionScenarioRenderError: Question instructions still has variables: ['X'].
+
+
+        >>> from edsl import QuestionFreeText
+        >>> q = QuestionFreeText(question_text = "You were asked the question '{{ q0.question_text }}'. What is your favorite color?", question_name = "q_color")
+        >>> from edsl.agents.InvigilatorBase import InvigilatorBase
+        >>> i = InvigilatorBase.example(question = q)
+        >>> i.question_instructions_prompt
+        Prompt(text=\"""You are being asked the following question: You were asked the question 'Do you like school?'. What is your favorite color?
+        Return a valid JSON formatted like this:
+        {"answer": "<put free text answer here>"}\""")
+
+        >>> from edsl import QuestionFreeText
+        >>> q = QuestionFreeText(question_text = "You stated '{{ q0.answer }}'. What is your favorite color?", question_name = "q_color")
+        >>> from edsl.agents.InvigilatorBase import InvigilatorBase
+        >>> i = InvigilatorBase.example(question = q)
+        >>> i.current_answers = {"q0": "I like school"}
+        >>> i.question_instructions_prompt
+        Prompt(text=\"""You are being asked the following question: You stated 'I like school'. What is your favorite color?
+        Return a valid JSON formatted like this:
+        {"answer": "<put free text answer here>"}\""")
+
+
+        """
+        if not hasattr(self, "_question_instructions_prompt"):
+            question_prompt = self.question.get_instructions(model=self.model.model)
+
+            # TODO: Try to populate the answers in the question object if they are available
+            d = self.survey.question_names_to_questions()
+            for question, answer in self.current_answers.items():
+                if question in d:
+                    d[question].answer = answer
+                else:
+                    # adds a comment to the question
+                    if (new_question := question.split("_comment")[0]) in d:
+                        d[new_question].comment = answer
+         
+            rendered_instructions = question_prompt.render(self.question.data | self.scenario | d | {'agent': self.agent})
+
+            undefined_template_variables = (
+                rendered_instructions.undefined_template_variables({})
+            )
+
+            # Check if it's the name of a question in the survey
+            for question_name in self.survey.question_names:
+                if question_name in undefined_template_variables:
+                    print(
+                        "Question name found in undefined_template_variables: ",
+                        question_name,
+                    )
+
+            if undefined_template_variables:
+                print(undefined_template_variables)
+                raise QuestionScenarioRenderError(
+                    f"Question instructions still has variables: {undefined_template_variables}."
+                )
+
+            self._question_instructions_prompt = rendered_instructions
+        return self._question_instructions_prompt
+
+    @property
+    def prior_question_memory_prompt(self) -> Prompt:
+        if not hasattr(self, "_prior_question_memory_prompt"):
+            from edsl.prompts.Prompt import Prompt
+
+            memory_prompt = Prompt(text="")
+            if self.memory_plan is not None:
+                memory_prompt += self.create_memory_prompt(
+                    self.question.question_name
+                ).render(self.scenario)
+            self._prior_question_memory_prompt = memory_prompt
+        return self._prior_question_memory_prompt
+
+    def construct_system_prompt(self) -> Prompt:
+        """Construct the system prompt for the LLM call."""
+        import warnings
+
+        warnings.warn(
+            "This method is deprecated. Use get_prompts instead.", DeprecationWarning
+        )
+        return self.get_prompts()["system_prompt"]
+
+    def construct_user_prompt(self) -> Prompt:
+        """Construct the user prompt for the LLM call."""
+        import warnings
+
+        warnings.warn(
+            "This method is deprecated. Use get_prompts instead.", DeprecationWarning
+        )
+        return self.get_prompts()["user_prompt"]
+
+    def get_prompts(self) -> Dict[str, Prompt]:
+        """Get both prompts for the LLM call.
+
+        >>> from edsl import QuestionFreeText
+        >>> from edsl.agents.InvigilatorBase import InvigilatorBase
+        >>> q = QuestionFreeText(question_text="How are you today?", question_name="q0")
+        >>> i = InvigilatorBase.example(question = q)
+        >>> i.get_prompts()
+        {'user_prompt': ..., 'system_prompt': ...}
+        >>> scenario = i._get_scenario_with_image()
+        >>> scenario.has_image
+        True
+        >>> q = QuestionFreeText(question_text="How are you today?", question_name="q0")
+        >>> i = InvigilatorBase.example(question = q, scenario = scenario)
+        >>> i.get_prompts()
+        {'user_prompt': ..., 'system_prompt': ..., 'encoded_image': ...'}
+        """
+        prompts = self.prompt_plan.get_prompts(
+            agent_instructions=self.agent_instructions_prompt,
+            agent_persona=self.agent_persona_prompt,
+            question_instructions=self.question_instructions_prompt,
+            prior_question_memory=self.prior_question_memory_prompt,
+        )
+
+        if hasattr(self.scenario, "has_image") and self.scenario.has_image:
+            prompts["encoded_image"] = self.scenario["encoded_image"]
+        return prompts
+
+    def _get_scenario_with_image(self) -> Dict[str, Any]:
+        """This is a helper function to get a scenario with an image, for testing purposes."""
+        from edsl import Scenario
+
+        try:
+            scenario = Scenario.from_image("../../static/logo.png")
+        except FileNotFoundError:
+            scenario = Scenario.from_image("static/logo.png")
+        return scenario
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod(optionflags=doctest.ELLIPSIS)