[
https://issues.apache.org/jira/browse/BEAM-7013?focusedWorklogId=304305&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-304305
]
ASF GitHub Bot logged work on BEAM-7013:
----------------------------------------
Author: ASF GitHub Bot
Created on: 30/Aug/19 14:54
Start Date: 30/Aug/19 14:54
Worklog Time Spent: 10m
Work Description: zfraa commented on pull request #9144: [BEAM-7013]
Integrating ZetaSketch's HLL++ algorithm with Beam
URL: https://github.com/apache/beam/pull/9144#discussion_r319549589
##########
File path:
sdks/java/extensions/zetasketch/src/test/java/org/apache/beam/sdk/extensions/zetasketch/HllCountTest.java
##########
@@ -0,0 +1,373 @@
+/*
+ * 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.
+ */
+package org.apache.beam.sdk.extensions.zetasketch;
+
+import com.google.zetasketch.HyperLogLogPlusPlus;
+import com.google.zetasketch.shaded.com.google.protobuf.ByteString;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import org.apache.beam.sdk.Pipeline.PipelineExecutionException;
+import org.apache.beam.sdk.testing.NeedsRunner;
+import org.apache.beam.sdk.testing.PAssert;
+import org.apache.beam.sdk.testing.TestPipeline;
+import org.apache.beam.sdk.transforms.Create;
+import org.apache.beam.sdk.values.KV;
+import org.apache.beam.sdk.values.PCollection;
+import org.apache.beam.sdk.values.TypeDescriptor;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+import org.junit.rules.ExpectedException;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/** Tests for {@link HllCount}. */
+@RunWith(JUnit4.class)
+public class HllCountTest {
+
+ @Rule public final transient TestPipeline p = TestPipeline.create();
+ @Rule public transient ExpectedException thrown = ExpectedException.none();
+
+ // Integer
+ private static final List<Integer> INTS1 = Arrays.asList(1, 2, 3, 3, 1, 4);
+ private static final byte[] INTS1_SKETCH;
+ private static final Long INTS1_ESTIMATE;
+
+ static {
+ HyperLogLogPlusPlus<Integer> hll = new
HyperLogLogPlusPlus.Builder().buildForIntegers();
+ INTS1.forEach(hll::add);
+ INTS1_SKETCH = hll.serializeToByteArray();
+ INTS1_ESTIMATE = hll.longResult();
+ }
+
+ private static final List<Integer> INTS2 = Arrays.asList(3, 3, 3, 3);
+ private static final byte[] INTS2_SKETCH;
+ private static final Long INTS2_ESTIMATE;
+
+ static {
+ HyperLogLogPlusPlus<Integer> hll = new
HyperLogLogPlusPlus.Builder().buildForIntegers();
+ INTS2.forEach(hll::add);
+ INTS2_SKETCH = hll.serializeToByteArray();
+ INTS2_ESTIMATE = hll.longResult();
+ }
+
+ private static final byte[] INTS1_INTS2_SKETCH;
+
+ static {
+ HyperLogLogPlusPlus<?> hll = HyperLogLogPlusPlus.forProto(INTS1_SKETCH);
+ hll.merge(INTS2_SKETCH);
+ INTS1_INTS2_SKETCH = hll.serializeToByteArray();
+ }
+
+ // Long
+ private static final List<Long> LONGS = Collections.singletonList(1L);
+ private static final byte[] LONGS_SKETCH;
+
+ static {
+ HyperLogLogPlusPlus<Long> hll = new
HyperLogLogPlusPlus.Builder().buildForLongs();
+ LONGS.forEach(hll::add);
+ LONGS_SKETCH = hll.serializeToByteArray();
+ }
+
+ private static final byte[] LONGS_EMPTY_SKETCH;
+
+ static {
+ HyperLogLogPlusPlus<Long> hll = new
HyperLogLogPlusPlus.Builder().buildForLongs();
+ LONGS_EMPTY_SKETCH = hll.serializeToByteArray();
+ }
+
+ // String
+ private static final List<String> STRINGS = Arrays.asList("s1", "s2", "s1",
"s2");
+ private static final byte[] STRINGS_SKETCH;
+
+ static {
+ HyperLogLogPlusPlus<String> hll = new
HyperLogLogPlusPlus.Builder().buildForStrings();
+ STRINGS.forEach(hll::add);
+ STRINGS_SKETCH = hll.serializeToByteArray();
+ }
+
+ private static final int TEST_PRECISION = 20;
+ private static final byte[] STRINGS_SKETCH_TEST_PRECISION;
+
+ static {
+ HyperLogLogPlusPlus<String> hll =
+ new
HyperLogLogPlusPlus.Builder().normalPrecision(TEST_PRECISION).buildForStrings();
+ STRINGS.forEach(hll::add);
+ STRINGS_SKETCH_TEST_PRECISION = hll.serializeToByteArray();
+ }
+
+ // Bytes
+ private static final byte[] BYTES0 = {(byte) 0x1, (byte) 0xa};
+ private static final byte[] BYTES1 = {(byte) 0xf};
+ private static final List<byte[]> BYTES = Arrays.asList(BYTES0, BYTES1);
+ private static final byte[] BYTES_SKETCH;
+
+ static {
+ HyperLogLogPlusPlus<ByteString> hll = new
HyperLogLogPlusPlus.Builder().buildForBytes();
+ BYTES.forEach(hll::add);
+ BYTES_SKETCH = hll.serializeToByteArray();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitIntegerSketchGlobally() {
+ PCollection<byte[]> result =
+
p.apply(Create.of(INTS1)).apply(HllCount.Init.integerSketch().globally());
+
+ PAssert.thatSingleton(result).isEqualTo(INTS1_SKETCH);
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitLongSketchGlobally() {
+ PCollection<byte[]> result =
+ p.apply(Create.of(LONGS)).apply(HllCount.Init.longSketch().globally());
+
+ PAssert.thatSingleton(result).isEqualTo(LONGS_SKETCH);
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitLongSketchGlobally_EmptyInput() {
+ PCollection<byte[]> result =
+ p.apply(Create.empty(TypeDescriptor.of(Long.class)))
+ .apply(HllCount.Init.longSketch().globally());
+
+ PAssert.that(result).empty();
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitStringSketchGlobally() {
+ PCollection<byte[]> result =
+
p.apply(Create.of(STRINGS)).apply(HllCount.Init.stringSketch().globally());
+
+ PAssert.thatSingleton(result).isEqualTo(STRINGS_SKETCH);
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitStringSketchGlobally_WithPrecision() {
+ PCollection<byte[]> result =
+ p.apply(Create.of(STRINGS))
+
.apply(HllCount.Init.stringSketch().withPrecision(TEST_PRECISION).globally());
+
+ PAssert.thatSingleton(result).isEqualTo(STRINGS_SKETCH_TEST_PRECISION);
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitStringSketchGlobally_WithInvalidPrecision() {
+ thrown.expect(IllegalArgumentException.class);
+
p.apply(Create.of(STRINGS)).apply(HllCount.Init.stringSketch().withPrecision(0).globally());
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitBytesSketchGlobally() {
+ PCollection<byte[]> result =
+
p.apply(Create.of(BYTES)).apply(HllCount.Init.bytesSketch().globally());
+
+ PAssert.thatSingleton(result).isEqualTo(BYTES_SKETCH);
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitIntegerSketchPerKey() {
+ List<KV<String, Integer>> input = new ArrayList<>();
+ INTS1.forEach(i -> input.add(KV.of("k1", i)));
+ INTS1.forEach(i -> input.add(KV.of("k2", i)));
+ INTS2.forEach(i -> input.add(KV.of("k1", i)));
+ PCollection<KV<String, byte[]>> result =
+
p.apply(Create.of(input)).apply(HllCount.Init.integerSketch().perKey());
+
+ PAssert.that(result)
+ .containsInAnyOrder(
+ Arrays.asList(KV.of("k1", INTS1_INTS2_SKETCH), KV.of("k2",
INTS1_SKETCH)));
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitLongSketchPerKey() {
+ List<KV<String, Long>> input = new ArrayList<>();
+ LONGS.forEach(l -> input.add(KV.of("k", l)));
+ PCollection<KV<String, byte[]>> result =
+ p.apply(Create.of(input)).apply(HllCount.Init.longSketch().perKey());
+
+
PAssert.that(result).containsInAnyOrder(Collections.singletonList(KV.of("k",
LONGS_SKETCH)));
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitStringSketchPerKey() {
+ List<KV<String, String>> input = new ArrayList<>();
+ STRINGS.forEach(s -> input.add(KV.of("k", s)));
+ PCollection<KV<String, byte[]>> result =
+ p.apply(Create.of(input)).apply(HllCount.Init.stringSketch().perKey());
+
+
PAssert.that(result).containsInAnyOrder(Collections.singletonList(KV.of("k",
STRINGS_SKETCH)));
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitStringSketchPerKey_WithPrecision() {
+ List<KV<String, String>> input = new ArrayList<>();
+ STRINGS.forEach(s -> input.add(KV.of("k", s)));
+ PCollection<KV<String, byte[]>> result =
+ p.apply(Create.of(input))
+
.apply(HllCount.Init.stringSketch().withPrecision(TEST_PRECISION).perKey());
+
+ PAssert.that(result)
+ .containsInAnyOrder(Collections.singletonList(KV.of("k",
STRINGS_SKETCH_TEST_PRECISION)));
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitStringSketchPerKey_WithInvalidPrecision() {
+ List<KV<String, String>> input = new ArrayList<>();
+ STRINGS.forEach(s -> input.add(KV.of("k", s)));
+ thrown.expect(IllegalArgumentException.class);
+
p.apply(Create.of(input)).apply(HllCount.Init.stringSketch().withPrecision(0).perKey());
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testInitBytesSketchPerKey() {
+ List<KV<String, byte[]>> input = new ArrayList<>();
+ BYTES.forEach(bs -> input.add(KV.of("k", bs)));
+ PCollection<KV<String, byte[]>> result =
+ p.apply(Create.of(input)).apply(HllCount.Init.bytesSketch().perKey());
+
+
PAssert.that(result).containsInAnyOrder(Collections.singletonList(KV.of("k",
BYTES_SKETCH)));
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testMergePartialGlobally() {
+ PCollection<byte[]> result =
+ p.apply(Create.of(INTS1_SKETCH,
INTS2_SKETCH)).apply(HllCount.MergePartial.globally());
+
+ PAssert.thatSingleton(result).isEqualTo(INTS1_INTS2_SKETCH);
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testMergePartialGlobally_MergeWithSketchForEmptySet() {
+ PCollection<byte[]> result =
+ p.apply(Create.of(LONGS_SKETCH, LONGS_EMPTY_SKETCH))
+ .apply(HllCount.MergePartial.globally());
+
+ PAssert.thatSingleton(result).isEqualTo(LONGS_SKETCH);
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testMergePartialGlobally_SingletonInput() {
+ PCollection<byte[]> result =
+
p.apply(Create.of(LONGS_SKETCH)).apply(HllCount.MergePartial.globally());
+
+ PAssert.thatSingleton(result).isEqualTo(LONGS_SKETCH);
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testMergePartialGlobally_EmptyInput() {
+ PCollection<byte[]> result =
+ p.apply(Create.empty(TypeDescriptor.of(byte[].class)))
+ .apply(HllCount.MergePartial.globally());
+
+ PAssert.that(result).empty();
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testMergePartialGlobally_IncompatibleSketches() {
+ p.apply(Create.of(INTS1_SKETCH,
STRINGS_SKETCH)).apply(HllCount.MergePartial.globally());
+
+ thrown.expect(PipelineExecutionException.class);
+ p.run();
+ }
+
+ @Test
+ @Category(NeedsRunner.class)
+ public void testMergePartialPerKey() {
+ PCollection<KV<String, byte[]>> result =
+ p.apply(
+ Create.of(
+ KV.of("k1", INTS1_SKETCH),
Review comment:
Just a quick comment on this:
> It is possible that, e.g. k1 has a value representing an integer-type
sketch, and k2 has a value representing a string-type sketch. MergePartial will
work in this case because it does not make assumptions on what the input byte
arrays represent.
The (zetasketch HLL++) library will throw an error if you try to merge
sketches of different input types. It's important that we do so because the
output would be gibberish (e.g., a string-encoded int would probably hash
differently than a 'native' int => it would be counted twice in the output).
----------------------------------------------------------------
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: 304305)
Time Spent: 29h (was: 28h 50m)
> A new count distinct transform based on BigQuery compatible HyperLogLog++
> implementation
> ----------------------------------------------------------------------------------------
>
> Key: BEAM-7013
> URL: https://issues.apache.org/jira/browse/BEAM-7013
> Project: Beam
> Issue Type: New Feature
> Components: extensions-java-sketching, sdk-java-core
> Reporter: Yueyang Qiu
> Assignee: Yueyang Qiu
> Priority: Major
> Fix For: 2.16.0
>
> Time Spent: 29h
> Remaining Estimate: 0h
>
--
This message was sent by Atlassian Jira
(v8.3.2#803003)
