Tutorials References Menu

Pandas DataFrame mod() Method

❮ DataFrame Reference


Example

Find the remainder of each value when you divide them by 3:

import pandas as pd

data = {
   "points": [5, 6, 4],
  "total": [50, 40, 20]
}

df = pd.DataFrame(data)

print(df.mod(3))
Try it Yourself »

Definition and Usage

The mod() method finds the modulo (remainder) of each value in the DataFrame when you divide them by a a specified value.

The specified value must be an object that can be divided from the values in the DataFrame. It can be a constant number like the one in the example, or it can be a list-like object like a list [15, 20] or a tuple {"points": 380, "total": 22}, or a  Pandas Series or another DataFrame, that fits with the original DataFrame.


Syntax

dataframe.mod(other, axis, level, fill_value)

Parameters

Parameter Description
other Required. A number, list of numbers, or another object with a data structure that fits with the original DataFrame.
axis Optional, A definition that decides whether to compare by index or columns.
0 or 'index' means compare by index.
1 or 'columns' means compare by columns
level Optional. A number or label that indicates where to compare.
fill_value Optional. A number, or None. Specifies what to do with NaN values before finding the modulo.

Return Value

A DataFrame with the modulus.


❮ DataFrame Reference