edsl 0.1.29.dev3__py3-none-any.whl → 0.1.30__py3-none-any.whl

edsl/surveys/MemoryPlan.py

@@ -3,9 +3,9 @@
 from collections import UserDict, defaultdict
 from typing import Optional
 
-from edsl.surveys.Memory import Memory
-from edsl.prompts.Prompt import Prompt
-from edsl.surveys.DAG import DAG
+# from edsl.surveys.Memory import Memory
+# from edsl.prompts.Prompt import Prompt
+# from edsl.surveys.DAG import DAG
 
 
 class MemoryPlan(UserDict):
@@ -61,6 +61,8 @@ class MemoryPlan(UserDict):
         :param answers: A dictionary of question names to answers.
 
         """
+        from edsl.prompts.Prompt import Prompt
+
         self._check_valid_question_name(focal_question)
 
         if focal_question not in self:
@@ -121,6 +123,7 @@ class MemoryPlan(UserDict):
         self._check_valid_question_name(focal_question)
         self._check_valid_question_name(prior_question)
         self._check_order(focal_question, prior_question)
+        from edsl.surveys.Memory import Memory
 
         if focal_question not in self:
             memory = Memory()
@@ -160,6 +163,8 @@ class MemoryPlan(UserDict):
     @classmethod
     def from_dict(cls, data) -> "MemoryPlan":
         """Deserialize a memory plan from a dictionary."""
+        from edsl.surveys.Memory import Memory
+
         newdata = {}
         for question_name, memory in data["data"].items():
             newdata[question_name] = Memory.from_dict(memory)
@@ -182,13 +187,15 @@ class MemoryPlan(UserDict):
         return new_d
 
     @property
-    def dag(self) -> DAG:
+    def dag(self) -> "DAG":
         """Return a directed acyclic graph of the memory plan.
 
         >>> mp = MemoryPlan.example()
         >>> mp.dag
         {1: {0}}
         """
+        from edsl.surveys.DAG import DAG
+
         d = defaultdict(set)
         for focal_question, memory in self.items():
             for prior_question in memory:

edsl/surveys/Survey.py

@@ -2,26 +2,20 @@
 
 from __future__ import annotations
 import re
-
 from typing import Any, Generator, Optional, Union, List, Literal, Callable
-
-from rich import print
-from rich.table import Table
-
+from uuid import uuid4
+from edsl.Base import Base
 from edsl.exceptions import SurveyCreationError, SurveyHasNoRulesError
 from edsl.questions.QuestionBase import QuestionBase
 from edsl.surveys.base import RulePriority, EndOfSurvey
+from edsl.surveys.DAG import DAG
+from edsl.surveys.descriptors import QuestionsDescriptor
+from edsl.surveys.MemoryPlan import MemoryPlan
 from edsl.surveys.Rule import Rule
 from edsl.surveys.RuleCollection import RuleCollection
-
-from edsl.Base import Base
 from edsl.surveys.SurveyExportMixin import SurveyExportMixin
-from edsl.surveys.descriptors import QuestionsDescriptor
-from edsl.surveys.MemoryPlan import MemoryPlan
-from edsl.surveys.DAG import DAG
-from edsl.utilities import is_notebook
-from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
 from edsl.surveys.SurveyFlowVisualizationMixin import SurveyFlowVisualizationMixin
+from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
 
 
 class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
@@ -96,6 +90,10 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         index = self.question_name_to_index[question_name]
         return self._questions[index]
 
+    def question_names_to_questions(self) -> dict:
+        """Return a dictionary mapping question names to question attributes."""
+        return {q.question_name: q for q in self.questions}
+
     def get_question(self, question_name: str) -> QuestionBase:
         """Return the question object given the question name."""
         # import warnings
@@ -108,10 +106,47 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
 
         return dict_hash(self._to_dict())
 
+    def __add__(self, other: Survey) -> Survey:
+        """Combine two surveys.
+
+        :param other: The other survey to combine with this one.
+        >>> s1 = Survey.example()
+        >>> from edsl import QuestionFreeText
+        >>> s2 = Survey([QuestionFreeText(question_text="What is your name?", question_name="yo")])
+        >>> s3 = s1 + s2
+        Traceback (most recent call last):
+        ...
+        ValueError: ('Cannot combine two surveys with non-default rules.', "Please use the 'clear_non_default_rules' method to remove non-default rules from the survey.")
+        >>> s3 = s1.clear_non_default_rules() + s2
+        >>> len(s3.questions)
+        4
+
+        """
+        if (
+            len(self.rule_collection.non_default_rules) > 0
+            or len(other.rule_collection.non_default_rules) > 0
+        ):
+            raise ValueError(
+                "Cannot combine two surveys with non-default rules.",
+                "Please use the 'clear_non_default_rules' method to remove non-default rules from the survey.",
+            )
+
+        return Survey(questions=self.questions + other.questions)
+
+    def clear_non_default_rules(self) -> Survey:
+        s = Survey()
+        for question in self.questions:
+            s.add_question(question)
+        return s
+
     @property
     def parameters(self):
         return set.union(*[q.parameters for q in self.questions])
 
+    @property
+    def parameters_by_question(self):
+        return {q.question_name: q.parameters for q in self.questions}
+
     @property
     def question_names(self) -> list[str]:
         """Return a list of question names in the survey.
