[FLINK-16483][python] Add Python building blocks to make sure the basic functionality of vectorized Python UDF could work #11342

dianfu · 2020-03-07T13:59:08Z

What is the purpose of the change

This pull request add the Python building blocks to make sure the basic functionality of vectorized Python UDF could work.

Brief change log

Changes in udf.py to make sure we can define vectorized Python UDF
Introduce ArrowCoder/ArrowCoderImpl for Arrow data serialization/deserialization

Verifying this change

This change added tests and can be verified as follows:

Added tests test_pandas_udf

Does this pull request potentially affect one of the following parts:

Dependencies (does it add or upgrade a dependency): (yes, python dependency pyarrow and pandas)
The public API, i.e., is any changed class annotated with @Public(Evolving): (no)
The serializers: (no)
The runtime per-record code paths (performance sensitive): (no)
Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: (no)
The S3 file system connector: (no)

Documentation

Does this pull request introduce a new feature? (no)
If yes, how is the feature documented? (not applicable)

flinkbot · 2020-03-07T14:01:14Z

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 27f93cc (Sat Mar 07 14:01:14 UTC 2020)

Warnings:

No documentation files were touched! Remember to keep the Flink docs up to date!

_{Mention the bot in a comment to re-run the automated checks.}

Review Progress

❓ 1. The [description] looks good.
❓ 2. There is [consensus] that the contribution should go into to Flink.
❓ 3. Needs [attention] from.
❓ 4. The change fits into the overall [architecture].
❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
@flinkbot approve all to approve all aspects
@flinkbot approve-until architecture to approve everything until architecture
@flinkbot attention @username1 [@username2 ..] to require somebody's attention
@flinkbot disapprove architecture to remove an approval you gave earlier

flinkbot · 2020-03-07T14:17:41Z

CI report:

c506306 Travis: SUCCESS Azure: SUCCESS

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot run travis re-run the last Travis build
@flinkbot run azure re-run the last Azure build

hequn8128

@dianfu Thanks a lot for the PR. Left some minor comments below.

hequn8128 · 2020-03-09T08:17:21Z

flink-python/setup.py

@@ -224,7 +224,8 @@ def remove_if_exists(file_path):
        author_email='dev@flink.apache.org',
        python_requires='>=3.5',
        install_requires=['py4j==0.10.8.1', 'python-dateutil==2.8.0', 'apache-beam==2.19.0',
-                          'cloudpickle==1.2.2', 'avro-python3>=1.8.1,<=1.9.1', 'jsonpickle==1.2'],
+                          'cloudpickle==1.2.2', 'avro-python3>=1.8.1,<=1.9.1', 'jsonpickle==1.2',
+                          'pandas>=0.23.4, <=0.25.3', 'pyarrow>=0.15.1, <=0.16.0'],


Remove the blank between the version range? It seems it contains no blank usually.

hequn8128 · 2020-03-09T09:06:27Z

flink-python/pyflink/table/udf.py



 def _create_udtf(f, input_types, result_types, deterministic, name):
    return UserDefinedTableFunctionWrapper(f, input_types, result_types, deterministic, name)


-def udf(f=None, input_types=None, result_type=None, deterministic=None, name=None):
+def udf(f=None, input_types=None, result_type=None, deterministic=None, name=None,
+        udf_type="general"):


How about adding a PythonFunctionKind class which contains GENERAL and PANDAS? It is consistent with Java and also would be easier for users to add the parameter.

hequn8128 · 2020-03-09T14:56:42Z

...flink/table/runtime/runners/python/scalar/arrow/AbstractArrowPythonScalarFunctionRunner.java

@@ -46,6 +46,12 @@

 	private static final String SCHEMA_ARROW_CODER_URN = "flink:coder:schema:scalar_function:arrow:v1";

