Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete kedro.extras.datasets and related tests #3044

Closed
wants to merge 4 commits into from

Conversation

noklam
Copy link
Contributor

@noklam noklam commented Sep 18, 2023

Signed-off-by: Nok nok.lam.chan@quantumblack.com

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

Fix #2125

Development notes

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

lrcouto and others added 4 commits September 13, 2023 16:03
…umentation. (#2991)

* Add configloader deprecation notices for configuration pages

Signed-off-by: lrcouto <laurarccouto@gmail.com>

* Some more changes to configuration docs

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Some more changes to configuration docs

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update automated testing example with OCL

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Change text as per Vale suggestions

Signed-off-by: lrcouto <laurarccouto@gmail.com>

* Changes to text structure and tables of content

Signed-off-by: lrcouto <laurarccouto@gmail.com>

* Changes to style and formatting

Signed-off-by: lrcouto <laurarccouto@gmail.com>

* Revert tables of content

Signed-off-by: lrcouto <laurarccouto@gmail.com>

* Changes to the list of headings

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

---------

Signed-off-by: lrcouto <laurarccouto@gmail.com>
Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
Co-authored-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com>
Co-authored-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
* Update robots.txt to hide older versions of the docs

Signed-off-by: Tynan DeBold <thdebold@gmail.com>

* Update robots.txt

Signed-off-by: Tynan DeBold <thdebold@gmail.com>

---------

Signed-off-by: Tynan DeBold <thdebold@gmail.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Remove unneeded :code: word

Signed-off-by: Guillermo Lozano Branger <glozanobranger@gmail.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
@noklam noklam changed the base branch from main to develop September 18, 2023 14:18
@@ -61,10 +61,10 @@ Refer to the following table below for a high level guide to each layer's purpos
| Folder in data | Description |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Raw | Initial start of the pipeline, containing the sourced data model(s) that should never be changed, it forms your single source of truth to work from. These data models are typically un-typed in most cases e.g. csv, but this will vary from case to case |
| Intermediate | Optional data model(s), which are introduced to type your :code:`raw` data model(s), e.g. converting string based values into their current typed representation |
| Intermediate | Optional data model(s), which are introduced to type your `raw` data model(s), e.g. converting string based values into their current typed representation |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.'.

| Primary | Domain specific data model(s) containing cleansed, transformed and wrangled data from either `raw` or `intermediate`, which forms your layer that you input into your feature engineering |
| Feature | Analytics specific data model(s) containing a set of features defined against the `primary` data, which are grouped by feature area of analysis and stored against a common dimension |
| Model input | Analytics specific data model(s) containing all :code:`feature` data against a common dimension and in the case of live projects against an analytics run date to ensure that you track the historical changes of the features over time |
| Model input | Analytics specific data model(s) containing all `feature` data against a common dimension and in the case of live projects against an analytics run date to ensure that you track the historical changes of the features over time |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Kedro.toowordy] 'in the case of' is too wordy

* [`ConfigLoader`](/kedro.config.ConfigLoader)
* [`TemplatedConfigLoader`](/kedro.config.TemplatedConfigLoader)
* [`OmegaConfigLoader`](/kedro.config.OmegaConfigLoader).

By default, Kedro uses the `ConfigLoader` and, in the following sections and examples, you can assume the default `ConfigLoader` is used, unless otherwise specified. The [advanced configuration documentation](./advanced_configuration.md) covers use of the [`TemplatedConfigLoader`](/kedro.config.TemplatedConfigLoader) and [`OmegaConfigLoader`](/kedro.config.OmegaConfigLoader) in more detail.
By default, Kedro uses the `ConfigLoader`. However, in projects created with Kedro `0.18.13` onwards, `OmegaConfigLoader` has been set as the config loader as the default in the project's `src/<package_name>/settings.py` file.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Kedro.toowordy] 'However' is too wordy

* [`ConfigLoader`](/kedro.config.ConfigLoader)
* [`TemplatedConfigLoader`](/kedro.config.TemplatedConfigLoader)
* [`OmegaConfigLoader`](/kedro.config.OmegaConfigLoader).

