edsl 0.1.14__py3-none-any.whl → 0.1.40__py3-none-any.whl

edsl/data/crud.py

@@ -1,121 +0,0 @@
-from sqlalchemy import desc
-from typing import Union
-from edsl.data import Database, database, LLMOutputDataDB
-from edsl.data.orm import ResultDB
-
-
-class CRUDOperations:
-    """
-    A class that implementes CRUD operations for the EDSL package.
-
-    Initalization:
-    - `database`: A Database object.
-
-    Methods:
-    - `get_LLMOutputData(model, parameters, system_prompt, prompt)`: Retrieves a cached LLM output from the database.
-    - `write_LLMOutputData(model, parameters, system_prompt, prompt, output)`: Writes an LLM output to the database.
-    """
-
-    def __init__(self, database: Database) -> None:
-        self.database = database
-
-    def get_LLMOutputData(
-        self, model: str, parameters: str, system_prompt: str, prompt: str
-    ) -> Union[str, None]:
-        """
-        Retrieves a cached LLM output from the database. Arguments: in string format, the model, parameters, system_prompt, and prompt used to generate the output. Returns the output (json string) if it exists, otherwise None.
-        """
-        with self.database.get_db() as db:
-            record = (
-                db.query(LLMOutputDataDB)
-                .filter_by(
-                    prompt=prompt,
-                    system_prompt=system_prompt,
-                    model=model,
-                    parameters=parameters,
-                )
-                .order_by(desc(LLMOutputDataDB.id))
-                .first()
-            )
-        return record.output if record else None
-
-    def write_LLMOutputData(
-        self, model: str, parameters: str, system_prompt: str, prompt: str, output: str
-    ) -> None:
-        """
-        Writes an LLM output to the database. Arguments: in string format, the model, parameters, system_prompt, prompt, and the generated output.
-        """
-        record = LLMOutputDataDB(
-            model=model,
-            parameters=parameters,
-            system_prompt=system_prompt,
-            prompt=prompt,
-            output=output,
-        )
-
-        with self.database.get_db() as db:
-            db.add(record)
-            db.commit()
-
-    def clear_LLMOutputData(self) -> None:
-        """
-        Clears all LLM output data from the database.
-        """
-        with self.database.get_db() as db:
-            db.query(LLMOutputDataDB).delete()
-            db.commit()
-
-    def get_all_LLMOutputData(self) -> list:
-        """
-        Retrieves all LLM output data from the database and returns them as a list of dictionaries.
-        """
-        with self.database.get_db() as db:
-            records = db.query(LLMOutputDataDB).all()
-            return [
-                {
-                    "id": record.id,
-                    "model": record.model,
-                    "parameters": record.parameters,
-                    "system_prompt": record.system_prompt,
-                    "prompt": record.prompt,
-                    "output": record.output,
-                }
-                for record in records
-            ]
-
-    def write_result(
-        self,
-        job_uuid: str,
-        result_uuid: str,
-        agent: str,
-        scenario: str,
-        model: str,
-        answer: str,
-    ) -> None:
-        """Writes a Result record to the database."""
-        record = ResultDB(
-            job_uuid=job_uuid,
-            result_uuid=result_uuid,
-            agent=agent,
-            scenario=scenario,
-            model=model,
-            answer=answer,
-        )
-
-        with self.database.get_db() as db:
-            db.add(record)
-            db.commit()
-
-    def read_results(self, job_uuid: str) -> list[ResultDB]:
-        """Reads all Result records associated with job_uuid from the database."""
-        with self.database.get_db() as db:
-            records = (
-                db.query(ResultDB)
-                .filter_by(job_uuid=job_uuid)
-                .order_by(desc(ResultDB.id))
-                .all()
-            )
-        return records
-
-
-CRUD = CRUDOperations(database)

edsl/jobs/Interview.py

