Merge pull request #796 from expectedparrot/af-small-edits

Add randomize arg to example methods - setting us up for coop hash

Author: johnjosephhorton

Diff for: edsl/__version__.py

@@ -1 +1 @@
-__version__ = "0.1.30.dev1"
+__version__ = "0.1.30.dev3"

Diff for: edsl/agents/Agent.py

@@ -4,7 +4,8 @@
 import copy
 import inspect
 import types
-from typing import Any, Callable, Optional, Union, Dict, Sequence
+from typing import Callable, Optional, Union
+from uuid import uuid4
 from edsl.Base import Base
 
 from edsl.exceptions.agents import (
@@ -688,13 +689,14 @@ def rich_print(self):
         return table
 
     @classmethod
-    def example(cls) -> Agent:
-        """Return an example agent.
+    def example(cls, randomize: bool = False) -> Agent:
+        """
+        Returns an example Agent instance.
 
-        >>> Agent.example()
-        Agent(traits = {'age': 22, 'hair': 'brown', 'height': 5.5})
+        :param randomize: If True, adds a random string to the value of an example key.
         """
-        return cls(traits={"age": 22, "hair": "brown", "height": 5.5})
+        addition = "" if not randomize else str(uuid4())
+        return cls(traits={"age": 22, "hair": f"brown{addition}", "height": 5.5})
 
     def code(self) -> str:
         """Return the code for the agent.

Diff for: edsl/agents/AgentList.py

@@ -11,23 +11,15 @@
 """
 
 from __future__ import annotations
+import csv
+import json
 from collections import UserList
-from typing import Optional, Union, Sequence, List, Any
+from typing import Any, List, Optional, Union
 from rich import print_json
 from rich.table import Table
-import json
-import csv
-
-
 from simpleeval import EvalWithCompoundTypes
-
 from edsl.Base import Base
-
-# from edsl.agents import Agent
-from edsl.utilities.decorators import (
-    add_edsl_version,
-    remove_edsl_version,
-)
+from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
 
 
 class AgentList(UserList, Base):
@@ -239,17 +231,15 @@ def from_dict(cls, data: dict) -> "AgentList":
         return cls(agents)
 
     @classmethod
-    def example(cls) -> "AgentList":
-        """Return an example AgentList.
-
-        >>> al = AgentList.example()
-        >>> len(al)
-        2
+    def example(cls, randomize: bool = False) -> AgentList:
+        """
+        Returns an example AgentList instance.
 
+        :param randomize: If True, uses Agent's randomize method.
         """
         from edsl.agents.Agent import Agent
 
-        return cls([Agent.example(), Agent.example()])
+        return cls([Agent.example(randomize), Agent.example(randomize)])
 
     @classmethod
     def from_list(self, trait_name: str, values: List[Any]):

Diff for: edsl/agents/Invigilator.py

@@ -97,7 +97,7 @@ def _format_raw_response(
         answer = question._translate_answer_code_to_answer(
             response["answer"], combined_dict
         )
-        #breakpoint()
+        # breakpoint()
         data = {
             "answer": answer,
             "comment": response.get(

Diff for: edsl/data/Cache.py

@@ -7,17 +7,10 @@
 import os
 import warnings
 from typing import Optional, Union
-import time
-from edsl.config import CONFIG
-from edsl.data.CacheEntry import CacheEntry
-
-# from edsl.data.SQLiteDict import SQLiteDict
 from edsl.Base import Base
+from edsl.data.CacheEntry import CacheEntry
 from edsl.utilities.utilities import dict_hash
-from edsl.utilities.decorators import (
-    add_edsl_version,
-    remove_edsl_version,
-)
+from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
 
 
 class Cache(Base):
@@ -41,7 +34,7 @@ def __init__(
         data: Optional[Union["SQLiteDict", dict]] = None,
         immediate_write: bool = True,
         method=None,
-        verbose = False
+        verbose=False,
     ):
         """
         Create two dictionaries to store the cache data.
@@ -480,12 +473,18 @@ def view(self) -> None:
         webbrowser.open("file://" + filepath)
 
     @classmethod
-    def example(cls) -> Cache:
+    def example(cls, randomize: bool = False) -> Cache:
         """
-        Return an example Cache.
-        The example Cache has one entry.
+        Returns an example Cache instance.
+
+        :param randomize: If True, uses CacheEntry's randomize method.
         """
-        return cls(data={CacheEntry.example().key: CacheEntry.example()})
+        return cls(
+            data={
+                CacheEntry.example(randomize).key: CacheEntry.example(),
+                CacheEntry.example(randomize).key: CacheEntry.example(),
+            }
+        )
 
 
 if __name__ == "__main__":

Diff for: edsl/data/CacheEntry.py

@@ -2,11 +2,8 @@
 import json
 import datetime
 import hashlib
-import random
 from typing import Optional
-
-
-# TODO: Timestamp should probably be float?
+from uuid import uuid4
 
 
 class CacheEntry:
@@ -151,10 +148,12 @@ def __repr__(self) -> str:
     @classmethod
     def example(cls, randomize: bool = False) -> CacheEntry:
         """
-        Returns a CacheEntry example.
+        Returns an example CacheEntry instance.
+
+        :param randomize: If True, adds a random string to the system prompt.
         """
-        # if random, create a random number for 0-100
-        addition = "" if not randomize else str(random.randint(0, 1000))
+        # if random, create a uuid
+        addition = "" if not randomize else str(uuid4())
         return CacheEntry(
             model="gpt-3.5-turbo",
             parameters={"temperature": 0.5},

Diff for: edsl/data_transfer_models.py

@@ -17,7 +17,7 @@ def __init__(
         cached_response=None,
         raw_model_response=None,
         simple_model_raw_response=None,
-        cache_used=None, 
+        cache_used=None,
         cache_key=None,
     ):
         """Initialize the AgentResponseDict object."""

Diff for: edsl/jobs/Jobs.py

@@ -687,7 +687,9 @@ def __eq__(self, other: Jobs) -> bool:
     # Example methods
     #######################
     @classmethod
-    def example(cls, throw_exception_probability=0) -> Jobs:
+    def example(
+        cls, throw_exception_probability: int = 0, randomize: bool = False
+    ) -> Jobs:
         """Return an example Jobs instance.
 
         :param throw_exception_probability: the probability that an exception will be thrown when answering a question. This is useful for testing error handling.
@@ -697,10 +699,13 @@ def example(cls, throw_exception_probability=0) -> Jobs:
 
         """
         import random
+        from uuid import uuid4
         from edsl.questions import QuestionMultipleChoice
         from edsl.agents.Agent import Agent
         from edsl.scenarios.Scenario import Scenario
 
+        addition = "" if not randomize else str(uuid4())
+
         # (status, question, period)
         agent_answers = {
             ("Joyful", "how_feeling", "morning"): "OK",
@@ -743,7 +748,10 @@ def answer_question_directly(self, question, scenario):
         base_survey = Survey(questions=[q1, q2])
 
         scenario_list = ScenarioList(
-            [Scenario({"period": "morning"}), Scenario({"period": "afternoon"})]
+            [
+                Scenario({"period": f"morning{addition}"}),
+                Scenario({"period": "afternoon"}),
+            ]
         )
         job = base_survey.by(scenario_list).by(joy_agent, sad_agent)
 

Diff for: edsl/jobs/buckets/ModelBuckets.py

@@ -24,7 +24,7 @@ def __add__(self, other: "ModelBuckets"):
             requests_bucket=self.requests_bucket + other.requests_bucket,
             tokens_bucket=self.tokens_bucket + other.tokens_bucket,
         )
-    
+
     def turbo_mode_on(self):
         """Set the refill rate to infinity for both buckets."""
         self.requests_bucket.turbo_mode_on()

Diff for: edsl/jobs/buckets/TokenBucket.py

@@ -31,15 +31,15 @@ def turbo_mode_on(self):
             pass
         else:
             self.turbo_mode = True
-            self.capacity=float("inf")
-            self.refill_rate=float("inf")
+            self.capacity = float("inf")
+            self.refill_rate = float("inf")
 
     def turbo_mode_off(self):
         """Restore the refill rate to its original value."""
         self.turbo_mode = False
         self.capacity = self._old_capacity
         self.refill_rate = self._old_refill_rate
-   
+
     def __add__(self, other) -> "TokenBucket":
         """Combine two token buckets.
 

Diff for: edsl/jobs/interviews/Interview.py

@@ -30,14 +30,14 @@ class Interview(InterviewStatusMixin, InterviewTaskBuildingMixin):
 
     def __init__(
         self,
-        agent: 'Agent',
-        survey: 'Survey',
-        scenario: 'Scenario',
-        model: Type['LanguageModel'],
+        agent: "Agent",
+        survey: "Survey",
+        scenario: "Scenario",
+        model: Type["LanguageModel"],
         debug: Optional[bool] = False,
         iteration: int = 0,
         cache: "Cache" = None,
-        sidecar_model: 'LanguageModel' = None,
+        sidecar_model: "LanguageModel" = None,
     ):
         """Initialize the Interview instance.
 

Diff for: edsl/jobs/runners/JobsRunnerAsyncio.py

@@ -89,6 +89,7 @@ def _populate_total_interviews(self, n: int = 1) -> None:
 
     async def run_async(self, cache=None) -> Results:
         from edsl.results.Results import Results
+
         if cache is None:
             self.cache = Cache()
         else:
@@ -100,6 +101,7 @@ async def run_async(self, cache=None) -> Results:
 
     def simple_run(self):
         from edsl.results.Results import Results
+
         data = asyncio.run(self.run_async())
         return Results(survey=self.jobs.survey, data=data)
 

Diff for: edsl/jobs/tasks/QuestionTaskCreator.py

@@ -144,26 +144,25 @@ async def _run_focal_task(self, debug: bool) -> Answers:
             self.task_status = TaskStatus.FAILED
             raise e
 
-        ## This isn't working 
-        #breakpoint()
-        if results.get('cache_used', False):
+        ## This isn't working
+        # breakpoint()
+        if results.get("cache_used", False):
             self.tokens_bucket.add_tokens(requested_tokens)
             self.requests_bucket.add_tokens(1)
             self.from_cache = True
-            #print("Turning on turbo!")
+            # print("Turning on turbo!")
             self.tokens_bucket.turbo_mode_on()
             self.requests_bucket.turbo_mode_on()
         else:
-            #breakpoint()
-            #print("Turning off turbo!")
+            # breakpoint()
+            # print("Turning off turbo!")
             self.tokens_bucket.turbo_mode_off()
             self.requests_bucket.turbo_mode_off()
 
         _ = results.pop("cached_response", None)
 
         tracker = self.cached_token_usage if self.from_cache else self.new_token_usage
 
-
         # TODO: This is hacky. The 'func' call should return an object that definitely has a 'usage' key.
         usage = results.get("usage", {"prompt_tokens": 0, "completion_tokens": 0})
         prompt_tokens = usage.get("prompt_tokens", 0)

Diff for: edsl/notebooks/Notebook.py

@@ -1,14 +1,11 @@
 """A Notebook is a utility class that allows you to easily share/pull ipynbs from Coop."""
 
+from __future__ import annotations
 import json
 from typing import Dict, List, Optional
-
-
+from uuid import uuid4
 from edsl.Base import Base
-from edsl.utilities.decorators import (
-    add_edsl_version,
-    remove_edsl_version,
-)
+from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
 
 
 class Notebook(Base):
@@ -192,10 +189,13 @@ def rich_print(self) -> "Table":
         return table
 
     @classmethod
-    def example(cls) -> "Notebook":
+    def example(cls, randomize: bool = False) -> Notebook:
         """
-        Return an example Notebook.
+        Returns an example Notebook instance.
+
+        :param randomize: If True, adds a random string one of the cells' output.
         """
+        addition = "" if not randomize else str(uuid4())
         cells = [
             {
                 "cell_type": "markdown",
@@ -210,7 +210,7 @@ def example(cls) -> "Notebook":
                     {
                         "name": "stdout",
                         "output_type": "stream",
-                        "text": "Hello world!\n",
+                        "text": f"Hello world!\n{addition}",
                     }
                 ],
                 "source": 'print("Hello world!")',

Diff for: edsl/questions/QuestionFreeText.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 import textwrap
 from typing import Any, Optional
+from uuid import uuid4
 from edsl.questions.QuestionBase import QuestionBase
 
 
@@ -65,9 +66,10 @@ def question_html_content(self) -> str:
         return question_html_content
 
     @classmethod
-    def example(cls) -> QuestionFreeText:
+    def example(cls, randomize: bool = False) -> QuestionFreeText:
         """Return an example instance of a free text question."""
-        return cls(question_name="how_are_you", question_text="How are you?")
+        addition = "" if not randomize else str(uuid4())
+        return cls(question_name="how_are_you", question_text=f"How are you?{addition}")
 
 
 def main():

Diff for: edsl/results/Results.py

@@ -949,7 +949,7 @@ def create_evaluator(result):
         return Results(survey=self.survey, data=new_data, created_columns=None)
 
     @classmethod
-    def example(cls, debug: bool = False) -> Results:
+    def example(cls, debug: bool = False, randomize: bool = False) -> Results:
         """Return an example `Results` object.
 
         Example usage:
@@ -962,7 +962,7 @@ def example(cls, debug: bool = False) -> Results:
         from edsl.data.Cache import Cache
 
         c = Cache()
-        job = Jobs.example()
+        job = Jobs.example(randomize=randomize)
         results = job.run(cache=c, debug=debug)
         return results