This is an automated email from the ASF dual-hosted git repository.
damccorm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new 277b6c3dbe5 Update python transform catalog (#30788)
277b6c3dbe5 is described below
commit 277b6c3dbe53d3dbeb6ecf62fa1aaa0936930327
Author: Hai Joey Tran <[email protected]>
AuthorDate: Tue Apr 16 12:42:51 2024 -0400
Update python transform catalog (#30788)
* Remove unavailable transforms from catalog
* Implement approximatequantile example
* add context to groupbykey example
* add in live groupbykey sort in example
* add approximatequantiles example and update catalog
* Add approximateunique example and link to catalog
* fix approxquantiles reference
* update approximateunique catalog entry
* dd batchelements into catalog
* Conform approx examples to referencing transforms directly on beam
* yapf
* add batchelements example page
* fix approximateunique extra pipeline
* fix approximatequantiles
* fix lint
* fix lint
* fix typo in distinct example
* isort
* yapf
* add tolist to catalog
* yapf
* update context lines
* run isort
* isort
* rework asserts for batchelements_test.py
* update tolist test
* add tolist to transform catalog table
* update navbar
* yapf
* isort
* Lint fixes
---------
Co-authored-by: Danny McCormick <[email protected]>
---
.../Core Transforms/GroupByKey/GroupByKey/task.py | 2 +
.../transforms/aggregation/approximatequantiles.py | 51 +++++++++++++++++
.../aggregation/approximatequantiles_test.py | 46 +++++++++++++++
.../transforms/aggregation/approximateunique.py | 51 +++++++++++++++++
.../aggregation/approximateunique_test.py | 54 ++++++++++++++++++
.../transforms/aggregation/batchelements.py | 64 +++++++++++++++++++++
.../transforms/aggregation/batchelements_test.py | 65 ++++++++++++++++++++++
.../snippets/transforms/aggregation/tolist.py | 51 +++++++++++++++++
.../snippets/transforms/aggregation/tolist_test.py | 60 ++++++++++++++++++++
.../python/aggregation/approximatequantiles.md | 9 ++-
.../python/aggregation/approximateunique.md | 9 ++-
.../{approximatequantiles.md => batchelements.md} | 14 ++++-
.../transforms/python/aggregation/groupbykey.md | 14 +----
.../{approximatequantiles.md => tolist.md} | 13 +++--
.../en/documentation/transforms/python/overview.md | 9 ++-
.../partials/section-menu/en/documentation.html | 3 +
16 files changed, 490 insertions(+), 25 deletions(-)
diff --git a/learning/katas/python/Core
Transforms/GroupByKey/GroupByKey/task.py b/learning/katas/python/Core
Transforms/GroupByKey/GroupByKey/task.py
index 7e5d3fb954f..2832de39cad 100644
--- a/learning/katas/python/Core Transforms/GroupByKey/GroupByKey/task.py
+++ b/learning/katas/python/Core Transforms/GroupByKey/GroupByKey/task.py
@@ -27,6 +27,7 @@
# - group
# - strings
+# [START groupbykey]
import apache_beam as beam
with beam.Pipeline() as p:
@@ -35,3 +36,4 @@ with beam.Pipeline() as p:
| beam.Map(lambda word: (word[0], word))
| beam.GroupByKey()
| beam.LogElements())
+# [END groupbykey]
diff --git
a/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximatequantiles.py
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximatequantiles.py
new file mode 100644
index 00000000000..e0f6b8e9140
--- /dev/null
+++
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximatequantiles.py
@@ -0,0 +1,51 @@
+# coding=utf-8
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+
+# pytype: skip-file
+# pylint:disable=line-too-long
+
+# beam-playground:
+# name: AppromximateQuantiles
+# description: Demonstration of ApproximateQuantiles transform usage.
+# multifile: false
+# default_example: false
+# context_line: 37
+# categories:
+# complexity: BASIC
+# tags:
+# - transforms
+# - integers
+
+
+def approximatequantiles(test=None):
+ # [START quantiles]
+ import apache_beam as beam
+
+ with beam.Pipeline() as pipeline:
+ quantiles = (
+ pipeline
+ | 'Create data' >> beam.Create(list(range(1001)))
+ | 'Compute quantiles' >> beam.ApproximateQuantiles.Globally(5)
+ | beam.Map(print))
+ # [END approximatequantiles]
+ if test:
+ test(quantiles)
+
+
+if __name__ == '__main__':
+ approximatequantiles()
diff --git
a/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximatequantiles_test.py
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximatequantiles_test.py
new file mode 100644
index 00000000000..2adfcd05b99
--- /dev/null
+++
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximatequantiles_test.py
@@ -0,0 +1,46 @@
+# coding=utf-8
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+
+# pytype: skip-file
+
+import unittest
+
+import mock
+
+from apache_beam.testing.test_pipeline import TestPipeline
+from apache_beam.testing.util import assert_that
+from apache_beam.testing.util import equal_to
+
+from . import approximatequantiles
+
+
[email protected]('apache_beam.Pipeline', TestPipeline)
[email protected](
+ 'apache_beam.examples.snippets.transforms.aggregation.'
+ 'approximatequantiles.print',
+ lambda x: x)
+class ApproximateQuantilesTest(unittest.TestCase):
+ def test_approximatequantiles(self):
+ def check_result(quantiles):
+ assert_that(quantiles, equal_to([[0, 250, 500, 750, 1000]]))
+
+ approximatequantiles.approximatequantiles(test=check_result)
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git
a/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximateunique.py
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximateunique.py
new file mode 100644
index 00000000000..e86f8e3eb56
--- /dev/null
+++
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximateunique.py
@@ -0,0 +1,51 @@
+# coding=utf-8
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+
+# pytype: skip-file
+# pylint:disable=line-too-long
+
+# beam-playground:
+# name: AppromximateUnique
+# description: Demonstration of ApproximateUnique transform usage.
+# multifile: false
+# default_example: false
+# context_line: 37
+# categories:
+# complexity: BASIC
+# tags:
+# - transforms
+# - integers
+
+
+def approximateunique(test=None):
+ # [START approximateunique]
+ import random
+
+ import apache_beam as beam
+
+ with beam.Pipeline() as pipeline:
+ data = list(range(1000))
+ random.shuffle(data)
+ result = (
+ pipeline
+ | 'create' >> beam.Create(data)
+ | 'get_estimate' >> beam.ApproximateUnique.Globally(size=16)
+ | beam.Map(print))
+ # [END approximateunique]
+ if test:
+ test(result)
diff --git
a/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximateunique_test.py
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximateunique_test.py
new file mode 100644
index 00000000000..c945cec534b
--- /dev/null
+++
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/approximateunique_test.py
@@ -0,0 +1,54 @@
+# coding=utf-8
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+import math
+import unittest
+
+import mock
+
+import apache_beam as beam
+from apache_beam.testing.test_pipeline import TestPipeline
+from apache_beam.testing.util import assert_that
+from apache_beam.testing.util import equal_to
+
+from . import approximateunique
+
+# pytype: skip-file
+
+
[email protected]('apache_beam.Pipeline', TestPipeline)
[email protected](
+ 'apache_beam.examples.snippets.transforms.aggregation.'
+ 'approximateunique.print',
+ lambda x: x)
+class ApproximateUniqueTest(unittest.TestCase):
+ def test_approximateunique(self):
+ def check_result(approx_count):
+ actual_count = 1000
+ sample_size = 16
+ error = 2 / math.sqrt(sample_size)
+ assert_that(
+ approx_count
+ | 'compare' >> beam.FlatMap(
+ lambda x: [abs(x - actual_count) * 1.0 / actual_count <= error]),
+ equal_to([True]))
+
+ approximateunique.approximateunique(test=check_result)
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git
a/sdks/python/apache_beam/examples/snippets/transforms/aggregation/batchelements.py
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/batchelements.py
new file mode 100644
index 00000000000..9e1bb7c6fea
--- /dev/null
+++
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/batchelements.py
@@ -0,0 +1,64 @@
+# coding=utf-8
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+
+# pytype: skip-file
+# pylint:disable=line-too-long
+
+# beam-playground:
+# name: BatchElements
+# description: Demonstration of BatchElements transform usage.
+# multifile: false
+# default_example: false
+# context_line: 39
+# categories:
+# - Core Transforms
+# complexity: BASIC
+# tags:
+# - transforms
+# - strings
+# - group
+
+
+def batchelements(test=None):
+ # [START batchelements]
+ import apache_beam as beam
+
+ with beam.Pipeline() as pipeline:
+ batches = (
+ pipeline
+ | 'Create produce' >> beam.Create([
+ '🍓',
+ '🥕',
+ '🍆',
+ '🍅',
+ '🥕',
+ '🍅',
+ '🌽',
+ '🥕',
+ '🍅',
+ '🍆',
+ ])
+ | beam.BatchElements(min_batch_size=3, max_batch_size=5)
+ | beam.Map(print))
+ # [END batchelements]
+ if test:
+ test(batches)
+
+
+if __name__ == '__main__':
+ batchelements()
diff --git
a/sdks/python/apache_beam/examples/snippets/transforms/aggregation/batchelements_test.py
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/batchelements_test.py
new file mode 100644
index 00000000000..b370f8cd16b
--- /dev/null
+++
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/batchelements_test.py
@@ -0,0 +1,65 @@
+# coding=utf-8
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+
+import unittest
+
+import mock
+
+import apache_beam as beam
+from apache_beam.testing.test_pipeline import TestPipeline
+from apache_beam.testing.util import assert_that
+from apache_beam.testing.util import equal_to
+
+from . import batchelements
+
+
+def check_batches(actual):
+ # How the elements are grouped is not guaranteed, so we just
+ # check that all elements are lists and then count the elements
+ # to make sure none are lost.
+ all_elements_are_lists = (
+ actual
+ | 'Check type' >> beam.Map(lambda x: isinstance(x, list))
+ | 'All elements are lists' >> beam.CombineGlobally(all))
+ assert_that(all_elements_are_lists, equal_to([True]))
+
+ assert_that(
+ actual
+ | beam.FlatMap(lambda x: x)
+ | 'Count' >> beam.combiners.Count.PerElement(),
+ equal_to([('🍓', 1), ('🥕', 3), ('🍆', 2), ('🍅', 3), ('🌽', 1)]),
+ label='Check counts')
+
+
+def identity(x):
+ return x
+
+
[email protected]('apache_beam.Pipeline', TestPipeline)
+# pylint: disable=line-too-long
[email protected](
+ 'apache_beam.examples.snippets.transforms.aggregation.batchelements.print',
+ identity)
+# pylint: enable=line-too-long
+class BatchElementsTest(unittest.TestCase):
+ def test_batchelements(self):
+ batchelements.batchelements(check_batches)
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git
a/sdks/python/apache_beam/examples/snippets/transforms/aggregation/tolist.py
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/tolist.py
new file mode 100644
index 00000000000..089b4bc21c7
--- /dev/null
+++ b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/tolist.py
@@ -0,0 +1,51 @@
+# coding=utf-8
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+
+# pytype: skip-file
+# pylint:disable=line-too-long
+
+# beam-playground:
+# name: ToList
+# description: Demonstration of ToList transform usage.
+# multifile: false
+# default_example: false
+# context_line: 37
+# categories:
+# - Core Transforms
+# complexity: BASIC
+# tags:
+# - transforms
+
+
+def tolist(test=None):
+ # [START tolist]
+ import apache_beam as beam
+
+ with beam.Pipeline() as pipeline:
+ listed_produce = (
+ pipeline
+ | 'Create produce' >> beam.Create(['🍓', '🥕', '🍆', '🍅'])
+ | beam.combiners.ToList()
+ | beam.Map(print))
+ # [END tolist]
+ if test:
+ test(listed_produce)
+
+
+if __name__ == '__main__':
+ tolist()
diff --git
a/sdks/python/apache_beam/examples/snippets/transforms/aggregation/tolist_test.py
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/tolist_test.py
new file mode 100644
index 00000000000..8f5235000c4
--- /dev/null
+++
b/sdks/python/apache_beam/examples/snippets/transforms/aggregation/tolist_test.py
@@ -0,0 +1,60 @@
+# coding=utf-8
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+#
+
+import unittest
+
+import mock
+
+import apache_beam as beam
+from apache_beam.testing.test_pipeline import TestPipeline
+from apache_beam.testing.util import assert_that
+from apache_beam.testing.util import equal_to
+
+from . import tolist
+
+
+def identity(x):
+ return x
+
+
[email protected]('apache_beam.Pipeline', TestPipeline)
+# pylint: disable=line-too-long
[email protected](
+ 'apache_beam.examples.snippets.transforms.aggregation.tolist.print',
+ identity)
+# pylint: enable=line-too-long
+class BatchElementsTest(unittest.TestCase):
+ def test_tolist(self):
+ def check(result):
+ assert_that(
+ result
+ | 'Flatten' >> beam.FlatMap(identity)
+ | 'Count' >> beam.combiners.Count.PerElement(),
+ equal_to([('🍓', 1), ('🥕', 1), ('🍆', 1), ('🍅', 1)]),
+ label='Check counts')
+ assert_that(
+ result
+ | beam.Map(lambda x: isinstance(x, list)),
+ equal_to([True]),
+ label='Check type')
+
+ tolist.tolist(check)
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git
a/website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
b/website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
index adb6d09e768..95f66490f5e 100644
---
a/website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
+++
b/website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
@@ -17,7 +17,14 @@ limitations under the License.
# ApproximateQuantiles
+{{< localstorage language language-py >}}
+
+{{< button-pydoc path="apache_beam.transforms.stat"
class="ApproximateQuantile" >}}
+
## Examples
-See [Issue 19547](https://github.com/apache/beam/issues/19547) for updates.
+
+{{< playground height="700px" >}}
+{{< playground_snippet language="py" path="SDK_PYTHON_ApproximateQuantiles"
show="approximatequantiles" >}}
+{{< /playground >}}
## Related transforms
diff --git
a/website/www/site/content/en/documentation/transforms/python/aggregation/approximateunique.md
b/website/www/site/content/en/documentation/transforms/python/aggregation/approximateunique.md
index dbdfb51e46f..dae287198fe 100644
---
a/website/www/site/content/en/documentation/transforms/python/aggregation/approximateunique.md
+++
b/website/www/site/content/en/documentation/transforms/python/aggregation/approximateunique.md
@@ -16,7 +16,14 @@ limitations under the License.
-->
# ApproximateUnique
+{{< localstorage language language-py >}}
+
+{{< button-pydoc path="apache_beam.transforms.stat" class="ApproximateUnique"
>}}
+
## Examples
-See [Issue 19547](https://github.com/apache/beam/issues/19547) for updates.
+
+{{< playground height="700px" >}}
+{{< playground_snippet language="py" path="SDK_PYTHON_ApproximateUnique"
show="approximateunique" >}}
+{{< /playground >}}
## Related transforms
diff --git
a/website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
b/website/www/site/content/en/documentation/transforms/python/aggregation/batchelements.md
similarity index 57%
copy from
website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
copy to
website/www/site/content/en/documentation/transforms/python/aggregation/batchelements.md
index adb6d09e768..c9d6a7ac6d0 100644
---
a/website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
+++
b/website/www/site/content/en/documentation/transforms/python/aggregation/batchelements.md
@@ -1,5 +1,5 @@
---
-title: "ApproximateQuantiles"
+title: "BatchElements"
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,9 +15,17 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# ApproximateQuantiles
+# BatchElements
+
+{{< localstorage language language-py >}}
+
+{{< button-pydoc path="apache_beam.transforms.stat" class="BatchElements" >}}
## Examples
-See [Issue 19547](https://github.com/apache/beam/issues/19547) for updates.
+
+{{< playground height="700px" >}}
+{{< playground_snippet language="py" path="SDK_PYTHON_BatchElements"
show="batchelements" >}}
+{{< /playground >}}
## Related transforms
+*
[GroupIntoBatches](/documentation/transforms/python/aggregation/groupintobatches)
batches elements by key
diff --git
a/website/www/site/content/en/documentation/transforms/python/aggregation/groupbykey.md
b/website/www/site/content/en/documentation/transforms/python/aggregation/groupbykey.md
index 5ba04bc2fe1..e3f287da7d0 100644
---
a/website/www/site/content/en/documentation/transforms/python/aggregation/groupbykey.md
+++
b/website/www/site/content/en/documentation/transforms/python/aggregation/groupbykey.md
@@ -32,17 +32,9 @@ See more information in the [Beam Programming
Guide](/documentation/programming-
We use `GroupByKey` to group all the produce for each season.
-{{< highlight language="py"
file="sdks/python/apache_beam/examples/snippets/transforms/aggregation/groupbykey.py"
>}}
-{{< code_sample
"sdks/python/apache_beam/examples/snippets/transforms/aggregation/groupbykey.py"
groupbykey >}}
-{{< /highlight >}}
-
-{{< paragraph class="notebook-skip" >}}
-Output:
-{{< /paragraph >}}
-
-{{< highlight class="notebook-skip" >}}
-{{< code_sample
"sdks/python/apache_beam/examples/snippets/transforms/aggregation/groupbykey_test.py"
produce_counts >}}
-{{< /highlight >}}
+{{< playground height="700px" >}}
+{{< playground_snippet language="py" path="SDK_PYTHON_GroupByKey"
show="groupbykeysort" >}}
+{{< /playground >}}
**Example 2**:
diff --git
a/website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
b/website/www/site/content/en/documentation/transforms/python/aggregation/tolist.md
similarity index 65%
copy from
website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
copy to
website/www/site/content/en/documentation/transforms/python/aggregation/tolist.md
index adb6d09e768..cfed9958079 100644
---
a/website/www/site/content/en/documentation/transforms/python/aggregation/approximatequantiles.md
+++
b/website/www/site/content/en/documentation/transforms/python/aggregation/tolist.md
@@ -1,5 +1,5 @@
---
-title: "ApproximateQuantiles"
+title: "BatchElements"
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,9 +15,14 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# ApproximateQuantiles
+# BatchElements
+
+{{< localstorage language language-py >}}
+
+{{< button-pydoc path="apache_beam.transforms.combiners" class="ToList" >}}
## Examples
-See [Issue 19547](https://github.com/apache/beam/issues/19547) for updates.
-## Related transforms
+{{< playground height="700px" >}}
+{{< playground_snippet language="py" path="SDK_PYTHON_ToList" show="tolist" >}}
+{{< /playground >}}
diff --git
a/website/www/site/content/en/documentation/transforms/python/overview.md
b/website/www/site/content/en/documentation/transforms/python/overview.md
index a8982fa9798..c5d9714e695 100644
--- a/website/www/site/content/en/documentation/transforms/python/overview.md
+++ b/website/www/site/content/en/documentation/transforms/python/overview.md
@@ -48,13 +48,13 @@ limitations under the License.
<table class="table-bordered table-striped">
<tr><th>Transform</th><th>Description</th></tr>
- <tr><td>ApproximateQuantiles</td><td>Not available. See <a
href="https://issues.apache.org/jira/browse/BEAM-6694";>BEAM-6694</a> for
updates.</td></tr>
- <tr><td>ApproximateUnique</td><td>Not available. See <a
href="https://issues.apache.org/jira/browse/BEAM-6693";>BEAM-6693</a> for
updates.</td></tr>
+ <tr><td><a
href="/documentation/transforms/python/aggregation/approximatequantiles">ApproximateQuantiles</a></td><td>Given
a distribution, find the approximate N-tiles.</td></tr>
+ <tr><td><a
href="/documentation/transforms/python/aggregation/approximateunique">ApproximateUnique</a></td><td>Given
a pcollection, return the estimated number of unique elements.</td></tr>
+ <tr><td><a
href="/documentation/transforms/python/aggregation/batchelements">BatchElements</a></td><td>Given
a pcollection, return the estimated number of unique elements.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/cogroupbykey">CoGroupByKey</a></td><td>Takes
several keyed collections of elements and produces a collection where each
element consists of a key and all values associated with that key.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/combineglobally">CombineGlobally</a></td><td>Transforms
to combine elements.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/combineperkey">CombinePerKey</a></td><td>Transforms
to combine elements for each key.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/combinevalues">CombineValues</a></td><td>Transforms
to combine keyed iterables.</td></tr>
- <tr><td>CombineWithContext</td><td>Not available.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/count">Count</a></td><td>Counts
the number of elements within each aggregation.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/distinct">Distinct</a></td><td>Produces
a collection containing distinct elements from the input collection.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/groupbykey">GroupByKey</a></td><td>Takes
a keyed collection of elements and produces a collection where each element
consists of a key and all values associated with that key.</td></tr>
@@ -66,6 +66,7 @@ limitations under the License.
<tr><td><a
href="/documentation/transforms/python/aggregation/min">Min</a></td><td>Gets
the element with the minimum value within each aggregation.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/sample">Sample</a></td><td>Randomly
select some number of elements from each aggregation.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/sum">Sum</a></td><td>Sums
all the elements within each aggregation.</td></tr>
+ <tr><td><a
href="/documentation/transforms/python/aggregation/tolist">ToList</a></td><td>Aggregates
all elements into a single list.</td></tr>
<tr><td><a
href="/documentation/transforms/python/aggregation/top">Top</a></td><td>Compute
the largest element(s) in each aggregation.</td></tr>
</table>
@@ -77,10 +78,8 @@ limitations under the License.
<tr><td><a
href="/documentation/transforms/python/other/flatten">Flatten</a></td><td>Given
multiple input collections, produces a single output collection containing
all elements from all of the input collections.
</td></tr>
- <tr><td>PAssert</td><td>Not available.</td></tr>
<tr><td><a
href="/documentation/transforms/python/other/reshuffle">Reshuffle</a></td><td>Given
an input collection, redistributes the elements between workers. This is
most useful for adjusting parallelism or preventing coupled
failures.</td></tr>
- <tr><td>View</td><td>Not available.</td></tr>
<tr><td><a
href="/documentation/transforms/python/other/windowinto">WindowInto</a></td><td>Logically
divides up or groups the elements of a collection into finite
windows according to a function.</td></tr>
</table>
diff --git
a/website/www/site/layouts/partials/section-menu/en/documentation.html
b/website/www/site/layouts/partials/section-menu/en/documentation.html
index fda1d3960ac..df4a0f20d63 100755
--- a/website/www/site/layouts/partials/section-menu/en/documentation.html
+++ b/website/www/site/layouts/partials/section-menu/en/documentation.html
@@ -324,6 +324,8 @@
<span class="section-nav-list-title">Aggregation</span>
<ul class="section-nav-list">
+ <li><a
href="/documentation/transforms/python/aggregation/approximatequantiles/">ApproximateQuantiles</a></li>
+ <li><a
href="/documentation/transforms/python/aggregation/approximateunique/">ApproximateUnique</a></li>
<li><a
href="/documentation/transforms/python/aggregation/cogroupbykey/">CoGroupByKey</a></li>
<li><a
href="/documentation/transforms/python/aggregation/combineglobally/">CombineGlobally</a></li>
<li><a
href="/documentation/transforms/python/aggregation/combineperkey/">CombinePerKey</a></li>
@@ -340,6 +342,7 @@
<li><a
href="/documentation/transforms/python/aggregation/sample/">Sample</a></li>
<li><a
href="/documentation/transforms/python/aggregation/sum/">Sum</a></li>
<li><a
href="/documentation/transforms/python/aggregation/top/">Top</a></li>
+ <li><a
href="/documentation/transforms/python/aggregation/tolist/">ToList</a></li>
</ul>
</li>
<li class="section-nav-item--collapsible">
