diff --git a/kedro-datasets/RELEASE.md b/kedro-datasets/RELEASE.md index 7798c23bb..2f6e0505b 100755 --- a/kedro-datasets/RELEASE.md +++ b/kedro-datasets/RELEASE.md @@ -1,4 +1,5 @@ # Upcoming Release + ## Major features and improvements - Added the following new **experimental** datasets: @@ -7,6 +8,8 @@ | ------------------------------------ | ---------------------------------------------------- | -------------------------------------- | | `opik.EvaluationDataset` | A dataset for managing Opik evaluation datasets. | `kedro_datasets_experimental.opik` | +## Bug fixes and other changes + ## Breaking changes to experimental datasets - Renamed dataset classes and shortened `pyproject.toml` extra names for `langfuse`, `opik`, and `langchain` experimental datasets. The redundant package-family prefix has been dropped: - Classes: @@ -32,6 +35,7 @@ Many thanks to the following Kedroids for contributing PRs to this release: - [Datascienceio](https://github.com/datascienceio) +- [Guillaume Tauzin](https://github.com/gtauzin) # Release 9.3.0 @@ -61,13 +65,13 @@ Many thanks to the following Kedroids for contributing PRs to this release: Many thanks to the following Kedroids for contributing PRs to this release: -[Priyanka](https://github.com/priya-gitTest) -[Akumawavez](https://github.com/akumawavez) -[Joris](https://github.com/jorisvane) -[Bas-commits](https://github.com/Bas-commits) -[oomenn](https://github.com/oomenn) -[Celina](https://github.com/celinaczy) -[Juanchodpg2](https://github.com/juanchodpg2) +- [Priyanka](https://github.com/priya-gitTest) +- [Akumawavez](https://github.com/akumawavez) +- [Joris](https://github.com/jorisvane) +- [Bas-commits](https://github.com/Bas-commits) +- [oomenn](https://github.com/oomenn) +- [Celina](https://github.com/celinaczy) +- [Juanchodpg2](https://github.com/juanchodpg2) # Release 9.2.0 @@ -94,7 +98,7 @@ Many thanks to the following Kedroids for contributing PRs to this release: Many thanks to the following Kedroids for contributing PRs to this release: -[Katerina Molchanova](https://github.com/rokatyy) +- [Katerina Molchanova](https://github.com/rokatyy) # Release 9.1.1 diff --git a/kedro-datasets/docs/api/kedro_datasets_experimental/optuna.StudyDataset.md b/kedro-datasets/docs/api/kedro_datasets_experimental/optuna.StudyDataset.md index 4de9b7664..04ced0b7f 100644 --- a/kedro-datasets/docs/api/kedro_datasets_experimental/optuna.StudyDataset.md +++ b/kedro-datasets/docs/api/kedro_datasets_experimental/optuna.StudyDataset.md @@ -1,3 +1,7 @@ +# StudyDataset + +`StudyDataset` loads and saves data from/to an Optuna study. + ::: kedro_datasets_experimental.optuna.StudyDataset options: members: true diff --git a/kedro-datasets/kedro_datasets_experimental/optuna/__init__.py b/kedro-datasets/kedro_datasets_experimental/optuna/__init__.py index 5d09bbac7..93bc98013 100644 --- a/kedro-datasets/kedro_datasets_experimental/optuna/__init__.py +++ b/kedro-datasets/kedro_datasets_experimental/optuna/__init__.py @@ -4,7 +4,12 @@ import lazy_loader as lazy -StudyDataset: Any +try: + from .study_dataset import StudyDataset +except (ImportError, RuntimeError): + # For documentation builds that might fail due to dependency issues + # https://github.com/pylint-dev/pylint/issues/4300#issuecomment-1043601901 + StudyDataset: Any __getattr__, __dir__, __all__ = lazy.attach( __name__, diff --git a/kedro-datasets/kedro_datasets_experimental/optuna/study_dataset.py b/kedro-datasets/kedro_datasets_experimental/optuna/study_dataset.py index 28a8d47c4..3c5dfe6b9 100644 --- a/kedro-datasets/kedro_datasets_experimental/optuna/study_dataset.py +++ b/kedro-datasets/kedro_datasets_experimental/optuna/study_dataset.py @@ -24,11 +24,10 @@ class StudyDataset(AbstractVersionedDataset[optuna.Study, optuna.Study]): """``StudyDataset`` loads/saves data from/to an optuna Study. - Example usage for the - `YAML API `_: - - .. code-block:: yaml + Examples: + Using the [YAML API](https://docs.kedro.org/en/stable/catalog-data/data_catalog_yaml_examples/): + ```yaml review_prediction_study: type: kedro_datasets_experimental.optuna.StudyDataset backend: sqlite @@ -47,12 +46,9 @@ class StudyDataset(AbstractVersionedDataset[optuna.Study, optuna.Study]): backend: postgresql database: optuna_db credentials: dev_optuna_postgresql + ``` - Example usage for the - `Python API `_: - - .. code-block:: pycon + Using the [Python API](https://docs.kedro.org/en/stable/data/advanced_data_catalog_usage.html): >>> from kedro_datasets_experimental.optuna import StudyDataset >>> from optuna.distributions import FloatDistribution @@ -71,6 +67,7 @@ class StudyDataset(AbstractVersionedDataset[optuna.Study, optuna.Study]): >>> reloaded = dataset.load() >>> assert len(reloaded.trials) == 1 >>> assert reloaded.trials[0].params["x"] == 2.0 + """ DEFAULT_LOAD_ARGS: dict[str, Any] = {"sampler": None, "pruner": None}