chore(datasets): Demote VideoDataset to experimental datasets (#916)

* Move VideoDataset to experimental datasets Signed-off-by: Merel Theisen <[email protected]> * Fix lint Signed-off-by: Merel Theisen <[email protected]> * Fix docs Signed-off-by: Merel Theisen <[email protected]> * Clean up Signed-off-by: Merel Theisen <[email protected]> * Update release notes Signed-off-by: Merel Theisen <[email protected]> --------- Signed-off-by: Merel Theisen <[email protected]>
kedro-org · Oct 29, 2024 · 9ec295a · 9ec295a
1 parent 59dcf50
commit 9ec295a
Show file tree

Hide file tree

Showing 16 changed files with 9 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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 → ...sets_experimental/tests/video/conftest.py b/kedro-datasets/tests/video/conftest.py → ...sets_experimental/tests/video/conftest.py
diff --git a/...datasets/tests/video/data/color_video.mp4 → ...rimental/tests/video/data/color_video.mp4 b/...datasets/tests/video/data/color_video.mp4 → ...rimental/tests/video/data/color_video.mp4
diff --git a/kedro-datasets/tests/video/data/video.mjpeg → ...experimental/tests/video/data/video.mjpeg b/kedro-datasets/tests/video/data/video.mjpeg → ...experimental/tests/video/data/video.mjpeg
diff --git a/kedro-datasets/tests/video/data/video.mkv → ...s_experimental/tests/video/data/video.mkv b/kedro-datasets/tests/video/data/video.mkv → ...s_experimental/tests/video/data/video.mkv
diff --git a/kedro-datasets/tests/video/data/video.mp4 → ...s_experimental/tests/video/data/video.mp4 b/kedro-datasets/tests/video/data/video.mp4 → ...s_experimental/tests/video/data/video.mp4
diff --git a/...datasets/tests/video/test_sliced_video.py → ...rimental/tests/video/test_sliced_video.py b/...datasets/tests/video/test_sliced_video.py → ...rimental/tests/video/test_sliced_video.py
diff --git a/...atasets/tests/video/test_video_dataset.py → ...imental/tests/video/test_video_dataset.py b/...atasets/tests/video/test_video_dataset.py → ...imental/tests/video/test_video_dataset.py
diff --git a/...atasets/tests/video/test_video_objects.py → ...imental/tests/video/test_video_objects.py b/...atasets/tests/video/test_video_objects.py → ...imental/tests/video/test_video_objects.py
diff --git a/kedro-datasets/tests/video/utils.py → ...atasets_experimental/tests/video/utils.py b/kedro-datasets/tests/video/utils.py → ...atasets_experimental/tests/video/utils.py
diff --git a/...datasets/kedro_datasets/video/__init__.py → ...o_datasets_experimental/video/__init__.py b/...datasets/kedro_datasets/video/__init__.py → ...o_datasets_experimental/video/__init__.py
diff --git a/...ets/kedro_datasets/video/video_dataset.py → ...asets_experimental/video/video_dataset.py b/...ets/kedro_datasets/video/video_dataset.py → ...asets_experimental/video/video_dataset.py
diff --git 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]