@@ -1,417 +0,0 @@
-from __future__ import annotations
-import asyncio
-import logging
-import textwrap
-from collections import UserList
-from typing import Any, Type, List, Generator, Callable, List
-from collections import defaultdict
-
-from edsl import CONFIG
-from edsl.agents import Agent
-from edsl.exceptions import InterviewErrorPriorTaskCanceled, InterviewTimeoutError
-from edsl.language_models import LanguageModel
-from edsl.questions import Question
-from edsl.scenarios import Scenario
-from edsl.surveys import Survey
-from edsl.utilities.decorators import sync_wrapper
-from edsl.data_transfer_models import AgentResponseDict
-from edsl.jobs.Answers import Answers
-
-from edsl.surveys.base import EndOfSurvey
-
-from edsl.jobs.buckets import ModelBuckets
-from edsl.jobs.token_tracking import TokenUsage, InterviewTokenUsage
-
-from edsl.jobs.task_management import (
-    InterviewStatusDictionary,
-    QuestionTaskCreator,
-    TasksList,
-)
-
-import traceback
-
-# create logger
-logger = logging.getLogger(__name__)
-logger.setLevel(logging.INFO)
-logger.propagate = False
-# create  file handler
-fh = logging.FileHandler(CONFIG.get("EDSL_LOGGING_PATH"))
-fh.setLevel(logging.INFO)
-# add formatter to the handlers
-formatter = logging.Formatter(
-    "%(asctime)s - %(name)s - %(levelname)s - %(module)s:%(lineno)d - %(funcName)s - %(message)s"
-)
-fh.setFormatter(formatter)
-# add handler to logger
-logger.addHandler(fh)
-
-# start loggin'
-logger.info("Interview.py loaded")
-
-TIMEOUT = float(CONFIG.get("API_CALL_TIMEOUT_SEC"))
-
-
-class Interview:
-    """
-    A class that has an Agent answer Survey Questions with a particular Scenario and using a LanguageModel.
-    """
-
-    def __init__(
-        self,
-        agent: Agent,
-        survey: Survey,
-        scenario: Scenario,
-        model: Type[LanguageModel],
-        verbose: bool = False,
-        debug: bool = False,
-    ):
-        self.agent = agent
-        self.survey = survey
-        self.scenario = scenario
-        self.model = model
-        self.debug = debug
-        self.verbose = verbose
-        self.answers: dict[str, str] = Answers()  # will get filled in
-
-        self.dag = self.survey.dag(textify=True)
-        self.to_index = {
-            name: index for index, name in enumerate(self.survey.question_names)
-        }
-
-        logger.info(f"Interview instantiated")
-        self.task_creators = {}
-
-    @property
-    def token_usage(self) -> InterviewTokenUsage:
-        "Determins how many tokens were used for the interview."
-        cached_tokens = TokenUsage(from_cache=True)
-        new_tokens = TokenUsage(from_cache=False)
-        for task_creator in self.task_creators.values():
-            token_usage = task_creator.token_usage()
-            cached_tokens += token_usage["cached_tokens"]
-            new_tokens += token_usage["new_tokens"]
-        return InterviewTokenUsage(
-            new_token_usage=new_tokens, cached_token_usage=cached_tokens
-        )
-
-    @property
-    def interview_status(self) -> InterviewStatusDictionary:
-        """Returns a dictionary mapping task status codes to counts"""
-        status_dict = InterviewStatusDictionary()
-        for task_creator in self.task_creators.values():
-            status_dict[task_creator.task_status] += 1
-            status_dict["number_from_cache"] += task_creator.from_cache
-        return status_dict
-
-    async def async_conduct_interview(
-        self,
-        model_buckets: ModelBuckets,
-        debug: bool = False,
-        replace_missing: bool = True,
-    ) -> tuple["Answers", List[dict[str, Any]]]:
-        """
-        Conducts an 'interview' asynchronously.
-        """
-
-        # we create both tasks and invigilators lists.
-        # this is because it's easier to extract info
-        # we need from the invigilators list when a task fails.
-        # it's challenging to get info from failed asyncio tasks.
-        self.tasks, self.invigilators = self._build_question_tasks(
-            debug=debug, model_buckets=model_buckets
-        )
-
-        await asyncio.gather(*self.tasks, return_exceptions=not debug)
-
-        if replace_missing:
-            self.answers.replace_missing_answers_with_none(self.survey)
-
-        valid_results = list(self._extract_valid_results(self.tasks, self.invigilators))
-
-        return self.answers, valid_results
-
-    def _extract_valid_results(
-        self, tasks, invigialtors
-    ) -> Generator["Answers", None, None]:
-        """Extracts the valid results from the list of results."""
-
-        # we only need to print the warning once if a task failed.
-        warning_printed = False
-        warning_header = textwrap.dedent(
-            """\
-            WARNING: At least one question in the survey was not answered.
-            """
-        )
-        # there should be one one invigilator for each task
-        assert len(self.tasks) == len(self.invigilators)
-
-        for task, invigilator in zip(self.tasks, self.invigilators):
-            logger.info(f"Iterating through task: {task}")
-            if task.done():
-                try:
-                    result = task.result()
-                except asyncio.CancelledError:
-                    logger.info(f"Task `{task.edsl_name}` was cancelled.")
-                    result = invigilator.get_failed_task_result()
-                except Exception as exception:
-                    if not warning_printed:
-                        warning_printed = True
-                        print(warning_header)
-
-                    error_message = f"Task `{task.edsl_name}` failed with `{exception.__class__.__name__}`:`{exception}`."
-                    logger.error(error_message)
-                    print(error_message)
-                    traceback.print_exc()
-                    # if task failed, we use the invigilator to get the failed task result
-                    result = invigilator.get_failed_task_result()
-                else:
-                    # No exception means the task completed successfully
-                    pass
-
-                yield result
-
-    def _build_question_tasks(self, debug, model_buckets) -> List[asyncio.Task]:
-        """Creates a task for each question, with dependencies on the questions that must be answered before this one can be answered."""
-        logger.info("Creating tasks for each question")
-        tasks = []
-        invigilators = []
-        for question in self.survey.questions:
-            # finds dependency tasks for that question
-            tasks_that_must_be_completed_before = (
-                self._get_tasks_that_must_be_completed_before(tasks, question)
-            )
-            # creates the task for that question
-            question_task = self._create_question_task(
-                question=question,
-                tasks_that_must_be_completed_before=tasks_that_must_be_completed_before,
-                model_buckets=model_buckets,
-                debug=debug,
-            )
-            # adds the task to the list of tasks
-            tasks.append(question_task)
-            invigilators.append(self.get_invigilator(question, debug))
-        return TasksList(tasks), invigilators
-
-    def _get_tasks_that_must_be_completed_before(
-        self, tasks, question
-    ) -> List[asyncio.Task]:
-        """Returns the tasks that must be completed before the given question can be answered.
-        If a question has no dependencies, this will be an empty list, [].
-        """
-        parents_of_focal_question: List[str] = self.dag.get(question.question_name, [])
-        return [
-            tasks[self.to_index[parent_question_name]]
-            for parent_question_name in parents_of_focal_question
-        ]
-
-    def _create_question_task(
-        self,
-        question: Question,
-        tasks_that_must_be_completed_before: List[asyncio.Task],
-        model_buckets: ModelBuckets,
-        debug,
-    ):
-        """Creates a task that depends on the passed-in dependencies that are awaited before the task is run."""
-        task_creator = QuestionTaskCreator(
-            question=question,
-            answer_question_func=self._answer_question_and_record_task,
-            token_estimator=self._get_estimated_request_tokens,
-            model_buckets=model_buckets,
-        )
-        [task_creator.add_dependency(x) for x in tasks_that_must_be_completed_before]
-        self.task_creators[question.question_name] = task_creator
-        return task_creator.generate_task(debug)
-
-    def async_timeout_handler(timeout):
-        def decorator(func):
-            async def wrapper(*args, **kwargs):
-                try:
-                    return await asyncio.wait_for(func(*args, **kwargs), timeout)
-                except asyncio.TimeoutError:
-                    raise InterviewTimeoutError(
-                        f"Task timed out after {timeout} seconds."
-                    )
-
-            return wrapper
-
-        return decorator
-
-    def get_invigilator(self, question, debug) -> "Invigilator":
-        invigilator = self.agent.create_invigilator(
-            question=question,
-            scenario=self.scenario,
-            model=self.model,
-            debug=debug,
-            memory_plan=self.survey.memory_plan,
-            current_answers=self.answers,
-        )
-        return invigilator
-
-    def _get_estimated_request_tokens(self, question) -> float:
-        """Estimates the number of tokens that will be required to run the focal task."""
-        invigilator = self.get_invigilator(question, debug=False)
-        # TODO: There should be a way to get a more accurate estimate.
-        combined_text = ""
-        for prompt in invigilator.get_prompts().values():
-            if hasattr(prompt, "text"):
-                combined_text += prompt.text
-            elif isinstance(prompt, str):
-                combined_text += prompt
-            else:
-                raise ValueError(f"Prompt is of type {type(prompt)}")
-        return len(combined_text) / 4.0
-
-    @async_timeout_handler(TIMEOUT)
-    async def _answer_question_and_record_task(
-        self,
-        question,
-        debug,
-    ) -> AgentResponseDict:
-        """Answers a question and records the task.
-        This in turn calls the the passed-in agent's async_answer_question method, which returns a response dictionary.
-        """
-        invigilator = self.get_invigilator(question, debug=debug)
-        response: AgentResponseDict = await invigilator.async_answer_question()
-        # TODO: Move this back into actual agent response dict and enforce it.
-        response["question_name"] = question.question_name
-
-        self.answers.add_answer(response, question)
-
-        self._cancel_skipped_questions(question)
-
-        # TODO: This should be forced to be a data-exchange model to cement attributes.
-        return response
-
-    def _cancel_skipped_questions(self, current_question) -> None:
-        """Cancels the tasks for questions that are skipped."""
-        logger.info(f"Current question is {current_question.question_name}")
-        current_question_index = self.to_index[current_question.question_name]
-        next_question = self.survey.rule_collection.next_question(
-            q_now=current_question_index, answers=self.answers
-        )
-        next_question_index = next_question.next_q
-
-        def cancel_between(start, end):
-            for i in range(start, end):
-                logger.info(
-                    f"Cancelling task for question {i}; {self.tasks[i].edsl_name}"
-                )
-                self.tasks[i].cancel()
-                skipped_question_name = self.survey.question_names[i]
-                logger.info(f"{skipped_question_name} skipped.")
-
-        if next_question_index == EndOfSurvey:
-            cancel_between(current_question_index + 1, len(self.survey.questions))
-            return
-
-        if next_question_index > (current_question_index + 1):
-            cancel_between(current_question_index + 1, next_question_index)
-
-        self.tasks.status()
-
-    #######################
-    # Dunder methods
-    #######################
-    def __repr__(self) -> str:
-        """Returns a string representation of the Interview instance."""
-        return f"Interview(agent = {self.agent}, survey = {self.survey}, scenario = {self.scenario}, model = {self.model})"
-
-
-# def main():
-#     from edsl.language_models import LanguageModelOpenAIThreeFiveTurbo
-#     from edsl.agents import Agent
-#     from edsl.surveys import Survey
-#     from edsl.scenarios import Scenario
-#     from edsl.questions import QuestionMultipleChoice
-
-#     # from edsl.jobs.Interview import Interview
-
-#     #  a survey with skip logic
-#     q0 = QuestionMultipleChoice(
-#         question_text="Do you like school?",
-#         question_options=["yes", "no"],
-#         question_name="q0",
-#     )
-#     q1 = QuestionMultipleChoice(
-#         question_text="Why not?",
-#         question_options=["killer bees in cafeteria", "other"],
-#         question_name="q1",
-#     )
-#     q2 = QuestionMultipleChoice(
-#         question_text="Why?",
-#         question_options=["**lack*** of killer bees in cafeteria", "other"],
-#         question_name="q2",
-#     )
-#     s = Survey(questions=[q0, q1, q2])
-#     s = s.add_rule(q0, "q0 == 'yes'", q2)
-
-#     # create an interview
-#     a = Agent(traits=None)
-
-#     def direct_question_answering_method(self, question, scenario):
-#         return "yes"
-
-#     a.add_direct_question_answering_method(direct_question_answering_method)
-#     scenario = Scenario()
-#     m = LanguageModelOpenAIThreeFiveTurbo(use_cache=False)
-#     I = Interview(agent=a, survey=s, scenario=scenario, model=m)
-
-#     I.conduct_interview()
-#     # # conduct five interviews
-#     # for _ in range(5):
-#     #     I.conduct_interview(debug=True)
-
-#     # # replace missing answers
-#     # I
-#     # repr(I)
-#     # eval(repr(I))
-
-
-if __name__ == "__main__":
-    from edsl.language_models import LanguageModelOpenAIThreeFiveTurbo
-    from edsl.agents import Agent
-    from edsl.surveys import Survey
-    from edsl.scenarios import Scenario
-    from edsl.questions import QuestionMultipleChoice
-
-    # from edsl.jobs.Interview import Interview
-
-    #  a survey with skip logic
-    q0 = QuestionMultipleChoice(
-        question_text="Do you like school?",
-        question_options=["yes", "no"],
-        question_name="q0",
-    )
-    q1 = QuestionMultipleChoice(
-        question_text="Why not?",
-        question_options=["killer bees in cafeteria", "other"],
-        question_name="q1",
-    )
-    q2 = QuestionMultipleChoice(
-        question_text="Why?",
-        question_options=["**lack*** of killer bees in cafeteria", "other"],
-        question_name="q2",
-    )
-    s = Survey(questions=[q0, q1, q2])
-    s = s.add_rule(q0, "q0 == 'yes'", q2)
-
-    # create an interview
-    a = Agent(traits=None)
-
-    def direct_question_answering_method(self, question, scenario):
-        return "yes"
-
-    a.add_direct_question_answering_method(direct_question_answering_method)
-    scenario = Scenario()
-    m = LanguageModelOpenAIThreeFiveTurbo(use_cache=False)
-    I = Interview(agent=a, survey=s, scenario=scenario, model=m)
-
-    I.conduct_interview()
-    # # conduct five interviews
-    # for _ in range(5):
-    #     I.conduct_interview(debug=True)
-
-    # # replace missing answers
-    # I
-    # repr(I)
-    # eval(repr(I))

