apache / apache/beam

Update to_dataframe API Docs to focus on schema use

Open
#21,131 1 comment 0 reactions 0 assignees View on GitHub
dataframe P3 task
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
1d 20h
Merged PRs (30d)
196

Description

The API documentation for to_dataframe (https://beam.apache.org/releases/pydoc/2.32.0/apache_beam.dataframe.convert.html#apache_beam.dataframe.convert.to_dataframe) is very sparse. It also focuses on specifying a proxy, rather than relying a schema-aware PCollection as an input. This function is often people's entrypoint into the API, so we should make it very clear how to use it. Let's expand the documentation, and focus on using schemas rather than specifying a proxy.

We should also link to the documentation for to_dataframe in https://beam.apache.org/documentation/dsls/dataframes/overview/#embedding-dataframes-in-a-pipeline

Imported from Jira [BEAM-13002](https://issues.apache.org/jira/browse/BEAM-13002). Original Jira may contain additional context.
Reported by: bhulette.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.