ray.data.Dataset.sum#

Dataset.sum(on: Union[None, str, Callable[[ray.data.block.T], Any], List[Union[None, str, Callable[[ray.data.block.T], Any]]]] = None, ignore_nulls: bool = True) → ray.data.block.U[source]#

Compute sum over entire dataset.

Note

This operation will trigger execution of the lazy transformations performed on this dataset, and will block until execution completes.

Examples

>>> import ray
>>> ray.data.range(100).sum()
4950
>>> ray.data.from_items([
...     (i, i**2)
...     for i in range(100)]).sum(lambda x: x[1])
328350
>>> ray.data.range_table(100).sum("value")
4950
>>> ray.data.from_items([
...     {"A": i, "B": i**2}
...     for i in range(100)]).sum(["A", "B"])
{'sum(A)': 4950, 'sum(B)': 328350}
Parameters

  • on –

    The data subset on which to compute the sum.

    • For a simple dataset: it can be a callable or a list thereof, and the default is to return a scalar sum of all rows.

    • For an Arrow dataset: it can be a column name or a list thereof, and the default is to return an ArrowRow containing the column-wise sum of all columns.

  • ignore_nulls – Whether to ignore null values. If True, null values will be ignored when computing the sum; if False, if a null value is encountered, the output will be None. We consider np.nan, None, and pd.NaT to be null values. Default is True.

Returns

The sum result.

For a simple dataset, the output is:

  • on=None: a scalar representing the sum of all rows,

  • on=callable: a scalar representing the sum of the outputs of the callable called on each row,

  • on=[callable_1, ..., calalble_n]: a tuple of (sum_1, ..., sum_n) representing the sum of the outputs of the corresponding callables called on each row.

For an Arrow dataset, the output is:

  • on=None: an ArrowRow containing the column-wise sum of all columns,

  • on="col": a scalar representing the sum of all items in column "col",

  • on=["col_1", ..., "col_n"]: an n-column ArrowRow containing the column-wise sum of the provided columns.

If the dataset is empty, all values are null, or any value is null AND ignore_nulls is False, then the output will be None.