Enhance DataSet API Documentation example

See original GitHub issue

We want to improve our DataSet API documentation with examples of both YAML and Python API. When possible, the examples should be:

Simple and minimal
For Python API, it should be easy to copy & paste and run without error
Optionally, we can include more advanced examples

PRs are very welcomed🙏🏼! You don’t need to take all the DataSet at once.

Contributor Guide

You can find our Contributor Guide on how to setup kedro locally and make changes and PR.

DataSet API ordered base on usage

ParquetDataSet(In progress: #1844 )
APIDataSet (In progress: #1844 )
pandas.FeatherDataSet(In progress: #1844 )
yaml.YAMLDataSet(In progress: #1844 )
tracking.JSONDataSet(In progress: #1844 )
tracking.MetricsDataSet(In progress: #1844 )
TensorFlowModelDataset(In progress: #1844 )

Less common datasets:

_Originally posted by @noklam in https://github.com/kedro-org/kedro/issues/579#issuecomment-1102384971_, slightly edited

Issue Analytics

State:
Created a year ago
Reactions:2
Comments:13 (11 by maintainers)

Top GitHub Comments

1reaction

noklamcommented, Nov 14, 2022

@luizvbo Sorry for the late reply. If it’s a quick one you can still open in this repository, at the moment we are trying to migrate, once we finished we expect all new changes go to kedro-datasets

1reaction

noklamcommented, Aug 9, 2022

@levimjoseph Awesome, feel free to make a draft PR when you have something, it doesn’t have to be completely ready so we have a chance to have a look at it. As this could become a big PR.

Top Results From Across the Web

How to Write API Documentation: Best Practices and Examples

Creating good docs is almost as important as building a good API. So how do you write great API docs?

Sample Web & REST API Documentation Template Examples

In this post, we'll outline a shortcut for documenting your API and provide example templates you can use to create great docs for...

How to Write Good API Documentation - freeCodeCamp

This documentation by Github includes an overview, guides, and even code on how to use REST API in your program.

Documenting APIs - gov.data.resources

Agencies should list private, internal, and public-facing web APIs as part of their Enterprise Data Inventory and Public Data Listing data.json files.

Refresh Dataset - Power BI REST APIs - Microsoft Learn

Reference. Feedback. Service: Power BI REST APIs. API Version: v1.0. Triggers a refresh for the specified dataset from My workspace. An enhanced refresh...