jorisvandenbossche commented on a change in pull request #8145: URL: https://github.com/apache/arrow/pull/8145#discussion_r497651925
########## File path: docs/source/python/compute.rst ########## @@ -0,0 +1,55 @@ +.. 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, 1, 2, 8]) + >>> pc.equal(a, b) + <pyarrow.lib.BooleanArray object at 0x7f686e4eef30> + [ + false, + true, + true, + false + ] + >>> x, y = pa.scalar(7.8), pa.scalar(9.3) + >>> pc.multiply(x, y) + <pyarrow.DoubleScalar: 72.54> + + +.. seealso:: + A comprehensive description of compute functions can be found in the + C++ implementation docs. Review comment: Is this a page in the docs we can link to? ########## 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 Review comment: This won't render the docstring here, but it will create a separate page for each of those functions and link to that from this table. (the separate pages might be a bit overkill since the docstrings here are often not that informative yet, but it's indeed how we do it for other functions as well) ---------------------------------------------------------------- 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: us...@infra.apache.org
