edsl 0.1.39__py3-none-any.whl → 0.1.39.dev2__py3-none-any.whl

edsl/jobs/runners/JobsRunnerAsyncio.py

@@ -3,17 +3,31 @@ import time
 import asyncio
 import threading
 import warnings
-from typing import TYPE_CHECKING
+from typing import Coroutine, List, AsyncGenerator, Optional, Union, Generator, Type
+from uuid import UUID
+from collections import UserList
 
 from edsl.results.Results import Results
-from edsl.jobs.runners.JobsRunnerStatus import JobsRunnerStatus
+from edsl.jobs.interviews.Interview import Interview
+from edsl.jobs.runners.JobsRunnerStatus import JobsRunnerStatus, JobsRunnerStatusBase
+
 from edsl.jobs.tasks.TaskHistory import TaskHistory
+from edsl.jobs.buckets.BucketCollection import BucketCollection
 from edsl.utilities.decorators import jupyter_nb_handler
-from edsl.jobs.async_interview_runner import AsyncInterviewRunner
-from edsl.jobs.data_structures import RunEnvironment, RunParameters, RunConfig
+from edsl.data.Cache import Cache
+from edsl.results.Result import Result
+from edsl.results.Results import Results
+from edsl.language_models.LanguageModel import LanguageModel
+from edsl.data.Cache import Cache
+
 
-if TYPE_CHECKING:
-    from edsl.jobs.Jobs import Jobs
+class StatusTracker(UserList):
+    def __init__(self, total_tasks: int):
+        self.total_tasks = total_tasks
+        super().__init__()
+
+    def current_status(self):
+        return print(f"Completed: {len(self.data)} of {self.total_tasks}", end="\r")
 
 
 class JobsRunnerAsyncio:
@@ -23,129 +37,385 @@ class JobsRunnerAsyncio:
     The Jobs object is a collection of interviews that are to be run.
     """
 
-    def __init__(self, jobs: "Jobs", environment: RunEnvironment):
+    def __init__(self, jobs: "Jobs", bucket_collection: "BucketCollection"):
         self.jobs = jobs
-        self.environment = environment
+        self.interviews: List["Interview"] = jobs.interviews()
+        self.bucket_collection: "BucketCollection" = bucket_collection
 
-    def __len__(self):
-        return len(self.jobs)
+        self.total_interviews: List["Interview"] = []
+        self._initialized = threading.Event()
 
-    async def run_async(self, parameters: RunParameters) -> Results:
-        """Used for some other modules that have a non-standard way of running interviews."""
+        from edsl.config import CONFIG
 
-        self.environment.jobs_runner_status = JobsRunnerStatus(self, n=parameters.n)
-        data = []
-        task_history = TaskHistory(include_traceback=False)
+        self.MAX_CONCURRENT = int(CONFIG.get("EDSL_MAX_CONCURRENT_TASKS"))
 
-        run_config = RunConfig(parameters=parameters, environment=self.environment)
-        result_generator = AsyncInterviewRunner(self.jobs, run_config)
+    async def run_async_generator(
+        self,
+        cache: Cache,
+        n: int = 1,
+        stop_on_exception: bool = False,
+        sidecar_model: Optional[LanguageModel] = None,
+        total_interviews: Optional[List["Interview"]] = None,
+        raise_validation_errors: bool = False,
+    ) -> AsyncGenerator["Result", None]:
+        """Creates and processes tasks asynchronously, yielding results as they complete.
 
