You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/06/02 08:38:48 UTC
[GitHub] [spark] beobest2 opened a new pull request, #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
beobest2 opened a new pull request, #36749:
URL: https://github.com/apache/spark/pull/36749
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
The description provided in the supported pandas API list document or the code comment needs improvement.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
To improve document readability for users.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
Yes, the "Supported pandas APIs" page has changed as below.
<img width="1044" alt="Screen Shot 2022-06-02 at 4 37 15 AM" src="https://user-images.githubusercontent.com/7010554/171590550-c9088238-6069-4a5c-b4ba-d8c2355d6dcd.png">
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
Manually check the links in the documents & the existing doc build should be passed.
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] Yikun commented on a diff in pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
Yikun commented on code in PR #36749:
URL: https://github.com/apache/spark/pull/36749#discussion_r887764899
##########
python/docs/source/user_guide/pandas_on_spark/supported_pandas_api.rst:
##########
@@ -17,34 +17,32 @@
=====================
-Supported pandas APIs
+Supported pandas API
=====================
.. currentmodule:: pyspark.pandas
The following table shows the pandas APIs that implemented or non-implemented from pandas API on
-Spark.
+Spark. Some pandas API do not implement full parameters, so the third column shows missing
+parameters for each API.
-Some pandas APIs do not implement full parameters, so the third column shows missing parameters for
-each API.
+* 'Y' in the second column means it's implemented including its whole parameter.
+* 'N' means it's not implemented yet.
+* 'P' means it's partially implemented with the missing of some parameters.
-'Y' in the second column means it's implemented including its whole parameter.
-'N' means it's not implemented yet.
-'P' means it's partially implemented with the missing of some parameters.
+All API in the list below computes the data with distributed execution except the ones that require
+the local execution by design. For example, `DataFrame.to_numpy() <https://spark.apache.org/docs/
+latest/api/python/reference/pyspark.pandas/api/pyspark.pandas.DataFrame.to_numpy.html>`__
+requires to collect the data to the driver side.
If there is non-implemented pandas API or parameter you want, you can create an `Apache Spark
-JIRA <https://issues.apache.org/jira/projects/SPARK/summary>`__ to request or to contribute by your
-own.
+JIRA <https://issues.apache.org/jira/projects/SPARK/summary>`__ to request or to contribute by
+your own.
-The API list is updated based on the `pandas 1.3 official API
-reference <https://pandas.pydata.org/pandas-docs/version/1.3/reference/index.html>`__.
+The API list is updated based on the `latest pandas official API reference
+<https://pandas.pydata.org/docs/reference/index.html#>`__.
Review Comment:
I think we should also keep 1.3 here, and then dynamically generate this verison in followup release.
By the way, we had some discussion about this version before: https://github.com/apache/spark/pull/36095#discussion_r844611610 https://github.com/apache/spark/pull/36114#discussion_r845778366
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] MaxGekk closed pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
MaxGekk closed pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
URL: https://github.com/apache/spark/pull/36749
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] beobest2 commented on a diff in pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
beobest2 commented on code in PR #36749:
URL: https://github.com/apache/spark/pull/36749#discussion_r887774470
##########
python/docs/source/user_guide/pandas_on_spark/supported_pandas_api.rst:
##########
@@ -17,34 +17,32 @@
=====================
-Supported pandas APIs
+Supported pandas API
=====================
.. currentmodule:: pyspark.pandas
The following table shows the pandas APIs that implemented or non-implemented from pandas API on
-Spark.
+Spark. Some pandas API do not implement full parameters, so the third column shows missing
+parameters for each API.
-Some pandas APIs do not implement full parameters, so the third column shows missing parameters for
-each API.
+* 'Y' in the second column means it's implemented including its whole parameter.
+* 'N' means it's not implemented yet.
+* 'P' means it's partially implemented with the missing of some parameters.
-'Y' in the second column means it's implemented including its whole parameter.
-'N' means it's not implemented yet.
-'P' means it's partially implemented with the missing of some parameters.
+All API in the list below computes the data with distributed execution except the ones that require
+the local execution by design. For example, `DataFrame.to_numpy() <https://spark.apache.org/docs/
+latest/api/python/reference/pyspark.pandas/api/pyspark.pandas.DataFrame.to_numpy.html>`__
+requires to collect the data to the driver side.
If there is non-implemented pandas API or parameter you want, you can create an `Apache Spark
-JIRA <https://issues.apache.org/jira/projects/SPARK/summary>`__ to request or to contribute by your
-own.
+JIRA <https://issues.apache.org/jira/projects/SPARK/summary>`__ to request or to contribute by
+your own.
-The API list is updated based on the `pandas 1.3 official API
-reference <https://pandas.pydata.org/pandas-docs/version/1.3/reference/index.html>`__.
+The API list is updated based on the `latest pandas official API reference
+<https://pandas.pydata.org/docs/reference/index.html#>`__.
Review Comment:
@Yikun I've fixed the reference version specification of pandas to 1.3.
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on PR #36749:
URL: https://github.com/apache/spark/pull/36749#issuecomment-1153678058
@beobest2 is there any progress on https://github.com/apache/spark/pull/36749#issuecomment-1144639942?
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] MaxGekk commented on pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
MaxGekk commented on PR #36749:
URL: https://github.com/apache/spark/pull/36749#issuecomment-1145199197
+1, LGTM. Merging to 3.3.
Thank you, @beobest2 and @HyukjinKwon @Yikun for review.
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] beobest2 commented on pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
beobest2 commented on PR #36749:
URL: https://github.com/apache/spark/pull/36749#issuecomment-1144607098
Additionally, I am going to remove duplication of "supported" prefix in each subheading.
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #36749:
URL: https://github.com/apache/spark/pull/36749#discussion_r887870911
##########
python/docs/source/user_guide/pandas_on_spark/supported_pandas_api.rst:
##########
@@ -17,34 +17,32 @@
=====================
-Supported pandas APIs
+Supported pandas API
=====================
Review Comment:
```suggestion
====================
```
##########
python/docs/source/user_guide/pandas_on_spark/supported_pandas_api.rst:
##########
@@ -17,34 +17,32 @@
=====================
Review Comment:
```suggestion
====================
```
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on PR #36749:
URL: https://github.com/apache/spark/pull/36749#issuecomment-1144760857
@beobest2 mind retriggering https://github.com/beobest2/spark/runs/6706038714?check_suite_focus=true?
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #36749:
URL: https://github.com/apache/spark/pull/36749#discussion_r887871489
##########
python/docs/source/user_guide/pandas_on_spark/supported_pandas_api.rst:
##########
@@ -528,7 +526,7 @@ Supported DataFrame APIs
| :func:`xs` | P | ``drop_level`` |
+--------------------------------------------+-------------+--------------------------------------+
-Supported I/O APIs
+I/O API
------------------
Review Comment:
Let's keep this bars same length. Otherwise Sphinx complains.
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on PR #36749:
URL: https://github.com/apache/spark/pull/36749#issuecomment-1144633768
Thanks. cc @itholic and @Yikun FYI
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] beobest2 commented on pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
beobest2 commented on PR #36749:
URL: https://github.com/apache/spark/pull/36749#issuecomment-1144639942
@HyukjinKwon Also, there are a few cases where the link of the function is broken although this is a manually written document. This is because Sphinx's `currentmodule` function is used, and there is a document directory structure that does not match the function name.
<img width="779" alt="Screen Shot 2022-06-02 at 5 08 25 AM" src="https://user-images.githubusercontent.com/7010554/171598116-b09ccfd4-0854-4c89-bf77-a9f5b740f99e.png">
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on PR #36749:
URL: https://github.com/apache/spark/pull/36749#issuecomment-1144655837
👌
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a diff in pull request #36749: [SPARK-39295][DOCS][PYTHON][3.3] Improve documentation of pandas API supported list
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #36749:
URL: https://github.com/apache/spark/pull/36749#discussion_r887871266
##########
python/docs/source/user_guide/pandas_on_spark/supported_pandas_api.rst:
##########
@@ -17,34 +17,32 @@
=====================
-Supported pandas APIs
+Supported pandas API
=====================
.. currentmodule:: pyspark.pandas
The following table shows the pandas APIs that implemented or non-implemented from pandas API on
-Spark.
+Spark. Some pandas API do not implement full parameters, so the third column shows missing
+parameters for each API.
-Some pandas APIs do not implement full parameters, so the third column shows missing parameters for
-each API.
+* 'Y' in the second column means it's implemented including its whole parameter.
+* 'N' means it's not implemented yet.
+* 'P' means it's partially implemented with the missing of some parameters.
-'Y' in the second column means it's implemented including its whole parameter.
-'N' means it's not implemented yet.
-'P' means it's partially implemented with the missing of some parameters.
+All API in the list below computes the data with distributed execution except the ones that require
+the local execution by design. For example, `DataFrame.to_numpy() <https://spark.apache.org/docs/
+latest/api/python/reference/pyspark.pandas/api/pyspark.pandas.DataFrame.to_numpy.html>`__
+requires to collect the data to the driver side.
If there is non-implemented pandas API or parameter you want, you can create an `Apache Spark
-JIRA <https://issues.apache.org/jira/projects/SPARK/summary>`__ to request or to contribute by your
-own.
+JIRA <https://issues.apache.org/jira/projects/SPARK/summary>`__ to request or to contribute by
+your own.
-The API list is updated based on the `pandas 1.3 official API
-reference <https://pandas.pydata.org/pandas-docs/version/1.3/reference/index.html>`__.
+The API list is updated based on the `pandas 1.3 official API reference
+<https://pandas.pydata.org/pandas-docs/version/1.3/reference/index.html>`__.
-All implemented APIs listed here are distributed except the ones that requires the local
-computation by design. For example, `DataFrame.to_numpy() <https://spark.apache.org
-/docs/latest/api/python/reference/pyspark.pandas/api/pyspark.pandas.DataFrame.
-to_numpy.html>`__ requires to collect the data to the driver side.
-
-Supported DataFrame APIs
+DataFrame API
------------------------
Review Comment:
```suggestion
-------------
```
--
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.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org