edsl/jobs/JobsRunner.py

@@ -1,63 +0,0 @@
-from __future__ import annotations
-
-from collections import UserDict
-
-from abc import ABC, ABCMeta, abstractmethod
-from edsl.jobs import Jobs
-from edsl.results import Results
-
-
-class RegisterJobsRunnerMeta(ABCMeta):
-    "Metaclass to register output elements in a registry i.e., those that have a parent"
-    _registry = {}  # Initialize the registry as a dictionary
-
-    def __init__(cls, name, bases, dct):
-        super(RegisterJobsRunnerMeta, cls).__init__(name, bases, dct)
-        if name != "JobsRunner":
-            RegisterJobsRunnerMeta._registry[name] = cls
-
-    @classmethod
-    def get_registered_classes(cls):
-        return cls._registry
-
-    @classmethod
-    def lookup(cls):
-        d = {}
-        for classname, cls in cls._registry.items():
-            if hasattr(cls, "runner_name"):
-                d[cls.runner_name] = cls
-            else:
-                raise Exception(
-                    f"Class {classname} does not have a runner_name attribute"
-                )
-        return d
-
-
-class JobsRunner(ABC, metaclass=RegisterJobsRunnerMeta):
-    """ABC for JobRunners, which take in a job, conduct interviews, and return their results."""
-
-    def __init__(self, jobs: Jobs):
-        self.jobs = jobs
-        # create the interviews here so children can use them
-        self.interviews = jobs.interviews()
-        self.bucket_collection = jobs.bucket_collection
-        # self.bucket_collection = self.jobs.bucket_collection
-        # for model in self.jobs.models:
-        #    self.bucket_collection.add_model(model)
-
-    @abstractmethod
-    def run(
-        self,
-        n: int = 1,
-        debug: bool = False,
-        verbose: bool = False,
-        progress_bar: bool = True,
-    ) -> Results:  # pragma: no cover
-        """
-        Runs the job: conducts Interviews and returns their results.
-        - `n`: how many times to run each interview
-        - `debug`: prints debug messages
-        - `verbose`: prints messages
-        - `progress_bar`: shows a progress bar
-        """
-        raise NotImplementedError