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

[KED-1395] Document all datasets in kedro.extras.datasets #232

Closed
yetudada opened this issue Feb 26, 2020 · 4 comments
Closed

[KED-1395] Document all datasets in kedro.extras.datasets #232

yetudada opened this issue Feb 26, 2020 · 4 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@yetudada
Copy link
Contributor

Description

  • Our contribution process has changed recently with the introduction of kedro.extras, the new 🏡 for all of our datasets, decorators and transformers.
  • It's in this place that all contributor can add extensions to Kedro
  • We want to track contributions to kedro.extras.datasets by including a directory-level README.md that describes what's in this directory
  • This could be a table or even paragraph description of what you'll find here

Context

  • It will help us keep track of all of the amazing contributions that the open source developers make
  • It also gives users a high-level view of all the datasets we support in kedro.extras.datasets

Possible Implementation

We're thinking of doing something like this in this doc

pandas

Dataset Name Saving Mechanism Creator
CSVDataSet pandas QuantumBlack
... ... ...

spark

Dataset Name Saving Mechanism Creator
SparkDataSet spark QuantumBlack
... ... ...

...

@yetudada yetudada added good first issue Component: Documentation 📄 Issue/PR for markdown and API documentation labels Feb 26, 2020
@Klio-Foxtrot187
Copy link
Contributor

I am working on this task at the moment.

@yetudada
Copy link
Contributor Author

yetudada commented Mar 9, 2020

@Klio-Foxtrot187 Let us know how you're getting on with this. Thank you so much for helping us!

@yetudada yetudada changed the title Document all datasets in kedro.extras.datasets [KED-1395] Document all datasets in kedro.extras.datasets Mar 9, 2020
@Klio-Foxtrot187
Copy link
Contributor

@Klio-Foxtrot187 Let us know how you're getting on with this. Thank you so much for helping us!

Hi, apologies for the delay as I am currently in my exam week, with resume with this next week!

@yetudada
Copy link
Contributor Author

We merged this as part of #305

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

2 participants