-        async for result, interview in result_generator.run():
-            data.append(result)
-            task_history.add_interview(interview)
+        Tasks are created and processed in a streaming fashion rather than building the full list upfront.
+        Results are yielded as soon as they are available.
+
+        :param n: how many times to run each interview
+        :param stop_on_exception: Whether to stop the interview if an exception is raised
+        :param sidecar_model: a language model to use in addition to the interview's model
+        :param total_interviews: A list of interviews to run can be provided instead.
+        :param raise_validation_errors: Whether to raise validation errors
+        """
+        # Initialize interviews iterator
+        if total_interviews:
+            interviews_iter = iter(total_interviews)
+            self.total_interviews = total_interviews
+        else:
+            interviews_iter = self._populate_total_interviews(n=n)
+            self.total_interviews = list(interviews_iter)
+            interviews_iter = iter(self.total_interviews)  # Create fresh iterator
 
-        return Results(survey=self.jobs.survey, task_history=task_history, data=data)
+        self._initialized.set()  # Signal that we're ready
+
+        # Keep track of active tasks
+        active_tasks = set()
+
+        try:
+            while True:
+                # Add new tasks if we're below max_concurrent and there are more interviews
+                while len(active_tasks) < self.MAX_CONCURRENT:
+                    try:
+                        interview = next(interviews_iter)
+                        task = asyncio.create_task(
+                            self._build_interview_task(
+                                interview=interview,
+                                stop_on_exception=stop_on_exception,
+                                sidecar_model=sidecar_model,
+                                raise_validation_errors=raise_validation_errors,
+                            )
+                        )
+                        active_tasks.add(task)
+                        # Add callback to remove task from set when done
+                        task.add_done_callback(active_tasks.discard)
+                    except StopIteration:
+                        break
+
+                if not active_tasks:
+                    break
+
+                # Wait for next completed task
+                done, _ = await asyncio.wait(
+                    active_tasks, return_when=asyncio.FIRST_COMPLETED
+                )
+
+                # Process completed tasks
+                for task in done:
+                    try:
+                        result = await task
+                        self.jobs_runner_status.add_completed_interview(result)
+                        yield result
+                    except Exception as e:
+                        if stop_on_exception:
+                            # Cancel remaining tasks
+                            for t in active_tasks:
+                                if not t.done():
+                                    t.cancel()
+                            raise
+                        else:
+                            # Log error and continue
+                            # logger.error(f"Task failed with error: {e}")
+                            continue
+        finally:
+            # Ensure we cancel any remaining tasks if we exit early
+            for task in active_tasks:
+                if not task.done():
+                    task.cancel()
+
+    def _populate_total_interviews(
+        self, n: int = 1
+    ) -> Generator["Interview", None, None]:
+        """Populates self.total_interviews with n copies of each interview.
+
+        :param n: how many times to run each interview.
+        """
+        for interview in self.interviews:
+            for iteration in range(n):
+                if iteration > 0:
+                    yield interview.duplicate(iteration=iteration, cache=self.cache)
+                else:
+                    interview.cache = self.cache
+                    yield interview
+
+    async def run_async(self, cache: Optional[Cache] = None, n: int = 1) -> Results:
+        """Used for some other modules that have a non-standard way of running interviews."""
+        self.jobs_runner_status = JobsRunnerStatus(self, n=n)
+        self.cache = Cache() if cache is None else cache
+        data = []
+        async for result in self.run_async_generator(cache=self.cache, n=n):
+            data.append(result)
+        return Results(survey=self.jobs.survey, data=data)
 
     def simple_run(self):
         data = asyncio.run(self.run_async())
         return Results(survey=self.jobs.survey, data=data)
 
+    async def _build_interview_task(
+        self,
+        *,
+        interview: Interview,
+        stop_on_exception: bool = False,
+        sidecar_model: Optional["LanguageModel"] = None,
+        raise_validation_errors: bool = False,
+    ) -> "Result":
+        """Conducts an interview and returns the result.
+
+        :param interview: the interview to conduct
+        :param stop_on_exception: stops the interview if an exception is raised
+        :param sidecar_model: a language model to use in addition to the interview's model
+        """
+        # the model buckets are used to track usage rates
+        model_buckets = self.bucket_collection[interview.model]
+
+        # get the results of the interview
+        answer, valid_results = await interview.async_conduct_interview(
+            model_buckets=model_buckets,
+            stop_on_exception=stop_on_exception,
+            sidecar_model=sidecar_model,
+            raise_validation_errors=raise_validation_errors,
+        )
+
+        question_results = {}
+        for result in valid_results:
+            question_results[result.question_name] = result
+
+        answer_key_names = list(question_results.keys())
+
+        generated_tokens_dict = {
+            k + "_generated_tokens": question_results[k].generated_tokens
+            for k in answer_key_names
+        }
+        comments_dict = {
+            k + "_comment": question_results[k].comment for k in answer_key_names
+        }
+
+        # we should have a valid result for each question
+        answer_dict = {k: answer[k] for k in answer_key_names}
+        assert len(valid_results) == len(answer_key_names)
+
+        # TODO: move this down into Interview
+        question_name_to_prompts = dict({})
+        for result in valid_results:
+            question_name = result.question_name
+            question_name_to_prompts[question_name] = {
+                "user_prompt": result.prompts["user_prompt"],
+                "system_prompt": result.prompts["system_prompt"],
+            }
+
+        prompt_dictionary = {}
+        for answer_key_name in answer_key_names:
+            prompt_dictionary[
+                answer_key_name + "_user_prompt"
+            ] = question_name_to_prompts[answer_key_name]["user_prompt"]
+            prompt_dictionary[
+                answer_key_name + "_system_prompt"
+            ] = question_name_to_prompts[answer_key_name]["system_prompt"]
+
+        raw_model_results_dictionary = {}
+        cache_used_dictionary = {}
+        for result in valid_results:
+            question_name = result.question_name
+            raw_model_results_dictionary[
+                question_name + "_raw_model_response"
+            ] = result.raw_model_response
+            raw_model_results_dictionary[question_name + "_cost"] = result.cost
+            one_use_buys = (
+                "NA"
+                if isinstance(result.cost, str)
+                or result.cost == 0
+                or result.cost is None
+                else 1.0 / result.cost
+            )
+            raw_model_results_dictionary[question_name + "_one_usd_buys"] = one_use_buys
+            cache_used_dictionary[question_name] = result.cache_used
+
+        result = Result(
+            agent=interview.agent,
+            scenario=interview.scenario,
+            model=interview.model,
+            iteration=interview.iteration,
+            answer=answer_dict,
+            prompt=prompt_dictionary,
+            raw_model_response=raw_model_results_dictionary,
+            survey=interview.survey,
+            generated_tokens=generated_tokens_dict,
+            comments_dict=comments_dict,
+            cache_used_dict=cache_used_dictionary,
+            indices=interview.indices,
+        )
+        result.interview_hash = hash(interview)
+
+        return result
+
+    @property
+    def elapsed_time(self):
+        return time.monotonic() - self.start_time
+
+    def process_results(
+        self, raw_results: Results, cache: Cache, print_exceptions: bool
+    ):
+        interview_lookup = {
+            hash(interview): index
+            for index, interview in enumerate(self.total_interviews)
+        }
+        interview_hashes = list(interview_lookup.keys())
+
+        task_history = TaskHistory(self.total_interviews, include_traceback=False)
+
+        results = Results(
+            survey=self.jobs.survey,
+            data=sorted(
+                raw_results, key=lambda x: interview_hashes.index(x.interview_hash)
+            ),
+            task_history=task_history,
+            cache=cache,
+        )
+        results.bucket_collection = self.bucket_collection
+
+        if results.has_unfixed_exceptions and print_exceptions:
+            from edsl.scenarios.FileStore import HTMLFileStore
+            from edsl.config import CONFIG
+            from edsl.coop.coop import Coop
+
+            msg = f"Exceptions were raised in {len(results.task_history.indices)} out of {len(self.total_interviews)} interviews.\n"
+
+            if len(results.task_history.indices) > 5:
+                msg += f"Exceptions were raised in the following interviews: {results.task_history.indices}.\n"
+
+            import sys
+
+            print(msg, file=sys.stderr)
+            from edsl.config import CONFIG
+
+            if CONFIG.get("EDSL_OPEN_EXCEPTION_REPORT_URL") == "True":
+                open_in_browser = True
+            elif CONFIG.get("EDSL_OPEN_EXCEPTION_REPORT_URL") == "False":
+                open_in_browser = False
+            else:
+                raise Exception(
+                    "EDSL_OPEN_EXCEPTION_REPORT_URL", "must be either True or False"
+                )
+
+            filepath = results.task_history.html(
+                cta="Open report to see details.",
+                open_in_browser=open_in_browser,
+                return_link=True,
+            )
+
+            try:
+                coop = Coop()
+                user_edsl_settings = coop.edsl_settings
+                remote_logging = user_edsl_settings["remote_logging"]
+            except Exception as e:
+                print(e)
+                remote_logging = False
+
+            if remote_logging:
+                filestore = HTMLFileStore(filepath)
+                coop_details = filestore.push(description="Error report")
+                print(coop_details)
+
+            print("Also see: https://docs.expectedparrot.com/en/latest/exceptions.html")
+
+        return results
+
     @jupyter_nb_handler
-    async def run(self, parameters: RunParameters) -> Results:
+    async def run(
+        self,
+        cache: Union[Cache, False, None],
+        n: int = 1,
+        stop_on_exception: bool = False,
+        progress_bar: bool = False,
+        sidecar_model: Optional[LanguageModel] = None,
+        jobs_runner_status: Optional[Type[JobsRunnerStatusBase]] = None,
+        job_uuid: Optional[UUID] = None,
+        print_exceptions: bool = True,
+        raise_validation_errors: bool = False,
+    ) -> "Coroutine":
         """Runs a collection of interviews, handling both async and sync contexts."""
 
-        run_config = RunConfig(parameters=parameters, environment=self.environment)
-
+        self.results = []
         self.start_time = time.monotonic()
         self.completed = False
+        self.cache = cache
+        self.sidecar_model = sidecar_model
 
         from edsl.coop import Coop
 
         coop = Coop()
         endpoint_url = coop.get_progress_bar_url()
 
-        def set_up_jobs_runner_status(jobs_runner_status):
-            if jobs_runner_status is not None:
-                return jobs_runner_status(
-                    self,
-                    n=parameters.n,
-                    endpoint_url=endpoint_url,
-                    job_uuid=parameters.job_uuid,
-                )
-            else:
-                return JobsRunnerStatus(
-                    self,
-                    n=parameters.n,
-                    endpoint_url=endpoint_url,
-                    job_uuid=parameters.job_uuid,
-                )
+        if jobs_runner_status is not None:
+            self.jobs_runner_status = jobs_runner_status(
+                self, n=n, endpoint_url=endpoint_url, job_uuid=job_uuid
+            )
+        else:
+            self.jobs_runner_status = JobsRunnerStatus(
+                self, n=n, endpoint_url=endpoint_url, job_uuid=job_uuid
+            )
 
-        run_config.environment.jobs_runner_status = set_up_jobs_runner_status(
-            self.environment.jobs_runner_status
-        )
-
-        async def get_results(results) -> None:
-            """Conducted the interviews and append to the results list."""
-            result_generator = AsyncInterviewRunner(self.jobs, run_config)
-            async for result, interview in result_generator.run():
-                results.append(result)
-                results.task_history.add_interview(interview)
+        stop_event = threading.Event()
 
+        async def process_results(cache):
+            """Processes results from interviews."""
+            async for result in self.run_async_generator(
+                n=n,
+                stop_on_exception=stop_on_exception,
+                cache=cache,
+                sidecar_model=sidecar_model,
+                raise_validation_errors=raise_validation_errors,
+            ):
+                self.results.append(result)
             self.completed = True
 
-        def run_progress_bar(stop_event, jobs_runner_status) -> None:
+        def run_progress_bar(stop_event):
             """Runs the progress bar in a separate thread."""
-            jobs_runner_status.update_progress(stop_event)
-
-        def set_up_progress_bar(progress_bar: bool, jobs_runner_status):
-            progress_thread = None
-            if progress_bar and jobs_runner_status.has_ep_api_key():
-                jobs_runner_status.setup()
-                progress_thread = threading.Thread(
-                    target=run_progress_bar, args=(stop_event, jobs_runner_status)
-                )
-                progress_thread.start()
-            elif progress_bar:
-                warnings.warn(
-                    "You need an Expected Parrot API key to view job progress bars."
-                )
-            return progress_thread
+            self.jobs_runner_status.update_progress(stop_event)
 
-        results = Results(
-            survey=self.jobs.survey,
-            data=[],
-            task_history=TaskHistory(),
-            cache=self.environment.cache.new_entries_cache(),
-        )
-        stop_event = threading.Event()
-        progress_thread = set_up_progress_bar(
-            parameters.progress_bar, run_config.environment.jobs_runner_status
-        )
+        if progress_bar and self.jobs_runner_status.has_ep_api_key():
+            self.jobs_runner_status.setup()
+            progress_thread = threading.Thread(
+                target=run_progress_bar, args=(stop_event,)
+            )
+            progress_thread.start()
+        elif progress_bar:
+            warnings.warn(
+                "You need an Expected Parrot API key to view job progress bars."
+            )
 
         exception_to_raise = None
         try:
-            await get_results(results)
+            with cache as c:
+                await process_results(cache=c)
         except KeyboardInterrupt:
             print("Keyboard interrupt received. Stopping gracefully...")
             stop_event.set()
         except Exception as e:
-            if parameters.stop_on_exception:
+            if stop_on_exception:
                 exception_to_raise = e
             stop_event.set()
         finally:
             stop_event.set()
-            if progress_thread is not None:
-                progress_thread.join()
+            if progress_bar and self.jobs_runner_status.has_ep_api_key():
+                # self.jobs_runner_status.stop_event.set()
+                if progress_thread:
+                    progress_thread.join()
 
             if exception_to_raise:
                 raise exception_to_raise
 
-            results.cache = self.environment.cache.new_entries_cache()
-            results.bucket_collection = self.environment.bucket_collection
-
-            from edsl.jobs.results_exceptions_handler import ResultsExceptionsHandler
-
-            results_exceptions_handler = ResultsExceptionsHandler(results, parameters)
-
-            results_exceptions_handler.handle_exceptions()
-            return results
+            return self.process_results(
+                raw_results=self.results, cache=cache, print_exceptions=print_exceptions
+            )