Add documentation about nodes with generator functions #2302
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
merelcht
reviewed
Feb 10, 2023
idanov
reviewed
Feb 10, 2023
There was a problem hiding this comment.
It's a good start and I think it should read like a mini-tutorial, obviously skipping the parts of creating the example project, but mentioning that we are working on the pandas-iris example for demonstrating the functionality. The goal here is to enable the users to be able to reproduce what you have done to get it working.
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
…com/kedro-org/kedro into docs/nodes-with-generator-functions Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com> Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
merelcht
approved these changes
Feb 10, 2023
There was a problem hiding this comment.
I think this is a great explanation! 👍 I'd maybe ask @stichbury to have a look at this as well.
stichbury
reviewed
Feb 10, 2023
stichbury
reviewed
Feb 10, 2023
stichbury
reviewed
Feb 10, 2023
stichbury
reviewed
Feb 10, 2023
stichbury
reviewed
Feb 10, 2023
stichbury
reviewed
Feb 10, 2023
stichbury
reviewed
Feb 10, 2023
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
stichbury
reviewed
Feb 13, 2023
stichbury
reviewed
Feb 13, 2023
stichbury
approved these changes
Feb 13, 2023
Signed-off-by: SajidAlamQB <90610031+SajidAlamQB@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: SajidAlamQB 90610031+SajidAlamQB@users.noreply.github.com
Description
Related to: #2170
After introducing the ability to wrap generator functions in Kedro in #2161, we should add an example in the docs how this can be leveraged to process large datasets in chunks. The example can show a repurposed
split_datasetfunction to process chunk-wise data: https://github.com/kedro-org/kedro-starters/blob/main/pandas-iris/%7B%7B%20cookiecutter.repo_name%20%7D%7D/src/%7B%7B%20cookiecutter.python_package%20%7D%7D/nodes.py#L13In the example, we should also implement a custom
DataSet, which saves the data in an append-or-create mode (a+mode).Development notes
Checklist
RELEASE.mdfile