Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions kedro-datasets/RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Upcoming Release
## Major features and improvements
## Bug fixes and other changes
- Fixed `optuna.StudyDataset` documentation page by converting docstring from reStructuredText to Markdown and adding missing doc page header.
Comment thread
gtauzin marked this conversation as resolved.
Outdated
## Community contributions
Comment thread
gtauzin marked this conversation as resolved.
Outdated

# Release 9.3.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# StudyDataset

`StudyDataset` loads and saves data from/to an Optuna study.

::: kedro_datasets_experimental.optuna.StudyDataset
options:
members: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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__,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.kedro.org/en/stable/catalog-data/data_catalog_yaml_examples/>`_:

.. 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
Expand All @@ -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 <https://docs.kedro.org/en/stable/data/\
advanced_data_catalog_usage.html>`_:

.. 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
Expand All @@ -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}
Expand Down
Loading