Merge remote-tracking branch 'origin/main' into pre-commit-ci-update-config

Author: basnijholt

adaptive/runner.py

@@ -722,6 +722,14 @@ def cancel(self) -> None:
         """
         self.task.cancel()
 
+    def block_until_done(self) -> None:
+        if in_ipynb():
+            raise RuntimeError(
+                "Cannot block the event loop when running in a Jupyter notebook."
+                " Use `await runner.task` instead."
+            )
+        self.ioloop.run_until_complete(self.task)
+
     def live_plot(
         self,
         *,
@@ -768,6 +776,55 @@ def live_info(self, *, update_interval: float = 0.1) -> None:
         """
         return live_info(self, update_interval=update_interval)
 
+    def live_info_terminal(
+        self, *, update_interval: float = 0.5, overwrite_previous: bool = True
+    ) -> asyncio.Task:
+        """
+        Display live information about the runner in the terminal.
+
+        This function provides a live update of the runner's status in the terminal.
+        The update can either overwrite the previous status or be printed on a new line.
+
+        Parameters
+        ----------
+        update_interval : float, optional
+            The time interval (in seconds) at which the runner's status is updated in the terminal.
+            Default is 0.5 seconds.
+        overwrite_previous : bool, optional
+            If True, each update will overwrite the previous status in the terminal.
+            If False, each update will be printed on a new line.
+            Default is True.
+
+        Returns
+        -------
+        asyncio.Task
+            The asynchronous task responsible for updating the runner's status in the terminal.
+
+        Examples
+        --------
+        >>> runner = AsyncRunner(...)
+        >>> runner.live_info_terminal(update_interval=1.0, overwrite_previous=False)
+
+        Notes
+        -----
+        This function uses ANSI escape sequences to control the terminal's cursor position.
+        It might not work as expected on all terminal emulators.
+        """
+
+        async def _update(runner: AsyncRunner) -> None:
+            try:
+                while not runner.task.done():
+                    if overwrite_previous:
+                        # Clear the terminal
+                        print("\033[H\033[J", end="")
+                    print(_info_text(runner, separator="\t"))
+                    await asyncio.sleep(update_interval)
+
+            except asyncio.CancelledError:
+                print("Live info display cancelled.")
+
+        return self.ioloop.create_task(_update(self))
+
     async def _run(self) -> None:
         first_completed = asyncio.FIRST_COMPLETED
 
@@ -847,6 +904,43 @@ async def _saver():
         return self.saving_task
 
 
+def _info_text(runner, separator: str = "\n"):
+    status = runner.status()
+
+    color_map = {
+        "cancelled": "\033[33m",  # Yellow
+        "failed": "\033[31m",  # Red
+        "running": "\033[34m",  # Blue
+        "finished": "\033[32m",  # Green
+    }
+
+    overhead = runner.overhead()
+    if overhead < 50:
+        overhead_color = "\033[32m"  # Green
+    else:
+        overhead_color = "\033[31m"  # Red
+
+    info = [
+        ("time", str(datetime.now())),
+        ("status", f"{color_map[status]}{status}\033[0m"),
+        ("elapsed time", str(timedelta(seconds=runner.elapsed_time()))),
+        ("overhead", f"{overhead_color}{overhead:.2f}%\033[0m"),
+    ]
+
+    with suppress(Exception):
+        info.append(("# of points", runner.learner.npoints))
+
+    with suppress(Exception):
+        info.append(("# of samples", runner.learner.nsamples))
+
+    with suppress(Exception):
+        info.append(("latest loss", f'{runner.learner._cache["loss"]:.3f}'))
+
+    width = 30
+    formatted_info = [f"{k}: {v}".ljust(width) for i, (k, v) in enumerate(info)]
+    return separator.join(formatted_info)
+
+
 # Default runner
 Runner = AsyncRunner
 

adaptive/tests/test_runner.py

@@ -1,4 +1,3 @@
-import asyncio
 import platform
 import sys
 import time
@@ -34,7 +33,7 @@ def blocking_runner(learner, **kw):
 
 def async_runner(learner, **kw):
     runner = AsyncRunner(learner, executor=SequentialExecutor(), **kw)
-    asyncio.get_event_loop().run_until_complete(runner.task)
+    runner.block_until_done()
 
 
 runners = [simple, blocking_runner, async_runner]
@@ -71,7 +70,7 @@ async def f(x):
 
     learner = Learner1D(f, (-1, 1))
     runner = AsyncRunner(learner, npoints_goal=10)
-    asyncio.get_event_loop().run_until_complete(runner.task)
+    runner.block_until_done()
 
 
 # --- Test with different executors
@@ -158,7 +157,7 @@ def test_loky_executor(loky_executor):
 def test_default_executor():
     learner = Learner1D(linear, (-1, 1))
     runner = AsyncRunner(learner, npoints_goal=10)
-    asyncio.get_event_loop().run_until_complete(runner.task)
+    runner.block_until_done()
 
 
 def test_auto_goal():

docs/environment.yml

@@ -9,9 +9,9 @@ dependencies:
   - scikit-optimize=0.9.0
   - scikit-learn=1.2.2
   - scipy=1.10.1
-  - holoviews=1.15.4
-  - bokeh=2.4.3
-  - panel=0.14.4
+  - holoviews=1.18.3
+  - bokeh=3.3.4
+  - panel=1.3.8
   - pandas=2.0.0
   - plotly=5.14.1
   - ipywidgets=8.0.6
@@ -23,6 +23,8 @@ dependencies:
   - loky=3.3.0
   - furo=2023.3.27
   - myst-parser=0.18.1
-  - dask=2023.3.2
+  - dask=2024.2.0
   - emoji=2.2.0
   - versioningit=2.2.0
+  - distributed=2024.2.0
+  - param=2.0.2

docs/source/tutorial/tutorial.parallelism.md

@@ -89,7 +89,7 @@ if __name__ == "__main__":
     runner.start_periodic_saving(dict(fname=fname), interval=600)
 
     # block until runner goal reached
-    runner.ioloop.run_until_complete(runner.task)
+    runner.block_until_done()
 
     # save one final time before exiting
     learner.save(fname)