@@ -555,6 +590,12 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         job = Jobs(survey=self)
         return job.by(*args)
 
+    def to_jobs(self):
+        """Convert the survey to a Jobs object."""
+        from edsl.jobs.Jobs import Jobs
+
+        return Jobs(survey=self)
+
     def run(self, *args, **kwargs) -> "Results":
         """Turn the survey into a Job and runs it.
 
@@ -732,6 +773,22 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         except IndexError:
             raise
 
+    @property
+    def piping_dag(self) -> DAG:
+        d = {}
+        for question_name, depenencies in self.parameters_by_question.items():
+            if depenencies:
+                question_index = self.question_name_to_index[question_name]
+                for dependency in depenencies:
+                    if dependency not in self.question_name_to_index:
+                        pass
+                    else:
+                        dependency_index = self.question_name_to_index[dependency]
+                        if question_index not in d:
+                            d[question_index] = set()
+                        d[question_index].add(dependency_index)
+        return d
+
     def dag(self, textify: bool = False) -> DAG:
         """Return the DAG of the survey, which reflects both skip-logic and memory.
 
@@ -745,10 +802,12 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         """
         memory_dag = self.memory_plan.dag
         rule_dag = self.rule_collection.dag
+        piping_dag = self.piping_dag
         if textify:
             memory_dag = DAG(self.textify(memory_dag))
             rule_dag = DAG(self.textify(rule_dag))
-        return memory_dag + rule_dag
+            piping_dag = DAG(self.textify(piping_dag))
+        return memory_dag + rule_dag + piping_dag
 
     ###################
     # DUNDER METHODS
@@ -931,6 +990,8 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         │ └───────────────┴─────────────────┴───────────────┴──────────────────────────────────────────────┘ │
         └────────────────────────────────────────────────────────────────────────────────────────────────────┘
         """
+        from rich.table import Table
+
         table = Table(show_header=True, header_style="bold magenta")
         table.add_column("Questions", style="dim")
 
@@ -994,7 +1055,7 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         return res
 
     @classmethod
-    def example(cls) -> Survey:
+    def example(cls, params: bool = False, randomize: bool = False) -> Survey:
         """Return an example survey.
 
         >>> s = Survey.example()
@@ -1003,8 +1064,9 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
         """
         from edsl.questions.QuestionMultipleChoice import QuestionMultipleChoice
 
+        addition = "" if not randomize else str(uuid4())
         q0 = QuestionMultipleChoice(
-            question_text="Do you like school?",
+            question_text=f"Do you like school?{addition}",
             question_options=["yes", "no"],
             question_name="q0",
         )
@@ -1018,12 +1080,20 @@ class Survey(SurveyExportMixin, SurveyFlowVisualizationMixin, Base):
             question_options=["**lack*** of killer bees in cafeteria", "other"],
             question_name="q2",
         )
