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

Missing Transcoding dataset in docs #3676

Closed
noklam opened this issue Mar 4, 2024 · 1 comment
Closed

Missing Transcoding dataset in docs #3676

noklam opened this issue Mar 4, 2024 · 1 comment
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@noklam
Copy link
Contributor

noklam commented Mar 4, 2024

Description

Bring back the docs for transcoding dataset, which still existed in the 0.18.x docs:
0.18.12: https://docs.kedro.org/en/0.18.12/data/data_catalog.html#transcode-datasets

Context

The current docs have a few mentions of the transcoding, but no clear explanation anymore. This was likely removed by accident.

0.19.3:
image

There are few example using transcoding dataset, but there should be a dedicate section explaining what is it and why is it useful (the pyspark example should be a good one).

@ElenaKhaustova
Copy link
Contributor

Some extra context:

  1. Section that presented in the docs before: https://docs.kedro.org/en/0.18.5/data/data_catalog.html#a-typical-example-of-transcoding
  2. Previously in starters we had examples of using transcoding datasets that causing cyclic dependencies and shouldn't be allowed: Toposort fails when using transcoded datasets #3799 (comment)
  3. Based on the above we should return a separate section and clarify the docs, particularly: provide some details on how the mechanism works, keep the example with pyspark, provide some examples of what is not supported with the corresponding explanations

@ElenaKhaustova ElenaKhaustova moved this from In Progress to In Review in Kedro Framework Apr 29, 2024
@ElenaKhaustova ElenaKhaustova moved this from In Review to Done in Kedro Framework Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

No branches or pull requests

3 participants