From 43f347ee8e301e2e809456a91956e120a740035b Mon Sep 17 00:00:00 2001 From: Tom White Date: Thu, 1 Aug 2024 13:11:37 +0100 Subject: [PATCH 1/3] Rename `cubed.extensions` to `cubed.diagnostics` --- cubed/{extensions => diagnostics}/__init__.py | 0 cubed/{extensions => diagnostics}/history.py | 0 cubed/{extensions => diagnostics}/mem_warn.py | 0 cubed/{extensions => diagnostics}/rich.py | 0 cubed/{extensions => diagnostics}/timeline.py | 0 cubed/{extensions => diagnostics}/tqdm.py | 0 6 files changed, 0 insertions(+), 0 deletions(-) rename cubed/{extensions => diagnostics}/__init__.py (100%) rename cubed/{extensions => diagnostics}/history.py (100%) rename cubed/{extensions => diagnostics}/mem_warn.py (100%) rename cubed/{extensions => diagnostics}/rich.py (100%) rename cubed/{extensions => diagnostics}/timeline.py (100%) rename cubed/{extensions => diagnostics}/tqdm.py (100%) diff --git a/cubed/extensions/__init__.py b/cubed/diagnostics/__init__.py similarity index 100% rename from cubed/extensions/__init__.py rename to cubed/diagnostics/__init__.py diff --git a/cubed/extensions/history.py b/cubed/diagnostics/history.py similarity index 100% rename from cubed/extensions/history.py rename to cubed/diagnostics/history.py diff --git a/cubed/extensions/mem_warn.py b/cubed/diagnostics/mem_warn.py similarity index 100% rename from cubed/extensions/mem_warn.py rename to cubed/diagnostics/mem_warn.py diff --git a/cubed/extensions/rich.py b/cubed/diagnostics/rich.py similarity index 100% rename from cubed/extensions/rich.py rename to cubed/diagnostics/rich.py diff --git a/cubed/extensions/timeline.py b/cubed/diagnostics/timeline.py similarity index 100% rename from cubed/extensions/timeline.py rename to cubed/diagnostics/timeline.py diff --git a/cubed/extensions/tqdm.py b/cubed/diagnostics/tqdm.py similarity index 100% rename from cubed/extensions/tqdm.py rename to cubed/diagnostics/tqdm.py From 55bd04e7343418dcf973239e0deaf9ebc43fb743 Mon Sep 17 00:00:00 2001 From: Tom White Date: Thu, 1 Aug 2024 13:12:40 +0100 Subject: [PATCH 2/3] Deprecate `cubed.extensions` --- cubed/extensions/__init__.py | 0 cubed/extensions/history.py | 8 ++++++++ cubed/extensions/mem_warn.py | 8 ++++++++ cubed/extensions/rich.py | 8 ++++++++ cubed/extensions/timeline.py | 8 ++++++++ cubed/extensions/tqdm.py | 11 +++++++++++ 6 files changed, 43 insertions(+) create mode 100644 cubed/extensions/__init__.py create mode 100644 cubed/extensions/history.py create mode 100644 cubed/extensions/mem_warn.py create mode 100644 cubed/extensions/rich.py create mode 100644 cubed/extensions/timeline.py create mode 100644 cubed/extensions/tqdm.py diff --git a/cubed/extensions/__init__.py b/cubed/extensions/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/cubed/extensions/history.py b/cubed/extensions/history.py new file mode 100644 index 00000000..72080bb9 --- /dev/null +++ b/cubed/extensions/history.py @@ -0,0 +1,8 @@ +import warnings + +warnings.warn( + "`cubed.extensions.history` is deprecated, please use `cubed.diagnostics.history` instead", + DeprecationWarning, +) + +from cubed.diagnostics.history import HistoryCallback # noqa: F401 diff --git a/cubed/extensions/mem_warn.py b/cubed/extensions/mem_warn.py new file mode 100644 index 00000000..8437df94 --- /dev/null +++ b/cubed/extensions/mem_warn.py @@ -0,0 +1,8 @@ +import warnings + +warnings.warn( + "`cubed.extensions.mem_warn` is deprecated, please use `cubed.diagnostics.mem_warn` instead", + DeprecationWarning, +) + +from cubed.diagnostics.mem_warn import MemoryWarningCallback # noqa: F401 diff --git a/cubed/extensions/rich.py b/cubed/extensions/rich.py new file mode 100644 index 00000000..d383247e --- /dev/null +++ b/cubed/extensions/rich.py @@ -0,0 +1,8 @@ +import warnings + +warnings.warn( + "`cubed.extensions.rich` is deprecated, please use `cubed.diagnostics.rich` instead", + DeprecationWarning, +) + +from cubed.diagnostics.rich import RichProgressBar # noqa: F401 diff --git a/cubed/extensions/timeline.py b/cubed/extensions/timeline.py new file mode 100644 index 00000000..9f09afd3 --- /dev/null +++ b/cubed/extensions/timeline.py @@ -0,0 +1,8 @@ +import warnings + +warnings.warn( + "`cubed.extensions.timeline` is deprecated, please use `cubed.diagnostics.timeline` instead", + DeprecationWarning, +) + +from cubed.diagnostics.timeline import TimelineVisualizationCallback # noqa: F401 diff --git a/cubed/extensions/tqdm.py b/cubed/extensions/tqdm.py new file mode 100644 index 00000000..adfb138e --- /dev/null +++ b/cubed/extensions/tqdm.py @@ -0,0 +1,11 @@ +import warnings + +warnings.warn( + "`cubed.extensions.tqdm` is deprecated, please use `cubed.diagnostics.tqdm` instead", + DeprecationWarning, +) + +from cubed.diagnostics.tqdm import ( # noqa: F401 + TqdmProgressBar, + std_out_err_redirect_tqdm, +) From e18d48539265ca181d50a969ab199c15c5eff7ce Mon Sep 17 00:00:00 2001 From: Tom White Date: Thu, 1 Aug 2024 12:42:30 +0100 Subject: [PATCH 3/3] Update tests, examples and notebooks to use `cubed.diagnostics` --- cubed/tests/test_executor_features.py | 10 +++++----- cubed/tests/test_mem_utilization.py | 4 ++-- examples/add-random.py | 6 +++--- examples/dataflow/dataflow-add-random.py | 2 +- examples/matmul-random.py | 6 +++--- examples/pangeo-1-vorticity.ipynb | 2 +- examples/pangeo-2-quadratic-means.ipynb | 2 +- examples/pangeo-3-tem.ipynb | 2 +- examples/pangeo-4-climatological-anomalies.ipynb | 2 +- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/cubed/tests/test_executor_features.py b/cubed/tests/test_executor_features.py index 22fce7bf..f6bb5bd6 100644 --- a/cubed/tests/test_executor_features.py +++ b/cubed/tests/test_executor_features.py @@ -12,11 +12,11 @@ import cubed import cubed.array_api as xp import cubed.random -from cubed.extensions.history import HistoryCallback -from cubed.extensions.mem_warn import MemoryWarningCallback -from cubed.extensions.rich import RichProgressBar -from cubed.extensions.timeline import TimelineVisualizationCallback -from cubed.extensions.tqdm import TqdmProgressBar +from cubed.diagnostics.history import HistoryCallback +from cubed.diagnostics.mem_warn import MemoryWarningCallback +from cubed.diagnostics.rich import RichProgressBar +from cubed.diagnostics.timeline import TimelineVisualizationCallback +from cubed.diagnostics.tqdm import TqdmProgressBar from cubed.primitive.blockwise import apply_blockwise from cubed.runtime.create import create_executor from cubed.tests.utils import ( diff --git a/cubed/tests/test_mem_utilization.py b/cubed/tests/test_mem_utilization.py index c26ef8cf..290f8da7 100644 --- a/cubed/tests/test_mem_utilization.py +++ b/cubed/tests/test_mem_utilization.py @@ -12,8 +12,8 @@ from cubed.backend_array_api import namespace as nxp from cubed.core.ops import partial_reduce from cubed.core.optimization import multiple_inputs_optimize_dag -from cubed.extensions.history import HistoryCallback -from cubed.extensions.mem_warn import MemoryWarningCallback +from cubed.diagnostics.history import HistoryCallback +from cubed.diagnostics.mem_warn import MemoryWarningCallback from cubed.runtime.create import create_executor from cubed.tests.utils import LITHOPS_LOCAL_CONFIG diff --git a/examples/add-random.py b/examples/add-random.py index 0cde4ded..ba0d6bbb 100644 --- a/examples/add-random.py +++ b/examples/add-random.py @@ -3,9 +3,9 @@ import cubed import cubed.array_api as xp import cubed.random -from cubed.extensions.history import HistoryCallback -from cubed.extensions.rich import RichProgressBar -from cubed.extensions.timeline import TimelineVisualizationCallback +from cubed.diagnostics.history import HistoryCallback +from cubed.diagnostics.rich import RichProgressBar +from cubed.diagnostics.timeline import TimelineVisualizationCallback # suppress harmless connection pool warnings logging.getLogger("urllib3.connectionpool").setLevel(logging.ERROR) diff --git a/examples/dataflow/dataflow-add-random.py b/examples/dataflow/dataflow-add-random.py index 85d168e3..b750ef97 100644 --- a/examples/dataflow/dataflow-add-random.py +++ b/examples/dataflow/dataflow-add-random.py @@ -7,7 +7,7 @@ import cubed import cubed.array_api as xp import cubed.random -from cubed.extensions.tqdm import TqdmProgressBar +from cubed.diagnostics.tqdm import TqdmProgressBar from cubed.runtime.executors.beam import BeamExecutor diff --git a/examples/matmul-random.py b/examples/matmul-random.py index 2e68cab6..106464f4 100644 --- a/examples/matmul-random.py +++ b/examples/matmul-random.py @@ -3,9 +3,9 @@ import cubed import cubed.array_api as xp import cubed.random -from cubed.extensions.history import HistoryCallback -from cubed.extensions.rich import RichProgressBar -from cubed.extensions.timeline import TimelineVisualizationCallback +from cubed.diagnostics.history import HistoryCallback +from cubed.diagnostics.rich import RichProgressBar +from cubed.diagnostics.timeline import TimelineVisualizationCallback # suppress harmless connection pool warnings logging.getLogger("urllib3.connectionpool").setLevel(logging.ERROR) diff --git a/examples/pangeo-1-vorticity.ipynb b/examples/pangeo-1-vorticity.ipynb index 72bf2aa7..2a2af196 100644 --- a/examples/pangeo-1-vorticity.ipynb +++ b/examples/pangeo-1-vorticity.ipynb @@ -21,7 +21,7 @@ "source": [ "import cubed\n", "import cubed.random\n", - "from cubed.extensions.rich import RichProgressBar\n", + "from cubed.diagnostics.rich import RichProgressBar\n", "import xarray as xr" ] }, diff --git a/examples/pangeo-2-quadratic-means.ipynb b/examples/pangeo-2-quadratic-means.ipynb index 727e65df..33ec9635 100644 --- a/examples/pangeo-2-quadratic-means.ipynb +++ b/examples/pangeo-2-quadratic-means.ipynb @@ -21,7 +21,7 @@ "source": [ "import cubed\n", "import cubed.random\n", - "from cubed.extensions.rich import RichProgressBar\n", + "from cubed.diagnostics.rich import RichProgressBar\n", "import xarray as xr" ] }, diff --git a/examples/pangeo-3-tem.ipynb b/examples/pangeo-3-tem.ipynb index 7f011801..556ddfba 100644 --- a/examples/pangeo-3-tem.ipynb +++ b/examples/pangeo-3-tem.ipynb @@ -21,7 +21,7 @@ "source": [ "import cubed\n", "import cubed.random\n", - "from cubed.extensions.rich import RichProgressBar\n", + "from cubed.diagnostics.rich import RichProgressBar\n", "import pandas as pd\n", "import xarray as xr" ] diff --git a/examples/pangeo-4-climatological-anomalies.ipynb b/examples/pangeo-4-climatological-anomalies.ipynb index bc6a63c3..47c9da39 100644 --- a/examples/pangeo-4-climatological-anomalies.ipynb +++ b/examples/pangeo-4-climatological-anomalies.ipynb @@ -26,7 +26,7 @@ "from datetime import datetime, timedelta\n", "import cubed\n", "import cubed.random\n", - "from cubed.extensions.rich import RichProgressBar\n", + "from cubed.diagnostics.rich import RichProgressBar\n", "import numpy as np\n", "import xarray as xr" ]