+        if params:
+            q3 = QuestionMultipleChoice(
+                question_text="To the question '{{ q0.question_text}}', you said '{{ q0.answer }}'. Do you still feel this way?",
+                question_options=["yes", "no"],
+                question_name="q3",
+            )
+            s = cls(questions=[q0, q1, q2, q3])
+            return s
         s = cls(questions=[q0, q1, q2])
         s = s.add_rule(q0, "q0 == 'yes'", q2)
         return s
 
     def get_job(self, model=None, agent=None, **kwargs):
-        if not model:
+        if model is None:
             from edsl import Model
 
             model = Model()
@@ -1114,4 +1184,5 @@ def main():
 if __name__ == "__main__":
     import doctest
 
-    doctest.testmod(optionflags=doctest.ELLIPSIS | doctest.SKIP)
+    # doctest.testmod(optionflags=doctest.ELLIPSIS | doctest.SKIP)
+    doctest.testmod(optionflags=doctest.ELLIPSIS)

edsl/surveys/SurveyExportMixin.py

@@ -1,8 +1,6 @@
 """A mixin class for exporting surveys to different formats."""
 
-from docx import Document
 from typing import Union, Optional
-import black
 
 
 class SurveyExportMixin:
@@ -29,6 +27,8 @@ class SurveyExportMixin:
 
     def docx(self, filename=None) -> Union["Document", None]:
         """Generate a docx document for the survey."""
+        from docx import Document
+
         doc = Document()
         doc.add_heading("EDSL Survey")
         doc.add_paragraph(f"\n")
@@ -83,6 +83,8 @@ class SurveyExportMixin:
         survey = Survey(questions=[q0, q1, q2])
         ...
         """
+        import black
+
         header_lines = ["from edsl.surveys.Survey import Survey"]
         header_lines.append("from edsl import Question")
         lines = ["\n".join(header_lines)]

edsl/surveys/SurveyFlowVisualizationMixin.py

@@ -1,10 +1,7 @@
 """A mixin for visualizing the flow of a survey."""
 
-import pydot
-import tempfile
-from IPython.display import Image
-from edsl.utilities import is_notebook
 from edsl.surveys.base import RulePriority, EndOfSurvey
+import tempfile
 
 
 class SurveyFlowVisualizationMixin:
@@ -13,6 +10,8 @@ class SurveyFlowVisualizationMixin:
     def show_flow(self, filename: str = None):
         """Create an image showing the flow of users through the survey."""
         # Create a graph object
+        import pydot
+
         graph = pydot.Dot(graph_type="digraph")
 
         # Add nodes for each question
@@ -101,8 +100,11 @@ class SurveyFlowVisualizationMixin:
                         on Ubuntu.
                     """
                 )
+            from edsl.utilities.utilities import is_notebook
 
             if is_notebook():
+                from IPython.display import Image
+
                 display(Image(tmp_file.name))
             else:
                 import os

edsl/tools/plotting.py

@@ -93,8 +93,10 @@ def theme_plot(results, field, context, themes=None, progress_bar=False):
           SELECT json_each.value AS theme 
           FROM self, 
           json_each({ field }_themes)
