[
https://issues.apache.org/jira/browse/BEAM-7700?focusedWorklogId=282475&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-282475
]
ASF GitHub Bot logged work on BEAM-7700:
----------------------------------------
Author: ASF GitHub Bot
Created on: 25/Jul/19 06:51
Start Date: 25/Jul/19 06:51
Worklog Time Spent: 10m
Work Description: robinyqiu commented on pull request #9129: [BEAM-7700]
Java transform catalog
URL: https://github.com/apache/beam/pull/9129#discussion_r307121517
##########
File path: website/src/documentation/transforms/java/element-wise/pardo.md
##########
@@ -0,0 +1,151 @@
+---
+layout: section
+title: "ParDo"
+permalink: /documentation/transforms/java/elementwise/pardo/
+section_menu: section-menu/documentation.html
+---
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+# ParDo
+<table align="left">
+ <a target="_blank" class="button"
+
href="https://beam.apache.org/releases/javadoc/current/index.html?org/apache/beam/sdk/transforms/ParDo.html";>
+ <img src="https://beam.apache.org/images/logos/sdks/java.png";
width="20px" height="20px"
+ alt="Javadoc" />
+ Javadoc
+ </a>
+</table>
+<br>
+A transform for generic parallel processing. A `ParDo` transform considers each
+element in the input `PCollection`, performs some processing function
+(your user code) on that element, and emits zero or more elements to
+an output PCollection.
+
+See more information in the [Beam Programming Guide]({{ site.baseurl
}}/documentation/programming-guide/#pardo).
+
+## Examples
+**Example 1**: Passing side inputs
+
+```java
+ // Pass side inputs to your ParDo transform by invoking .withSideInputs.
+ // Inside your DoFn, access the side input by using the method
DoFn.ProcessContext.sideInput.
+
+ // The input PCollection to ParDo.
+ PCollection<String> words = ...;
+
+ // A PCollection of word lengths that we'll combine into a single value.
+ PCollection<Integer> wordLengths = ...; // Singleton PCollection
+
+ // Create a singleton PCollectionView from wordLengths using
Combine.globally and View.asSingleton.
+ final PCollectionView<Integer> maxWordLengthCutOffView =
+ wordLengths.apply(Combine.globally(new Max.MaxIntFn()).asSingletonView());
+
+
+ // Apply a ParDo that takes maxWordLengthCutOffView as a side input.
+ PCollection<String> wordsBelowCutOff =
+ words.apply(ParDo
+ .of(new DoFn<String, String>() {
+ public void processElement(ProcessContext c) {
+ String word = c.element();
+ // In our DoFn, access the side input.
+ int lengthCutOff = c.sideInput(maxWordLengthCutOffView);
+ if (word.length() <= lengthCutOff) {
+ c.output(word);
+ }
+ }
+ }).withSideInputs(maxWordLengthCutOffView)
+ );
+```
+
+**Example 2**: Emitting to multiple outputs in your `DoFn`
+
+```java
+// Inside your ParDo's DoFn, you can emit an element to a specific output
PCollection by passing in the
+// appropriate TupleTag when you call ProcessContext.output.
+// After your ParDo, extract the resulting output PCollections from the
returned PCollectionTuple.
+// Based on the previous example, this shows the DoFn emitting to the main
output and two additional outputs.
+
+ .of(new DoFn<String, String>() {
Review comment:
Swap Example2 and 3? Otherwise it is very confusing what the tags are.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 282475)
Time Spent: 1h 40m (was: 1.5h)
> Java transform catalog
> ----------------------
>
> Key: BEAM-7700
> URL: https://issues.apache.org/jira/browse/BEAM-7700
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: Rose Nguyen
> Assignee: Rose Nguyen
> Priority: Minor
> Time Spent: 1h 40m
> Remaining Estimate: 0h
>
> Create catalog of core transforms (Java)
> -Java transforms overview
> -Links to Javadocs
> -Brief description
> -Related transforms
> -Links to programming guide
> -Examples section to integrate Colab notebooks
>
> See BEAM-7464 for Python.
--
This message was sent by Atlassian JIRA
(v7.6.14#76016)
![https://beam.apache.org/images/logos/sdks/java.png"](https://beam.apache.org/images/logos/sdks/java.png"){kind=link}