+	static {


Maybe we should not contain this commit in this PR? as it is included in FLINK-16273？otherwise there will be two commits for addressing the same problem.

hequn8128 · 2020-03-09T15:16:42Z

flink-python/pyflink/fn_execution/coder_impl.py

+            self._batch_reader = load_from_stream(self._resettable_io)
+
+        self._resettable_io.set_input_bytes(in_stream.read_all())
+        table = pa.Table.from_batches([next(self._batch_reader)])


Why we only get the first batch in the batch list?

hequn8128 · 2020-03-09T15:23:32Z

flink-python/pyflink/fn_execution/coder_impl.py

+        self._resettable_io = ResettableIO()
+
+    def encode_to_stream(self, cols, out_stream, nested):
+        if not hasattr(self, "_batch_writer"):


Why we must init the _batch_writer here instead of in __init__?

hequn8128 · 2020-03-09T15:31:35Z

flink-python/pyflink/fn_execution/coder_impl.py

+        self._batch_writer.write_batch(self._create_batch(cols))
+
+    def decode_from_stream(self, in_stream, nested):
+        if not hasattr(self, "_batch_reader"):


I'm wondering if we can avoid these hasattr. Can we use pa.ipc.open_stream read the stream directly and return the batch?

…ic functionality of vectorized Python UDF could work

dianfu · 2020-03-10T03:19:25Z

@hequn8128 Thanks a lot for the review. Have updated the PR.

dianfu · 2020-03-10T09:31:31Z

The Python e2e tests of jdk11 has also passed: https://api.travis-ci.org/v3/job/660451220/log.txt

hequn8128

@dianfu Thanks a lot for the udpate and provided the test link. LGTM.
Merging...

rmetzger added review=description? component=API/Python labels Mar 7, 2020

hequn8128 reviewed Mar 9, 2020

View reviewed changes

dianfu force-pushed the FLINK-16483 branch from 27f93cc to 0e82d81 Compare March 10, 2020 03:14

dianfu added 2 commits March 10, 2020 11:18

[FLINK-16483][python] Add Python building blocks to make sure the bas…

e431a7c

…ic functionality of vectorized Python UDF could work

address review

c506306

dianfu force-pushed the FLINK-16483 branch from 0e82d81 to c506306 Compare March 10, 2020 03:18

hequn8128 approved these changes Mar 10, 2020

View reviewed changes

hequn8128 merged commit 6f19fd2 into apache:master Mar 10, 2020

dianfu deleted the FLINK-16483 branch June 10, 2020 03:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FLINK-16483][python] Add Python building blocks to make sure the basic functionality of vectorized Python UDF could work #11342

[FLINK-16483][python] Add Python building blocks to make sure the basic functionality of vectorized Python UDF could work #11342

dianfu commented Mar 7, 2020 •

edited

flinkbot commented Mar 7, 2020

flinkbot commented Mar 7, 2020 •

edited

hequn8128 left a comment

hequn8128 Mar 9, 2020

hequn8128 Mar 9, 2020

hequn8128 Mar 9, 2020

hequn8128 Mar 9, 2020

hequn8128 Mar 9, 2020

hequn8128 Mar 9, 2020

dianfu commented Mar 10, 2020

dianfu commented Mar 10, 2020 •

edited

hequn8128 left a comment

		@@ -46,6 +46,12 @@

		private static final String SCHEMA_ARROW_CODER_URN = "flink:coder:schema:scalar_function:arrow:v1";

		static {

[FLINK-16483][python] Add Python building blocks to make sure the basic functionality of vectorized Python UDF could work #11342

[FLINK-16483][python] Add Python building blocks to make sure the basic functionality of vectorized Python UDF could work #11342

Conversation

dianfu commented Mar 7, 2020 • edited

What is the purpose of the change

Brief change log

Verifying this change

Does this pull request potentially affect one of the following parts:

Documentation

flinkbot commented Mar 7, 2020

Automated Checks

Review Progress

flinkbot commented Mar 7, 2020 • edited

CI report:

hequn8128 left a comment

Choose a reason for hiding this comment

hequn8128 Mar 9, 2020

Choose a reason for hiding this comment

hequn8128 Mar 9, 2020

Choose a reason for hiding this comment

hequn8128 Mar 9, 2020

Choose a reason for hiding this comment

hequn8128 Mar 9, 2020

Choose a reason for hiding this comment

hequn8128 Mar 9, 2020

Choose a reason for hiding this comment

hequn8128 Mar 9, 2020

Choose a reason for hiding this comment

dianfu commented Mar 10, 2020

dianfu commented Mar 10, 2020 • edited

hequn8128 left a comment

Choose a reason for hiding this comment

dianfu commented Mar 7, 2020 •

edited

flinkbot commented Mar 7, 2020 •

edited

dianfu commented Mar 10, 2020 •

edited