By default, Kedro uses the `ConfigLoader` and, in the following sections and examples, you can assume the default `ConfigLoader` is used, unless otherwise specified. The [advanced configuration documentation](./advanced_configuration.md) covers use of the [`TemplatedConfigLoader`](/kedro.config.TemplatedConfigLoader) and [`OmegaConfigLoader`](/kedro.config.OmegaConfigLoader) in more detail.
By default, Kedro uses the `ConfigLoader`. However, in projects created with Kedro `0.18.13` onwards, `OmegaConfigLoader` has been set as the config loader as the default in the project's `src/<package_name>/settings.py` file.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Kedro.Spellings] Did you really mean 'onwards'?

@@ -35,7 +48,8 @@ Do not add any local configuration to version control.
```

## Configuration loading
Kedro-specific configuration (e.g., `DataCatalog` configuration for I/O) is loaded using a configuration loader class, by default, this is [`ConfigLoader`](/kedro.config.ConfigLoader).
Kedro-specific configuration (e.g., `DataCatalog` configuration for I/O) is loaded using a configuration loader class, by default, this is [`ConfigLoader`](/kedro.config.ConfigLoader) for

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.

@@ -35,7 +48,8 @@ Do not add any local configuration to version control.
```

## Configuration loading
Kedro-specific configuration (e.g., `DataCatalog` configuration for I/O) is loaded using a configuration loader class, by default, this is [`ConfigLoader`](/kedro.config.ConfigLoader).
Kedro-specific configuration (e.g., `DataCatalog` configuration for I/O) is loaded using a configuration loader class, by default, this is [`ConfigLoader`](/kedro.config.ConfigLoader) for

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Kedro.abbreviations] Use 'for example' instead of abbreviations like 'e.g.,'.

@@ -35,7 +48,8 @@ Do not add any local configuration to version control.
```

## Configuration loading
Kedro-specific configuration (e.g., `DataCatalog` configuration for I/O) is loaded using a configuration loader class, by default, this is [`ConfigLoader`](/kedro.config.ConfigLoader).
Kedro-specific configuration (e.g., `DataCatalog` configuration for I/O) is loaded using a configuration loader class, by default, this is [`ConfigLoader`](/kedro.config.ConfigLoader) for
projects created with Kedro `0.18.13` or older and has been set to `OmegaConfigLoader` for projects created with Kedro `0.18.13` onwards.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Kedro.Spellings] Did you really mean 'onwards'?

@@ -4,8 +4,38 @@ The documentation on [configuration](./configuration_basics.md) describes how to
By default, Kedro is set up to use the [ConfigLoader](/kedro.config.ConfigLoader) class. Kedro also provides two additional configuration loaders with more advanced functionality: the [TemplatedConfigLoader](/kedro.config.TemplatedConfigLoader) and the [OmegaConfigLoader](/kedro.config.OmegaConfigLoader).
Each of these classes are alternatives for the default `ConfigLoader` and have different features. The following sections describe each of these classes and their specific functionality in more detail.

## OmegaConfigLoader

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Kedro.headings] 'OmegaConfigLoader' should use sentence-style capitalization.

@@ -4,8 +4,38 @@ The documentation on [configuration](./configuration_basics.md) describes how to
By default, Kedro is set up to use the [ConfigLoader](/kedro.config.ConfigLoader) class. Kedro also provides two additional configuration loaders with more advanced functionality: the [TemplatedConfigLoader](/kedro.config.TemplatedConfigLoader) and the [OmegaConfigLoader](/kedro.config.OmegaConfigLoader).
Each of these classes are alternatives for the default `ConfigLoader` and have different features. The following sections describe each of these classes and their specific functionality in more detail.

## OmegaConfigLoader

[OmegaConf](https://omegaconf.readthedocs.io/) is a Python library designed to handle and manage settings. It serves as a YAML-based hierarchical system to organise configurations, which can be structured to accommodate various sources, allowing you to merge settings from multiple locations.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Kedro.toowordy] 'multiple' is too wordy

@noklam noklam marked this pull request as draft September 18, 2023 14:19
@noklam
Copy link
Contributor Author

noklam commented Sep 21, 2023

Messed up with the branch - will start from scratch and close this one.

@noklam noklam closed this Sep 21, 2023
@noklam noklam deleted the noklam/remove-kedro-extras-datasets-2126 branch September 21, 2023 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make Kedro not instantiate datasets from kedro.extras.datasets
4 participants