-          ) GROUP BY theme
-          ORDER BY mentions DESC
+          ) 
+    GROUP BY theme
+    HAVING theme <> 'Other'
+    ORDER BY mentions DESC
              """
     themes = results.sql(themes_query, to_list=True)
 

edsl/utilities/__init__.py

@@ -1,22 +1,22 @@
-from edsl.utilities.interface import (
-    print_dict_as_html_table,
-    print_dict_with_rich,
-    print_list_of_dicts_as_html_table,
-    print_table_with_rich,
-    print_public_methods_with_doc,
-    print_list_of_dicts_as_markdown_table,
-)
+# from edsl.utilities.interface import (
+#     print_dict_as_html_table,
+#     print_dict_with_rich,
+#     print_list_of_dicts_as_html_table,
+#     print_table_with_rich,
+#     print_public_methods_with_doc,
+#     print_list_of_dicts_as_markdown_table,
+# )
 
-from edsl.utilities.utilities import (
-    create_valid_var_name,
-    dict_to_html,
-    hash_value,
-    HTMLSnippet,
-    is_notebook,
-    is_gzipped,
-    is_valid_variable_name,
-    random_string,
-    repair_json,
-    shorten_string,
-    time_all_functions,
-)
+# from edsl.utilities.utilities import (
+#     create_valid_var_name,
+#     dict_to_html,
+#     hash_value,
+#     HTMLSnippet,
+#     is_notebook,
+#     is_gzipped,
+#     is_valid_variable_name,
+#     random_string,
+#     repair_json,
+#     shorten_string,
+#     time_all_functions,
+# )

edsl/utilities/interface.py

@@ -1,12 +1,45 @@
 """A module for displaying data in various formats."""
 
 from html import escape
-from IPython.display import HTML
-from IPython.display import display as ipython_diplay
 
-# from PIL import Image, ImageDraw, ImageFont
-from rich.console import Console
-from rich.table import Table
+
+def create_image(console, image_filename):
+    """Create an image from the console output."""
+    font_size = 15
+    from PIL import Image, ImageDraw, ImageFont
+
+    text = console.export_text()  # Get the console output as text.
+
+    # Create an image from the text
+    font_size = 15
+    font = ImageFont.load_default()  # Use the default font to avoid file path issues.
+    # text_width, text_height = ImageDraw.Draw(
+    #    Image.new("RGB", (100, 100))
+    # ).multiline_textsize(text, font=font)
+    text_width, text_height = get_multiline_textsize(text, font)
+    image = Image.new(
+        "RGB", (text_width + 20, text_height + 20), color=(255, 255, 255)
+    )  # Add some padding
+    d = ImageDraw.Draw(image)
+
+    # Draw text to image
+    d.multiline_text((10, 10), text, font=font, fill=(0, 0, 0))
+    # Save the image
+    image.save(image_filename)
+
+
+def display_table(console, table, filename):
+    # from rich.console import Console
+    # from rich.table import Table
+    """Display the table using the rich library and save it to a file if a filename is provided."""
+    if filename is not None:
+        with open(filename, "w") as f:
+            with console.capture() as capture:
+                console.print(table)
+            f.write(capture.get())
+        create_image(console, filename + ".png")
+    else:
+        console.print(table)
 
 
 def gen_html_sandwich(html_inner, interactive=False):
@@ -133,43 +166,10 @@ def get_multiline_textsize(text, font):
     return max_width, total_height
 
 
-# def create_image(console, image_filename):
-#     """Create an image from the console output."""
-#     font_size = 15
-
-#     text = console.export_text()  # Get the console output as text.
-
-#     # Create an image from the text
-#     font_size = 15
-#     font = ImageFont.load_default()  # Use the default font to avoid file path issues.
-#     # text_width, text_height = ImageDraw.Draw(
-#     #    Image.new("RGB", (100, 100))
-#     # ).multiline_textsize(text, font=font)
-#     text_width, text_height = get_multiline_textsize(text, font)
-#     image = Image.new(
-#         "RGB", (text_width + 20, text_height + 20), color=(255, 255, 255)
-#     )  # Add some padding
-#     d = ImageDraw.Draw(image)
-
-#     # Draw text to image
-#     d.multiline_text((10, 10), text, font=font, fill=(0, 0, 0))
-#     # Save the image
-#     image.save(image_filename)
-
-
-def display(console, table, filename):
-    """Display the table using the rich library and save it to a file if a filename is provided."""
-    if filename is not None:
-        with open(filename, "w") as f:
-            with console.capture() as capture:
-                console.print(table)
-            f.write(capture.get())
-        create_image(console, filename + ".png")
-    else:
-        console.print(table)
-
-
 def print_results_long(results, max_rows=None):
+    from rich.console import Console
+    from rich.table import Table
+
     console = Console(record=True)
     table = Table(show_header=True, header_style="bold magenta")
     table.add_column("Result index", style="dim")
@@ -199,6 +199,9 @@ def print_dict_with_rich(d, key_name="Key", value_name="Value", filename=None):
     │ c   │ 3     │
     └─────┴───────┘
     """
+    from rich.console import Console
+    from rich.table import Table
+
     console = Console(record=True)
     table = Table(show_header=True, header_style="bold magenta")
     table.add_column(key_name, style="dim")
@@ -206,7 +209,7 @@ def print_dict_with_rich(d, key_name="Key", value_name="Value", filename=None):
     for key, value in d.items():
         table.add_row(key, str(value))
     console.print(table)
