You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2020/09/14 10:04:15 UTC
[GitHub] [arrow] jorisvandenbossche commented on a change in pull request #8145: ARROW-9967: [Python] Add compute module documentation
jorisvandenbossche commented on a change in pull request #8145:
URL: https://github.com/apache/arrow/pull/8145#discussion_r487793214
##########
File path: docs/source/python/api/compute.rst
##########
@@ -0,0 +1,206 @@
+.. 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.
+
+.. _api.compute:
+.. currentmodule:: pyarrow
+
+Compute Functions
+=================
+
+Aggregations
+------------
+
+.. autosummary::
+ :toctree: ../generated/
+
+ count
+ mean
+ min_max
+ sum
+ mode
+
+Arithmetic Functions
+--------------------
+
+By default these functions do not detect overflow. Each function is also
+available in an overflow-checking variant, suffixed `_checked`, which
Review comment:
```suggestion
available in an overflow-checking variant, suffixed ``_checked``, which
```
in general need double backticks to have something rendered as code
##########
File path: docs/source/python/api/compute.rst
##########
@@ -0,0 +1,206 @@
+.. 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.
+
+.. _api.compute:
+.. currentmodule:: pyarrow
+
+Compute Functions
+=================
+
+Aggregations
+------------
+
+.. autosummary::
+ :toctree: ../generated/
+
+ count
+ mean
+ min_max
+ sum
+ mode
+
+Arithmetic Functions
+--------------------
+
+By default these functions do not detect overflow. Each function is also
+available in an overflow-checking variant, suffixed `_checked`, which
+throws an `ArrowInvalid` exception when overflow is detected.
+
+.. autosummary::
+ :toctree: ../generated/
+
+ add
+ add_checked
+ subtract
+ subtract_checked
+ multiply
+ multiply_checked
+ divide
+ divide_checked
+
+Comparisons
+-----------
+
+These functions expect two inputs of the same type. If one of the inputs is `null`
+they return `null`.
+
+.. autosummary::
+ :toctree: ../generated/
+
+ equal
+ not_equal
+ greater
+ greater_equal
+ less
+ less_equal
+
+
+Logical Functions
+-----------
+
+These functions normally emit a null when one of the inputs is null. However, Kleene
+logic variants are provided (suffixed `_kleene`). See User Guide for details.
+
+.. autosummary::
+ :toctree: ../generated/
+
+ and_
+ and_kleene
+ invert
+ or_
+ or_kleene
+ xor
+
+String Predicates
+-----------------
+
+In these functions an empty string emits false in the output. For ASCII
+variants (prefixed `ascii_`) a string element with non-ASCII characters
+emits false in the output.
+
+The first set of functions emit true if the input contains only
+characters of a given class.
+
+.. autosummary::
+ :toctree: ../generated/
+
+ ascii_is_alnum
+ ascii_is_alpha
+ ascii_is_decimal
+ ascii_is_lower
+ ascii_is_printable
+ ascii_is_space
+ ascii_is_upper
+ utf8_is_alnum
+ utf8_is_alpha
+ utf8_is_decimal
+ utf8_is_digit
+ utf8_is_lower
+ utf8_is_numeric
+ utf8_is_printable
+ utf8_is_space
+ utf8_is_upper
+
+The second set of functions also consider the order of characters
+in the string element.
+
+.. autosummary::
+ :toctree: ../generated/
+
+ ascii_is_title
+ utf8_is_title
+
+The third set of functions examines string elements on
+a byte-by-byte basis.
+
+.. autosummary::
+ :toctree: ../generated/
+
+ string_is_ascii
+
+String Transforms
+-----------------
+
+.. autosummary::
+ :toctree: ../generated/
+
+ ascii_lower
+ ascii_upper
+ binary_length
Review comment:
this is not really a transform?
##########
File path: docs/source/python/compute.rst
##########
@@ -0,0 +1,54 @@
+.. 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.
+
+.. currentmodule:: pyarrow.compute
+.. _compute:
+
+=================
+Compute Functions
+=================
+
+Arrow supports logical compute operations over inputs of possibly
+varying types. Many compute functions support both array (chunked or not)
+and scalar inputs, but some will mandate either. For example,
+the ``fill_null`` function requires its second input to be a scalar,
+while ``sort_indices`` requires its first and only input to
+be an array.
+
+Below are a few simple examples:
+
+ >>> import pyarrow as pa
+ >>> import pyarrow.compute as pc
+ >>> a = pa.array([1, 1, 2, 3])
+ >>> pc.sum(a)
+ <pyarrow.Int64Scalar: 7>
+ >>> b = pa.array([4, 5, 8, 2])
Review comment:
this array is not used? (maybe show pc.equals(a, b) ?)
##########
File path: docs/source/python/compute.rst
##########
@@ -0,0 +1,54 @@
+.. 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.
+
+.. currentmodule:: pyarrow.compute
+.. _compute:
+
+=================
+Compute Functions
+=================
+
+Arrow supports logical compute operations over inputs of possibly
Review comment:
what does the "logical" in here mean exactly?
----------------------------------------------------------------
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:
users@infra.apache.org