beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tibor Kiss (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (BEAM-1695) Improve Python-SDK's programming guide
Date Thu, 27 Apr 2017 11:47:04 GMT

     [ https://issues.apache.org/jira/browse/BEAM-1695?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Tibor Kiss updated BEAM-1695:
-----------------------------
    Description: 
Beam's programming guide provides a tutorial-like structure to introduce the user to the main
concepts.

Due to flaws of the snippets the copied code needs altering to work.
Some of the problems:
* Section "Creating the pipeline"
** {{import apache_beam as beam}} statement is missing from the beginning
** The command line arguments are not parsed
* Section "Creating a PCollection from in-memory data"
** {{pipeline_options}} variable is undefined
** {{my_options}} variable is undefined
* Section "ParDo": 
** It is not explained how to define {{words}} variable
* Section "Advanced combinations using CombineFn" and "Combining a PCollection into a single
value" has the same code snippet
* Section "Combining values in a key-grouped collection":
** -It is not explained how to define {{player_accuracies}}-
* Section "Using Flatten and Partition"
** The code snippet contains unnecessary markers ({{[START model_multiple_pcollections_tuple]}})
* Section "partition":
** {{students}} variable is undefined

This list might not be complete.

The website's repo is located at: https://github.com/apache/beam-site
The snippets are taken from: https://github.com/apache/beam/blob/master/sdks/python/apache_beam/examples/snippets/snippets.py



  was:
Beam's programming guide provides a tutorial-like structure to introduce the user to the main
concepts.

Due to flaws of the snippets the copied code needs altering to work.
Some of the problems:
* Section "Creating the pipeline"
** {{import apache_beam as beam}} statement is missing from the beginning
** The command line arguments are not parsed
* Section "Creating a PCollection from in-memory data"
** {{pipeline_options}} variable is undefined
** {{my_options}} variable is undefined
* Section "ParDo": 
** It is not explained how to define {{words}} variable
* Section "Advanced combinations using CombineFn" and "Combining a PCollection into a single
value" has the same code snippet
* Section "Combining values in a key-grouped collection":
** ~It is not explained how to define {{player_accuracies}}~
* Section "Using Flatten and Partition"
** The code snippet contains unnecessary markers ({{[START model_multiple_pcollections_tuple]}})
* Section "partition":
** {{students}} variable is undefined

This list might not be complete.

The website's repo is located at: https://github.com/apache/beam-site
The snippets are taken from: https://github.com/apache/beam/blob/master/sdks/python/apache_beam/examples/snippets/snippets.py




> Improve Python-SDK's programming guide
> --------------------------------------
>
>                 Key: BEAM-1695
>                 URL: https://issues.apache.org/jira/browse/BEAM-1695
>             Project: Beam
>          Issue Type: Bug
>          Components: website
>            Reporter: Tibor Kiss
>            Assignee: Tibor Kiss
>            Priority: Minor
>              Labels: newbie, starter
>
> Beam's programming guide provides a tutorial-like structure to introduce the user to
the main concepts.
> Due to flaws of the snippets the copied code needs altering to work.
> Some of the problems:
> * Section "Creating the pipeline"
> ** {{import apache_beam as beam}} statement is missing from the beginning
> ** The command line arguments are not parsed
> * Section "Creating a PCollection from in-memory data"
> ** {{pipeline_options}} variable is undefined
> ** {{my_options}} variable is undefined
> * Section "ParDo": 
> ** It is not explained how to define {{words}} variable
> * Section "Advanced combinations using CombineFn" and "Combining a PCollection into a
single value" has the same code snippet
> * Section "Combining values in a key-grouped collection":
> ** -It is not explained how to define {{player_accuracies}}-
> * Section "Using Flatten and Partition"
> ** The code snippet contains unnecessary markers ({{[START model_multiple_pcollections_tuple]}})
> * Section "partition":
> ** {{students}} variable is undefined
> This list might not be complete.
> The website's repo is located at: https://github.com/apache/beam-site
> The snippets are taken from: https://github.com/apache/beam/blob/master/sdks/python/apache_beam/examples/snippets/snippets.py



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Mime
View raw message