-    # display(console, table, filename)
+    # display_table(console, table, filename)
 
 
 def print_dict_as_html_table(
@@ -251,6 +254,9 @@ def print_dict_as_html_table(
 
 
 def print_scenario_list(data):
+    from rich.console import Console
+    from rich.table import Table
+
     new_data = []
     for obs in data:
         try:
@@ -300,6 +306,9 @@ def print_dataset_with_rich(data, filename=None, split_at_dot=True):
     │ 3 │ 6 │
     └───┴───┘
     """
+    from rich.console import Console
+    from rich.table import Table
+
     console = Console(record=True)
 
     # Create a table object
@@ -321,7 +330,7 @@ def print_dataset_with_rich(data, filename=None, split_at_dot=True):
         table.add_row(*row)
 
     console.print(table)
-    # display(console, table, filename)
+    # display_table(console, table, filename)
 
 
 def create_latex_table_from_data(data, filename=None, split_at_dot=True):
@@ -495,6 +504,9 @@ def print_list_of_dicts_as_markdown_table(data, filename=None):
 
 def print_public_methods_with_doc(obj):
     """Print the public methods of an object along with their docstrings."""
+    from rich.console import Console
+    from rich.table import Table
+
     console = Console()
     public_methods_with_docstrings = [
         (method, getattr(obj, method).__doc__)
@@ -525,6 +537,10 @@ def print_tally_with_rich(data, filename=None):
     └───────┴───────┘
     """
     # Initialize a console object
+    from rich.console import Console
+    from rich.table import Table
+    from IPython.display import display
+
     console = Console(record=True)
 
     # Create a new table
@@ -538,7 +554,9 @@ def print_tally_with_rich(data, filename=None):
     for key, value in data.items():
         table.add_row(key, str(value))
 
-    display(console, table, filename)
+    from IPython.display import display
+
+    display_table(console, table, filename)
 
 
 def print_table_with_rich(data, filename=None):
@@ -561,6 +579,9 @@ def print_table_with_rich(data, filename=None):
     │ 2 │ 9 │ 8 │
     └───┴───┴───┘
     """
+    from rich.console import Console
+    from rich.table import Table
+
     # Initialize a console object - expects a list of dictionaries
     console = Console(record=True)
 
@@ -580,7 +601,7 @@ def print_table_with_rich(data, filename=None):
     for row in data:
         table.add_row(*[str(value) for value in row.values()])
 
-    display(console, table, filename)
+    display_table(console, table, filename)
 
 
 if __name__ == "__main__":

edsl/utilities/utilities.py

@@ -1,5 +1,9 @@
 """Utility functions for working with strings, dictionaries, and files."""
 
+from functools import wraps
+import types
+import time
+
 import hashlib
 import json
 import keyword
@@ -11,18 +15,10 @@ import tempfile
 import gzip
 import webbrowser
 import json
+
 from html import escape
 from typing import Callable, Union
 
-from pygments import highlight
-from pygments.lexers import JsonLexer
-from pygments.formatters import HtmlFormatter
-from IPython.display import HTML
-
-from functools import wraps
-import types
-import time
-
 
 def time_it(func):
     @wraps(func)
@@ -52,10 +48,6 @@ def dict_hash(data: dict):
     )
 
 
-import re
-import json
-
-
 def extract_json_from_string(text):
     pattern = re.compile(r"\{.*?\}")
     match = pattern.search(text)
@@ -96,6 +88,11 @@ def data_to_html(data, replace_new_lines=False):
     if "edsl_class_name" in data:
         _ = data.pop("edsl_class_name")
 
+    from pygments import highlight
+    from pygments.lexers import JsonLexer
+    from pygments.formatters import HtmlFormatter
+    from IPython.display import HTML
+
     json_str = json.dumps(data, indent=4)
     formatted_json = highlight(
         json_str,
@@ -104,6 +101,7 @@ def data_to_html(data, replace_new_lines=False):
     )
     if replace_new_lines:
         formatted_json = formatted_json.replace("\\n", "<br>")
+
     return HTML(formatted_json).data
 
 

{edsl-0.1.29.dev3.dist-info → edsl-0.1.30.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edsl
-Version: 0.1.29.dev3
+Version: 0.1.30
 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).
+