Document TupleCombineFns
Project: http://git-wip-us.apache.org/repos/asf/incubator-beam/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam/commit/4a2239d3 Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam/tree/4a2239d3 Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam/diff/4a2239d3 Branch: refs/heads/python-sdk Commit: 4a2239d3701e13622998c71107d263c8966e73e1 Parents: 3ebf28c Author: Robert Bradshaw <rober...@google.com> Authored: Wed Aug 3 13:52:36 2016 -0700 Committer: Robert Bradshaw <rober...@google.com> Committed: Wed Aug 3 13:52:36 2016 -0700 ---------------------------------------------------------------------- sdks/python/apache_beam/transforms/combiners.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/4a2239d3/sdks/python/apache_beam/transforms/combiners.py ---------------------------------------------------------------------- diff --git a/sdks/python/apache_beam/transforms/combiners.py b/sdks/python/apache_beam/transforms/combiners.py index c3f0da1..a0604b8 100644 --- a/sdks/python/apache_beam/transforms/combiners.py +++ b/sdks/python/apache_beam/transforms/combiners.py @@ -427,6 +427,12 @@ class _TupleCombineFnBase(core.CombineFn): class TupleCombineFn(_TupleCombineFnBase): + """A combiner for combining tuples via a tuple of combiners. + + Takes as input a tuple of N CombineFns and combines N-tuples by + combining the k-th element of each tuple with the k-th CombineFn, + outputting a new N-tuple of combined values. + """ def add_input(self, accumulator, element): return [c.add_input(a, e) @@ -437,6 +443,12 @@ class TupleCombineFn(_TupleCombineFnBase): class SingleInputTupleCombineFn(_TupleCombineFnBase): + """A combiner for combining a single value via a tuple of combiners. + + Takes as input a tuple of N CombineFns and combines elements by + applying each CombineFn to each input, producing an N-tuple of + the outputs corresponding to each of the N CombineFn's outputs. + """ def add_input(self, accumulator, element): return [c.add_input(a, element)
