From 9ec295abf7e551afea06aacf43ef6044c360c5a4 Mon Sep 17 00:00:00 2001 From: Merel Theisen <49397448+merelcht@users.noreply.github.com> Date: Tue, 29 Oct 2024 13:52:39 +0000 Subject: [PATCH] chore(datasets): Demote `VideoDataset` to experimental datasets (#916) * Move VideoDataset to experimental datasets Signed-off-by: Merel Theisen * Fix lint Signed-off-by: Merel Theisen * Fix docs Signed-off-by: Merel Theisen * Clean up Signed-off-by: Merel Theisen * Update release notes Signed-off-by: Merel Theisen --------- Signed-off-by: Merel Theisen --- kedro-datasets/RELEASE.md | 3 ++- kedro-datasets/docs/source/api/kedro_datasets.rst | 1 - .../docs/source/api/kedro_datasets_experimental.rst | 1 + kedro-datasets/docs/source/conf.py | 2 +- .../tests/video/conftest.py | 0 .../tests/video/data/color_video.mp4 | Bin .../tests/video/data/video.mjpeg | Bin .../tests/video/data/video.mkv | Bin .../tests/video/data/video.mp4 | Bin .../tests/video/test_sliced_video.py | 0 .../tests/video/test_video_dataset.py | 0 .../tests/video/test_video_objects.py | 0 .../tests/video/utils.py | 0 .../video/__init__.py | 0 .../video/video_dataset.py | 0 kedro-datasets/pyproject.toml | 10 +++++----- 16 files changed, 9 insertions(+), 8 deletions(-) rename kedro-datasets/{ => kedro_datasets_experimental}/tests/video/conftest.py (100%) rename kedro-datasets/{ => kedro_datasets_experimental}/tests/video/data/color_video.mp4 (100%) rename kedro-datasets/{ => kedro_datasets_experimental}/tests/video/data/video.mjpeg (100%) rename kedro-datasets/{ => kedro_datasets_experimental}/tests/video/data/video.mkv (100%) rename kedro-datasets/{ => kedro_datasets_experimental}/tests/video/data/video.mp4 (100%) rename kedro-datasets/{ => kedro_datasets_experimental}/tests/video/test_sliced_video.py (100%) rename kedro-datasets/{ => kedro_datasets_experimental}/tests/video/test_video_dataset.py (100%) rename kedro-datasets/{ => kedro_datasets_experimental}/tests/video/test_video_objects.py (100%) rename kedro-datasets/{ => kedro_datasets_experimental}/tests/video/utils.py (100%) rename kedro-datasets/{kedro_datasets => kedro_datasets_experimental}/video/__init__.py (100%) rename kedro-datasets/{kedro_datasets => kedro_datasets_experimental}/video/video_dataset.py (100%) diff --git a/kedro-datasets/RELEASE.md b/kedro-datasets/RELEASE.md index c9a0eb0b0..daff41362 100755 --- a/kedro-datasets/RELEASE.md +++ b/kedro-datasets/RELEASE.md @@ -1,4 +1,4 @@ -# Upcoming Release +# Upcoming Release 6.0.0 ## Major features and improvements @@ -15,6 +15,7 @@ - Implemented Snowflake's (local testing framework)[https://docs.snowflake.com/en/developer-guide/snowpark/python/testing-locally] for testing purposes ## Breaking Changes +- Demoted `video.VideoDataset` from core to experimental dataset. ## Community contributions diff --git a/kedro-datasets/docs/source/api/kedro_datasets.rst b/kedro-datasets/docs/source/api/kedro_datasets.rst index 3da276e87..0cbd3bc4e 100644 --- a/kedro-datasets/docs/source/api/kedro_datasets.rst +++ b/kedro-datasets/docs/source/api/kedro_datasets.rst @@ -64,5 +64,4 @@ kedro_datasets text.TextDataset tracking.JSONDataset tracking.MetricsDataset - video.VideoDataset yaml.YAMLDataset diff --git a/kedro-datasets/docs/source/api/kedro_datasets_experimental.rst b/kedro-datasets/docs/source/api/kedro_datasets_experimental.rst index a29e8449c..72328e47e 100644 --- a/kedro-datasets/docs/source/api/kedro_datasets_experimental.rst +++ b/kedro-datasets/docs/source/api/kedro_datasets_experimental.rst @@ -20,3 +20,4 @@ kedro_datasets_experimental prophet.ProphetModelDataset pytorch.PyTorchDataset rioxarray.GeoTIFFDataset + video.VideoDataset diff --git a/kedro-datasets/docs/source/conf.py b/kedro-datasets/docs/source/conf.py index 03df63f65..f62e80104 100644 --- a/kedro-datasets/docs/source/conf.py +++ b/kedro-datasets/docs/source/conf.py @@ -134,7 +134,7 @@ "pyspark.sql.dataframe.DataFrame", "scipy.sparse._csr.csr_matrix", "keras.src.models.model.Model", - "kedro_datasets.video.video_dataset.AbstractVideo", + "kedro_datasets_experimental.video.video_dataset.AbstractVideo", "langchain_anthropic.chat_models.ChatAnthropic", "langchain_cohere.chat_models.ChatCohere", "xarray.core.dataset.Dataset", diff --git a/kedro-datasets/tests/video/conftest.py b/kedro-datasets/kedro_datasets_experimental/tests/video/conftest.py similarity index 100% rename from kedro-datasets/tests/video/conftest.py rename to kedro-datasets/kedro_datasets_experimental/tests/video/conftest.py diff --git a/kedro-datasets/tests/video/data/color_video.mp4 b/kedro-datasets/kedro_datasets_experimental/tests/video/data/color_video.mp4 similarity index 100% rename from kedro-datasets/tests/video/data/color_video.mp4 rename to kedro-datasets/kedro_datasets_experimental/tests/video/data/color_video.mp4 diff --git a/kedro-datasets/tests/video/data/video.mjpeg b/kedro-datasets/kedro_datasets_experimental/tests/video/data/video.mjpeg similarity index 100% rename from kedro-datasets/tests/video/data/video.mjpeg rename to kedro-datasets/kedro_datasets_experimental/tests/video/data/video.mjpeg diff --git a/kedro-datasets/tests/video/data/video.mkv b/kedro-datasets/kedro_datasets_experimental/tests/video/data/video.mkv similarity index 100% rename from kedro-datasets/tests/video/data/video.mkv rename to kedro-datasets/kedro_datasets_experimental/tests/video/data/video.mkv diff --git a/kedro-datasets/tests/video/data/video.mp4 b/kedro-datasets/kedro_datasets_experimental/tests/video/data/video.mp4 similarity index 100% rename from kedro-datasets/tests/video/data/video.mp4 rename to kedro-datasets/kedro_datasets_experimental/tests/video/data/video.mp4 diff --git a/kedro-datasets/tests/video/test_sliced_video.py b/kedro-datasets/kedro_datasets_experimental/tests/video/test_sliced_video.py similarity index 100% rename from kedro-datasets/tests/video/test_sliced_video.py rename to kedro-datasets/kedro_datasets_experimental/tests/video/test_sliced_video.py diff --git a/kedro-datasets/tests/video/test_video_dataset.py b/kedro-datasets/kedro_datasets_experimental/tests/video/test_video_dataset.py similarity index 100% rename from kedro-datasets/tests/video/test_video_dataset.py rename to kedro-datasets/kedro_datasets_experimental/tests/video/test_video_dataset.py diff --git a/kedro-datasets/tests/video/test_video_objects.py b/kedro-datasets/kedro_datasets_experimental/tests/video/test_video_objects.py similarity index 100% rename from kedro-datasets/tests/video/test_video_objects.py rename to kedro-datasets/kedro_datasets_experimental/tests/video/test_video_objects.py diff --git a/kedro-datasets/tests/video/utils.py b/kedro-datasets/kedro_datasets_experimental/tests/video/utils.py similarity index 100% rename from kedro-datasets/tests/video/utils.py rename to kedro-datasets/kedro_datasets_experimental/tests/video/utils.py diff --git a/kedro-datasets/kedro_datasets/video/__init__.py b/kedro-datasets/kedro_datasets_experimental/video/__init__.py similarity index 100% rename from kedro-datasets/kedro_datasets/video/__init__.py rename to kedro-datasets/kedro_datasets_experimental/video/__init__.py diff --git a/kedro-datasets/kedro_datasets/video/video_dataset.py b/kedro-datasets/kedro_datasets_experimental/video/video_dataset.py similarity index 100% rename from kedro-datasets/kedro_datasets/video/video_dataset.py rename to kedro-datasets/kedro_datasets_experimental/video/video_dataset.py diff --git a/kedro-datasets/pyproject.toml b/kedro-datasets/pyproject.toml index de2e071ab..96ad0fd41 100644 --- a/kedro-datasets/pyproject.toml +++ b/kedro-datasets/pyproject.toml @@ -167,9 +167,6 @@ tracking-jsondataset = [] tracking-metricsdataset = [] tracking = ["kedro-datasets[tracking-jsondataset, tracking-metricsdataset]"] -video-videodataset = ["opencv-python~=4.5.5.64"] -video = ["kedro-datasets[video-videodataset]"] - yaml-yamldataset = ["kedro-datasets[pandas-base]", "PyYAML>=4.2, <7.0"] yaml = ["kedro-datasets[yaml-yamldataset]"] @@ -192,6 +189,9 @@ pytorch = ["kedro-datasets[pytorch-dataset]"] rioxarray-geotiffdataset = ["rioxarray>=0.15.0"] rioxarray = ["kedro-datasets[rioxarray-geotiffdataset]"] +video-videodataset = ["opencv-python~=4.5.5.64"] +video = ["kedro-datasets[video-videodataset]"] + # Docs requirements docs = [ "kedro-sphinx-theme==2024.10.2", @@ -230,7 +230,6 @@ test = [ "moto==5.0.0", "networkx~=2.4", "numpy<2", - "opencv-python~=4.5.5.64", "openpyxl>=3.0.3, <4.0", "pandas-gbq>=0.12.0", "pandas>=2.0", @@ -298,6 +297,7 @@ experimental = [ "xarray>=2023.1.0", "rioxarray", "torch", + "opencv-python~=4.5.5.64", "prophet>=1.1.5", ] @@ -349,7 +349,7 @@ select = [ ignore = ["E501"] # Black takes care of line-too-long [tool.ruff.per-file-ignores] -"{tests,docs}/*" = ["PLR2004", "PLR0913", "T201"] +"{tests,docs,kedro_datasets_experimental/tests}/*" = ["PLR2004", "PLR0913", "T201"] "*/{__init__.py}" = ["F821"] # temporarily ignore ruff undefined name errors for dataset aliases [tool.mypy]