From 604b27adfd81bd2e13a15c18216c147ee1dc3f0a Mon Sep 17 00:00:00 2001 From: "L. R. Couto" <57910428+lrcouto@users.noreply.github.com> Date: Fri, 1 Sep 2023 11:02:55 -0300 Subject: [PATCH] Fix docstrings on kedro/extras/datasets (#2995) * Fix docstrings on kedro/extras/datasets Signed-off-by: lrcouto * Fix formatting error Signed-off-by: lrcouto * Explicitly define code block Signed-off-by: lrcouto * Fix empty line under code block Signed-off-by: lrcouto * Fix formatting error Signed-off-by: lrcouto * Fix broken link Signed-off-by: lrcouto * Bump kedro-datasets version Signed-off-by: Ankita Katiyar * Update links in partitioned and incremental datasets Signed-off-by: Ankita Katiyar * Update links in partitioned and incremental datasets Signed-off-by: Ankita Katiyar * Update links in partitioned dataset Signed-off-by: Ankita Katiyar * Update links in partitioned dataset Signed-off-by: Ankita Katiyar * Add polars.GenericDataSet to .rst Signed-off-by: Ankita Katiyar --------- Signed-off-by: lrcouto Signed-off-by: Ankita Katiyar Co-authored-by: Ankita Katiyar --- docs/source/kedro_datasets.rst | 1 + kedro/extras/datasets/api/api_dataset.py | 5 +++-- kedro/extras/datasets/dask/parquet_dataset.py | 5 +++-- kedro/extras/datasets/json/json_dataset.py | 4 ++-- .../datasets/matplotlib/matplotlib_writer.py | 4 ++-- kedro/extras/datasets/pandas/csv_dataset.py | 4 ++-- kedro/extras/datasets/pandas/excel_dataset.py | 8 ++++---- kedro/extras/datasets/pandas/feather_dataset.py | 4 ++-- kedro/extras/datasets/pandas/gbq_dataset.py | 4 ++-- kedro/extras/datasets/pandas/generic_dataset.py | 4 ++-- kedro/extras/datasets/pandas/hdf_dataset.py | 5 +++-- kedro/extras/datasets/pandas/json_dataset.py | 5 +++-- kedro/extras/datasets/pandas/parquet_dataset.py | 5 +++-- kedro/extras/datasets/pandas/sql_dataset.py | 11 +++++++---- kedro/extras/datasets/pandas/xml_dataset.py | 2 +- kedro/extras/datasets/pickle/pickle_dataset.py | 5 +++-- kedro/extras/datasets/pillow/image_dataset.py | 2 +- kedro/extras/datasets/plotly/json_dataset.py | 5 +++-- kedro/extras/datasets/plotly/plotly_dataset.py | 5 +++-- kedro/extras/datasets/redis/redis_dataset.py | 5 +++-- kedro/extras/datasets/spark/deltatable_dataset.py | 5 +++-- kedro/extras/datasets/spark/spark_dataset.py | 5 +++-- kedro/extras/datasets/spark/spark_hive_dataset.py | 5 +++-- kedro/extras/datasets/spark/spark_jdbc_dataset.py | 5 +++-- .../extras/datasets/svmlight/svmlight_dataset.py | 5 +++-- .../tensorflow/tensorflow_model_dataset.py | 5 +++-- kedro/extras/datasets/text/text_dataset.py | 5 +++-- kedro/extras/datasets/tracking/json_dataset.py | 5 +++-- kedro/extras/datasets/tracking/metrics_dataset.py | 5 +++-- kedro/extras/datasets/video/video_dataset.py | 5 +++-- kedro/extras/datasets/yaml/yaml_dataset.py | 5 +++-- kedro/io/partitioned_dataset.py | 15 ++++++++------- setup.py | 2 +- 33 files changed, 95 insertions(+), 70 deletions(-) diff --git a/docs/source/kedro_datasets.rst b/docs/source/kedro_datasets.rst index 18bff88086..d1e06429c3 100644 --- a/docs/source/kedro_datasets.rst +++ b/docs/source/kedro_datasets.rst @@ -41,6 +41,7 @@ kedro_datasets kedro_datasets.plotly.JSONDataSet kedro_datasets.plotly.PlotlyDataSet kedro_datasets.polars.CSVDataSet + kedro_datasets.polars.GenericDataSet kedro_datasets.redis.PickleDataSet kedro_datasets.snowflake.SnowparkTableDataSet kedro_datasets.spark.DeltaTableDataSet diff --git a/kedro/extras/datasets/api/api_dataset.py b/kedro/extras/datasets/api/api_dataset.py index f288c96814..0e79f9aad2 100644 --- a/kedro/extras/datasets/api/api_dataset.py +++ b/kedro/extras/datasets/api/api_dataset.py @@ -19,7 +19,8 @@ class APIDataSet(AbstractDataset[None, requests.Response]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -36,7 +37,7 @@ class APIDataSet(AbstractDataset[None, requests.Response]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.api import APIDataSet diff --git a/kedro/extras/datasets/dask/parquet_dataset.py b/kedro/extras/datasets/dask/parquet_dataset.py index 23dc7a701b..21fcfe25b0 100644 --- a/kedro/extras/datasets/dask/parquet_dataset.py +++ b/kedro/extras/datasets/dask/parquet_dataset.py @@ -22,7 +22,7 @@ class ParquetDataSet(AbstractDataset[dd.DataFrame, dd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: .. code-block:: yaml @@ -38,9 +38,10 @@ class ParquetDataSet(AbstractDataset[dd.DataFrame, dd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: + >>> from kedro.extras.datasets.dask import ParquetDataSet >>> import pandas as pd >>> import dask.dataframe as dd diff --git a/kedro/extras/datasets/json/json_dataset.py b/kedro/extras/datasets/json/json_dataset.py index 5e05dd46ed..f5907cc162 100644 --- a/kedro/extras/datasets/json/json_dataset.py +++ b/kedro/extras/datasets/json/json_dataset.py @@ -27,7 +27,7 @@ class JSONDataSet(AbstractVersionedDataset[Any, Any]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: .. code-block:: yaml @@ -40,7 +40,7 @@ class JSONDataSet(AbstractVersionedDataset[Any, Any]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.json import JSONDataSet diff --git a/kedro/extras/datasets/matplotlib/matplotlib_writer.py b/kedro/extras/datasets/matplotlib/matplotlib_writer.py index 204e4673c5..6c29b4d5ba 100644 --- a/kedro/extras/datasets/matplotlib/matplotlib_writer.py +++ b/kedro/extras/datasets/matplotlib/matplotlib_writer.py @@ -33,7 +33,7 @@ class MatplotlibWriter( Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: .. code-block:: yaml @@ -45,7 +45,7 @@ class MatplotlibWriter( Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> import matplotlib.pyplot as plt diff --git a/kedro/extras/datasets/pandas/csv_dataset.py b/kedro/extras/datasets/pandas/csv_dataset.py index 01b044969c..26816da5d4 100644 --- a/kedro/extras/datasets/pandas/csv_dataset.py +++ b/kedro/extras/datasets/pandas/csv_dataset.py @@ -32,7 +32,7 @@ class CSVDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: .. code-block:: yaml @@ -54,7 +54,7 @@ class CSVDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import CSVDataSet diff --git a/kedro/extras/datasets/pandas/excel_dataset.py b/kedro/extras/datasets/pandas/excel_dataset.py index 21139c7ca9..ebf5015b72 100644 --- a/kedro/extras/datasets/pandas/excel_dataset.py +++ b/kedro/extras/datasets/pandas/excel_dataset.py @@ -37,7 +37,7 @@ class ExcelDataSet( Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: .. code-block:: yaml @@ -58,7 +58,7 @@ class ExcelDataSet( Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import ExcelDataSet @@ -78,7 +78,7 @@ class ExcelDataSet( Example usage for the `YAML API `_ + data_catalog_yaml_examples.html>`_ for a multi-sheet Excel file: .. code-block:: yaml @@ -91,7 +91,7 @@ class ExcelDataSet( Example usage for the `Python API `_ + advanced_data_catalog_usage.html>`_ for a multi-sheet Excel file: :: diff --git a/kedro/extras/datasets/pandas/feather_dataset.py b/kedro/extras/datasets/pandas/feather_dataset.py index b43ecc1814..445cd9758a 100644 --- a/kedro/extras/datasets/pandas/feather_dataset.py +++ b/kedro/extras/datasets/pandas/feather_dataset.py @@ -34,7 +34,7 @@ class FeatherDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: .. code-block:: yaml @@ -52,7 +52,7 @@ class FeatherDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import FeatherDataSet diff --git a/kedro/extras/datasets/pandas/gbq_dataset.py b/kedro/extras/datasets/pandas/gbq_dataset.py index 16cea01213..5a7c460c7c 100644 --- a/kedro/extras/datasets/pandas/gbq_dataset.py +++ b/kedro/extras/datasets/pandas/gbq_dataset.py @@ -31,7 +31,7 @@ class GBQTableDataSet(AbstractDataset[None, pd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: .. code-block:: yaml @@ -48,7 +48,7 @@ class GBQTableDataSet(AbstractDataset[None, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import GBQTableDataSet diff --git a/kedro/extras/datasets/pandas/generic_dataset.py b/kedro/extras/datasets/pandas/generic_dataset.py index 7212310e8f..9d173d6524 100644 --- a/kedro/extras/datasets/pandas/generic_dataset.py +++ b/kedro/extras/datasets/pandas/generic_dataset.py @@ -41,7 +41,7 @@ class GenericDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: .. code-block:: yaml @@ -71,7 +71,7 @@ class GenericDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import GenericDataSet diff --git a/kedro/extras/datasets/pandas/hdf_dataset.py b/kedro/extras/datasets/pandas/hdf_dataset.py index 0d337af42d..aa02434776 100644 --- a/kedro/extras/datasets/pandas/hdf_dataset.py +++ b/kedro/extras/datasets/pandas/hdf_dataset.py @@ -30,7 +30,8 @@ class HDFDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -42,7 +43,7 @@ class HDFDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import HDFDataSet diff --git a/kedro/extras/datasets/pandas/json_dataset.py b/kedro/extras/datasets/pandas/json_dataset.py index 8148d325c5..c2cf971bb9 100644 --- a/kedro/extras/datasets/pandas/json_dataset.py +++ b/kedro/extras/datasets/pandas/json_dataset.py @@ -32,7 +32,8 @@ class JSONDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -49,7 +50,7 @@ class JSONDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import JSONDataSet diff --git a/kedro/extras/datasets/pandas/parquet_dataset.py b/kedro/extras/datasets/pandas/parquet_dataset.py index 4bdba28772..43c603f2ae 100644 --- a/kedro/extras/datasets/pandas/parquet_dataset.py +++ b/kedro/extras/datasets/pandas/parquet_dataset.py @@ -33,7 +33,8 @@ class ParquetDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -61,7 +62,7 @@ class ParquetDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import ParquetDataSet diff --git a/kedro/extras/datasets/pandas/sql_dataset.py b/kedro/extras/datasets/pandas/sql_dataset.py index 373663ce84..03b3c43aee 100644 --- a/kedro/extras/datasets/pandas/sql_dataset.py +++ b/kedro/extras/datasets/pandas/sql_dataset.py @@ -109,7 +109,8 @@ class SQLTableDataSet(AbstractDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -132,7 +133,7 @@ class SQLTableDataSet(AbstractDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import SQLTableDataSet @@ -280,7 +281,8 @@ class SQLQueryDataSet(AbstractDataset[None, pd.DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -311,9 +313,10 @@ class SQLQueryDataSet(AbstractDataset[None, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: + >>> from kedro.extras.datasets.pandas import SQLQueryDataSet >>> import pandas as pd >>> diff --git a/kedro/extras/datasets/pandas/xml_dataset.py b/kedro/extras/datasets/pandas/xml_dataset.py index ad91b4ad4b..30bd777252 100644 --- a/kedro/extras/datasets/pandas/xml_dataset.py +++ b/kedro/extras/datasets/pandas/xml_dataset.py @@ -32,7 +32,7 @@ class XMLDataSet(AbstractVersionedDataset[pd.DataFrame, pd.DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pandas import XMLDataSet diff --git a/kedro/extras/datasets/pickle/pickle_dataset.py b/kedro/extras/datasets/pickle/pickle_dataset.py index 19bda78f96..93bbbc2dbc 100644 --- a/kedro/extras/datasets/pickle/pickle_dataset.py +++ b/kedro/extras/datasets/pickle/pickle_dataset.py @@ -31,7 +31,8 @@ class PickleDataSet(AbstractVersionedDataset[Any, Any]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -50,7 +51,7 @@ class PickleDataSet(AbstractVersionedDataset[Any, Any]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pickle import PickleDataSet diff --git a/kedro/extras/datasets/pillow/image_dataset.py b/kedro/extras/datasets/pillow/image_dataset.py index 1244035df1..a403b74b27 100644 --- a/kedro/extras/datasets/pillow/image_dataset.py +++ b/kedro/extras/datasets/pillow/image_dataset.py @@ -27,7 +27,7 @@ class ImageDataSet(AbstractVersionedDataset[Image.Image, Image.Image]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.pillow import ImageDataSet diff --git a/kedro/extras/datasets/plotly/json_dataset.py b/kedro/extras/datasets/plotly/json_dataset.py index 5fa555d665..3c686ab896 100644 --- a/kedro/extras/datasets/plotly/json_dataset.py +++ b/kedro/extras/datasets/plotly/json_dataset.py @@ -29,7 +29,8 @@ class JSONDataSet( Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -41,7 +42,7 @@ class JSONDataSet( Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.plotly import JSONDataSet diff --git a/kedro/extras/datasets/plotly/plotly_dataset.py b/kedro/extras/datasets/plotly/plotly_dataset.py index 68dc27b012..7cb6477b25 100644 --- a/kedro/extras/datasets/plotly/plotly_dataset.py +++ b/kedro/extras/datasets/plotly/plotly_dataset.py @@ -28,7 +28,8 @@ class PlotlyDataSet(JSONDataSet): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -48,7 +49,7 @@ class PlotlyDataSet(JSONDataSet): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.plotly import PlotlyDataSet diff --git a/kedro/extras/datasets/redis/redis_dataset.py b/kedro/extras/datasets/redis/redis_dataset.py index bac3a15b65..d4d7b11f74 100644 --- a/kedro/extras/datasets/redis/redis_dataset.py +++ b/kedro/extras/datasets/redis/redis_dataset.py @@ -24,7 +24,8 @@ class PickleDataSet(AbstractDataset[Any, Any]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -45,7 +46,7 @@ class PickleDataSet(AbstractDataset[Any, Any]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.redis import PickleDataSet diff --git a/kedro/extras/datasets/spark/deltatable_dataset.py b/kedro/extras/datasets/spark/deltatable_dataset.py index 0f6655ac8c..6df51fcdd7 100644 --- a/kedro/extras/datasets/spark/deltatable_dataset.py +++ b/kedro/extras/datasets/spark/deltatable_dataset.py @@ -24,7 +24,8 @@ class DeltaTableDataSet(AbstractDataset[None, DeltaTable]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -39,7 +40,7 @@ class DeltaTableDataSet(AbstractDataset[None, DeltaTable]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from pyspark.sql import SparkSession diff --git a/kedro/extras/datasets/spark/spark_dataset.py b/kedro/extras/datasets/spark/spark_dataset.py index 317e173d24..0547b3e804 100644 --- a/kedro/extras/datasets/spark/spark_dataset.py +++ b/kedro/extras/datasets/spark/spark_dataset.py @@ -167,7 +167,8 @@ class SparkDataSet(AbstractVersionedDataset[DataFrame, DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -201,7 +202,7 @@ class SparkDataSet(AbstractVersionedDataset[DataFrame, DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from pyspark.sql import SparkSession diff --git a/kedro/extras/datasets/spark/spark_hive_dataset.py b/kedro/extras/datasets/spark/spark_hive_dataset.py index 2abbd1f166..746f7ae6df 100644 --- a/kedro/extras/datasets/spark/spark_hive_dataset.py +++ b/kedro/extras/datasets/spark/spark_hive_dataset.py @@ -33,7 +33,8 @@ class SparkHiveDataSet(AbstractDataset[DataFrame, DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -45,7 +46,7 @@ class SparkHiveDataSet(AbstractDataset[DataFrame, DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from pyspark.sql import SparkSession diff --git a/kedro/extras/datasets/spark/spark_jdbc_dataset.py b/kedro/extras/datasets/spark/spark_jdbc_dataset.py index 3abeeb312a..bacb492cbd 100644 --- a/kedro/extras/datasets/spark/spark_jdbc_dataset.py +++ b/kedro/extras/datasets/spark/spark_jdbc_dataset.py @@ -23,7 +23,8 @@ class SparkJDBCDataSet(AbstractDataset[DataFrame, DataFrame]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -41,7 +42,7 @@ class SparkJDBCDataSet(AbstractDataset[DataFrame, DataFrame]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> import pandas as pd diff --git a/kedro/extras/datasets/svmlight/svmlight_dataset.py b/kedro/extras/datasets/svmlight/svmlight_dataset.py index 697253ef2a..af4a1323ad 100644 --- a/kedro/extras/datasets/svmlight/svmlight_dataset.py +++ b/kedro/extras/datasets/svmlight/svmlight_dataset.py @@ -45,7 +45,8 @@ class SVMLightDataSet(AbstractVersionedDataset[_DI, _DO]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -70,7 +71,7 @@ class SVMLightDataSet(AbstractVersionedDataset[_DI, _DO]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.svmlight import SVMLightDataSet diff --git a/kedro/extras/datasets/tensorflow/tensorflow_model_dataset.py b/kedro/extras/datasets/tensorflow/tensorflow_model_dataset.py index c0e916d01f..ce6043b18d 100644 --- a/kedro/extras/datasets/tensorflow/tensorflow_model_dataset.py +++ b/kedro/extras/datasets/tensorflow/tensorflow_model_dataset.py @@ -31,7 +31,8 @@ class TensorFlowModelDataset(AbstractVersionedDataset[tf.keras.Model, tf.keras.M Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -47,7 +48,7 @@ class TensorFlowModelDataset(AbstractVersionedDataset[tf.keras.Model, tf.keras.M Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.tensorflow import TensorFlowModelDataset diff --git a/kedro/extras/datasets/text/text_dataset.py b/kedro/extras/datasets/text/text_dataset.py index 3c8a859445..253ee92826 100644 --- a/kedro/extras/datasets/text/text_dataset.py +++ b/kedro/extras/datasets/text/text_dataset.py @@ -26,7 +26,8 @@ class TextDataSet(AbstractVersionedDataset[str, str]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -36,7 +37,7 @@ class TextDataSet(AbstractVersionedDataset[str, str]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.text import TextDataSet diff --git a/kedro/extras/datasets/tracking/json_dataset.py b/kedro/extras/datasets/tracking/json_dataset.py index a77e162719..a41491492b 100644 --- a/kedro/extras/datasets/tracking/json_dataset.py +++ b/kedro/extras/datasets/tracking/json_dataset.py @@ -20,7 +20,8 @@ class JSONDataSet(JDS): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -30,7 +31,7 @@ class JSONDataSet(JDS): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.tracking import JSONDataSet diff --git a/kedro/extras/datasets/tracking/metrics_dataset.py b/kedro/extras/datasets/tracking/metrics_dataset.py index 3b615b6d64..b2a1949702 100644 --- a/kedro/extras/datasets/tracking/metrics_dataset.py +++ b/kedro/extras/datasets/tracking/metrics_dataset.py @@ -22,7 +22,8 @@ class MetricsDataSet(JSONDataSet): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -32,7 +33,7 @@ class MetricsDataSet(JSONDataSet): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.tracking import MetricsDataSet diff --git a/kedro/extras/datasets/video/video_dataset.py b/kedro/extras/datasets/video/video_dataset.py index 4f5e793f29..08e93126ec 100644 --- a/kedro/extras/datasets/video/video_dataset.py +++ b/kedro/extras/datasets/video/video_dataset.py @@ -198,7 +198,8 @@ class VideoDataSet(AbstractDataset[AbstractVideo, AbstractVideo]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -213,7 +214,7 @@ class VideoDataSet(AbstractDataset[AbstractVideo, AbstractVideo]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.video import VideoDataSet diff --git a/kedro/extras/datasets/yaml/yaml_dataset.py b/kedro/extras/datasets/yaml/yaml_dataset.py index 7ea2760cdf..a98e76314e 100644 --- a/kedro/extras/datasets/yaml/yaml_dataset.py +++ b/kedro/extras/datasets/yaml/yaml_dataset.py @@ -27,7 +27,8 @@ class YAMLDataSet(AbstractVersionedDataset[Dict, Dict]): Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -37,7 +38,7 @@ class YAMLDataSet(AbstractVersionedDataset[Dict, Dict]): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> from kedro.extras.datasets.yaml import YAMLDataSet diff --git a/kedro/io/partitioned_dataset.py b/kedro/io/partitioned_dataset.py index 66df5294a8..bccbd9e628 100644 --- a/kedro/io/partitioned_dataset.py +++ b/kedro/io/partitioned_dataset.py @@ -43,12 +43,13 @@ class PartitionedDataset(AbstractDataset): https://github.com/intake/filesystem_spec. It also supports advanced features like - `lazy saving `_. + `lazy saving `_. Example usage for the `YAML API `_: + data_catalog_yaml_examples.html>`_: + .. code-block:: yaml @@ -66,7 +67,7 @@ class PartitionedDataset(AbstractDataset): Example usage for the `Python API `_: + advanced_data_catalog_usage.html>`_: :: >>> import pandas as pd @@ -178,7 +179,7 @@ def __init__( # noqa: too-many-arguments and the dataset initializer. If the dataset config contains explicit credentials spec, then such spec will take precedence. All possible credentials management scenarios are documented here: - https://kedro.readthedocs.io/en/stable/data/kedro_io.html#partitioned-dataset-credentials + https://docs.kedro.org/en/stable/data/partitioned_and_incremental_datasets.html#partitioned-dataset-credentials load_args: Keyword arguments to be passed into ``find()`` method of the filesystem implementation. fs_args: Extra arguments to pass into underlying filesystem class constructor @@ -418,7 +419,7 @@ def __init__( # noqa: too-many-arguments with the corresponding dataset definition including ``filepath`` (unlike ``dataset`` argument). Checkpoint configuration is described here: - https://kedro.readthedocs.io/en/stable/data/kedro_io.html#checkpoint-configuration + https://docs.kedro.org/en/stable/data/partitioned_and_incremental_datasets.html#checkpoint-configuration Credentials for the checkpoint can be explicitly specified in this configuration. filepath_arg: Underlying dataset initializer argument that will @@ -433,7 +434,7 @@ def __init__( # noqa: too-many-arguments the dataset or the checkpoint configuration contains explicit credentials spec, then such spec will take precedence. All possible credentials management scenarios are documented here: - https://kedro.readthedocs.io/en/stable/data/kedro_io.html#partitioned-dataset-credentials + https://docs.kedro.org/en/stable/data/partitioned_and_incremental_datasets.html#checkpoint-configuration load_args: Keyword arguments to be passed into ``find()`` method of the filesystem implementation. fs_args: Extra arguments to pass into underlying filesystem class constructor diff --git a/setup.py b/setup.py index 139501feb1..afea8c9587 100644 --- a/setup.py +++ b/setup.py @@ -97,7 +97,7 @@ def _collect_requirements(requires): "sphinxcontrib-mermaid~=0.7.1", "myst-parser~=1.0.0", "Jinja2<3.1.0", - "kedro-datasets[all]~=1.6.0", + "kedro-datasets[all]~=1.7.0", ], "geopandas": _collect_requirements(geopandas_require), "matplotlib": _collect_requirements(matplotlib_require),