性能提升#

在本教程的这一部分中,我们将研究如何使用 Cython、Numba 和 pandas.eval() 加速对 pandas DataFrame 进行操作的某些函数。通常,使用 Cython 和 Numba 可以比使用 pandas.eval() 提供更大的加速,但需要更多代码。

注意

除了遵循本教程中的步骤外,有兴趣提高性能的用户强烈建议安装 pandas 的推荐依赖项。这些依赖项通常不会默认安装,但如果存在,将提供速度提升。

Cython(为 pandas 编写 C 扩展)#

对于许多用例,用纯 Python 和 NumPy 编写 pandas 就足够了。然而,在一些计算量大的应用中,可以通过将工作卸载到 cython 来实现相当大的提速。

本教程假设您已尽可能地在 Python 中重构,例如尝试删除 for 循环并利用 NumPy 向量化。始终值得先在 Python 中进行优化。

本教程将逐步介绍一个“典型”的 cython 化慢速计算过程。我们使用 Cython 文档中的示例,但在 pandas 的上下文中。我们最终的 cython 化解决方案比纯 Python 解决方案快大约 100 倍。

纯 Python#

我们有一个 DataFrame,我们希望对其逐行应用函数。

In [1]: df = pd.DataFrame(
   ...:     {
   ...:         "a": np.random.randn(1000),
   ...:         "b": np.random.randn(1000),
   ...:         "N": np.random.randint(100, 1000, (1000)),
   ...:         "x": "x",
   ...:     }
   ...: )
   ...: 

In [2]: df
Out[2]: 
            a         b    N  x
0    0.469112 -0.218470  585  x
1   -0.282863 -0.061645  841  x
2   -1.509059 -0.723780  251  x
3   -1.135632  0.551225  972  x
4    1.212112 -0.497767  181  x
..        ...       ...  ... ..
995 -1.512743  0.874737  374  x
996  0.933753  1.120790  246  x
997 -0.308013  0.198768  157  x
998 -0.079915  1.757555  977  x
999 -1.010589 -1.115680  770  x

[1000 rows x 4 columns]

以下是纯 Python 中的函数

In [3]: def f(x):
   ...:     return x * (x - 1)
   ...: 

In [4]: def integrate_f(a, b, N):
   ...:     s = 0
   ...:     dx = (b - a) / N
   ...:     for i in range(N):
   ...:         s += f(a + i * dx)
   ...:     return s * dx
   ...: 

我们通过使用 DataFrame.apply()(逐行)来实现我们的结果

In [5]: %timeit df.apply(lambda x: integrate_f(x["a"], x["b"], x["N"]), axis=1)
91 ms +- 432 us per loop (mean +- std. dev. of 7 runs, 10 loops each)

让我们看看在使用 prun ipython 魔术函数 进行此操作期间,时间花在了哪里

# most time consuming 4 calls
In [6]: %prun -l 4 df.apply(lambda x: integrate_f(x["a"], x["b"], x["N"]), axis=1)  # noqa E999
         605968 function calls (605950 primitive calls) in 0.170 seconds

   Ordered by: internal time
   List reduced from 166 to 4 due to restriction <4>

   ncalls  tottime  percall  cumtime  percall filename:lineno(function)
     1000    0.100    0.000    0.151    0.000 <ipython-input-4-c2a74e076cf0>:1(integrate_f)
   552423    0.051    0.000    0.051    0.000 <ipython-input-3-c138bdd570e3>:1(f)
     3000    0.003    0.000    0.013    0.000 series.py:1086(__getitem__)
     3000    0.002    0.000    0.006    0.000 series.py:1211(_get_value)

绝大多数时间都花在 integrate_ff 函数内部,因此我们将集中精力对这两个函数进行 Cython 化。

纯 Cython#

首先,我们需要将 Cython 魔法函数导入到 IPython 中。

In [7]: %load_ext Cython

现在,让我们简单地将我们的函数复制到 Cython 中。

In [8]: %%cython
   ...: def f_plain(x):
   ...:     return x * (x - 1)
   ...: def integrate_f_plain(a, b, N):
   ...:     s = 0
   ...:     dx = (b - a) / N
   ...:     for i in range(N):
   ...:         s += f_plain(a + i * dx)
   ...:     return s * dx
   ...: 
In [9]: %timeit df.apply(lambda x: integrate_f_plain(x["a"], x["b"], x["N"]), axis=1)
47.3 ms +- 70.2 us per loop (mean +- std. dev. of 7 runs, 10 loops each)

与纯 Python 方法相比,这将性能提高了三分之一。

声明 C 类型#

我们可以对函数变量和返回值类型进行注释,并使用 cdefcpdef 来提高性能。

In [10]: %%cython
   ....: cdef double f_typed(double x) except? -2:
   ....:     return x * (x - 1)
   ....: cpdef double integrate_f_typed(double a, double b, int N):
   ....:     cdef int i
   ....:     cdef double s, dx
   ....:     s = 0
   ....:     dx = (b - a) / N
   ....:     for i in range(N):
   ....:         s += f_typed(a + i * dx)
   ....:     return s * dx
   ....: 
In [11]: %timeit df.apply(lambda x: integrate_f_typed(x["a"], x["b"], x["N"]), axis=1)
7.95 ms +- 8.93 us per loop (mean +- std. dev. of 7 runs, 100 loops each)

使用 C 类型对函数进行注释,与原始 Python 实现相比,性能提高了十倍以上。

使用 ndarray#

在重新分析时,时间花在了从每一行创建 Series 以及从索引和序列中调用 __getitem__(每行三次)上。这些 Python 函数调用很昂贵,可以通过传递一个 np.ndarray 来改进。

In [12]: %prun -l 4 df.apply(lambda x: integrate_f_typed(x["a"], x["b"], x["N"]), axis=1)
         52545 function calls (52527 primitive calls) in 0.019 seconds

   Ordered by: internal time
   List reduced from 164 to 4 due to restriction <4>

   ncalls  tottime  percall  cumtime  percall filename:lineno(function)
     3000    0.003    0.000    0.012    0.000 series.py:1086(__getitem__)
     3000    0.002    0.000    0.006    0.000 series.py:1211(_get_value)
     3000    0.002    0.000    0.002    0.000 base.py:3777(get_loc)
     3000    0.002    0.000    0.002    0.000 indexing.py:2765(check_dict_or_set_indexers)
In [13]: %%cython
   ....: cimport numpy as np
   ....: import numpy as np
   ....: cdef double f_typed(double x) except? -2:
   ....:     return x * (x - 1)
   ....: cpdef double integrate_f_typed(double a, double b, int N):
   ....:     cdef int i
   ....:     cdef double s, dx
   ....:     s = 0
   ....:     dx = (b - a) / N
   ....:     for i in range(N):
   ....:         s += f_typed(a + i * dx)
   ....:     return s * dx
   ....: cpdef np.ndarray[double] apply_integrate_f(np.ndarray col_a, np.ndarray col_b,
   ....:                                            np.ndarray col_N):
   ....:     assert (col_a.dtype == np.float64
   ....:             and col_b.dtype == np.float64 and col_N.dtype == np.dtype(int))
   ....:     cdef Py_ssize_t i, n = len(col_N)
   ....:     assert (len(col_a) == len(col_b) == n)
   ....:     cdef np.ndarray[double] res = np.empty(n)
   ....:     for i in range(len(col_a)):
   ....:         res[i] = integrate_f_typed(col_a[i], col_b[i], col_N[i])
   ....:     return res
   ....: 
Content of stderr:
In file included from /home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpy/core/include/numpy/ndarraytypes.h:1929,
                 from /home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpy/core/include/numpy/ndarrayobject.h:12,
                 from /home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpy/core/include/numpy/arrayobject.h:5,
                 from /home/runner/.cache/ipython/cython/_cython_magic_30a836062691f1794ff3b6c6d990f6ad5dccd13e.c:1215:
/home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpy/core/include/numpy/npy_1_7_deprecated_api.h:17:2: warning: #warning "Using deprecated NumPy API, disable it with " "#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION" [-Wcpp]
   17 | #warning "Using deprecated NumPy API, disable it with " \
      |  ^~~~~~~

此实现创建了一个零数组,并将 integrate_f_typed 应用于每一行后的结果插入其中。在 Cython 中,遍历 ndarray 比遍历 Series 对象更快。

由于 apply_integrate_f 被类型化为接受 np.ndarray,因此需要调用 Series.to_numpy() 来利用此函数。

In [14]: %timeit apply_integrate_f(df["a"].to_numpy(), df["b"].to_numpy(), df["N"].to_numpy())
831 us +- 4.54 us per loop (mean +- std. dev. of 7 runs, 1,000 loops each)

与之前的实现相比,性能提高了近十倍。

禁用编译器指令#

现在,绝大多数时间都花在了 apply_integrate_f 上。禁用 Cython 的 boundscheckwraparound 检查可以提高性能。

In [15]: %prun -l 4 apply_integrate_f(df["a"].to_numpy(), df["b"].to_numpy(), df["N"].to_numpy())
         78 function calls in 0.001 seconds

   Ordered by: internal time
   List reduced from 21 to 4 due to restriction <4>

   ncalls  tottime  percall  cumtime  percall filename:lineno(function)
        1    0.001    0.001    0.001    0.001 <string>:1(<module>)
        1    0.000    0.000    0.001    0.001 {built-in method builtins.exec}
        3    0.000    0.000    0.000    0.000 frame.py:4050(__getitem__)
        3    0.000    0.000    0.000    0.000 base.py:541(to_numpy)
In [16]: %%cython
   ....: cimport cython
   ....: cimport numpy as np
   ....: import numpy as np
   ....: cdef np.float64_t f_typed(np.float64_t x) except? -2:
   ....:     return x * (x - 1)
   ....: cpdef np.float64_t integrate_f_typed(np.float64_t a, np.float64_t b, np.int64_t N):
   ....:     cdef np.int64_t i
   ....:     cdef np.float64_t s = 0.0, dx
   ....:     dx = (b - a) / N
   ....:     for i in range(N):
   ....:         s += f_typed(a + i * dx)
   ....:     return s * dx
   ....: @cython.boundscheck(False)
   ....: @cython.wraparound(False)
   ....: cpdef np.ndarray[np.float64_t] apply_integrate_f_wrap(
   ....:     np.ndarray[np.float64_t] col_a,
   ....:     np.ndarray[np.float64_t] col_b,
   ....:     np.ndarray[np.int64_t] col_N
   ....: ):
   ....:     cdef np.int64_t i, n = len(col_N)
   ....:     assert len(col_a) == len(col_b) == n
   ....:     cdef np.ndarray[np.float64_t] res = np.empty(n, dtype=np.float64)
   ....:     for i in range(n):
   ....:         res[i] = integrate_f_typed(col_a[i], col_b[i], col_N[i])
   ....:     return res
   ....: 
Content of stderr:
In file included from /home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpy/core/include/numpy/ndarraytypes.h:1929,
                 from /home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpy/core/include/numpy/ndarrayobject.h:12,
                 from /home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpy/core/include/numpy/arrayobject.h:5,
                 from /home/runner/.cache/ipython/cython/_cython_magic_1acd0c4ec62f802e66ab641a1e7f5f3138567e90.c:1216:
/home/runner/micromamba/envs/test/lib/python3.10/site-packages/numpy/core/include/numpy/npy_1_7_deprecated_api.h:17:2: warning: #warning "Using deprecated NumPy API, disable it with " "#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION" [-Wcpp]
   17 | #warning "Using deprecated NumPy API, disable it with " \
      |  ^~~~~~~
In [17]: %timeit apply_integrate_f_wrap(df["a"].to_numpy(), df["b"].to_numpy(), df["N"].to_numpy())
620 us +- 3.17 us per loop (mean +- std. dev. of 7 runs, 1,000 loops each)

然而,循环索引器 i 访问数组中无效位置会导致段错误,因为内存访问没有检查。有关 boundscheckwraparound 的更多信息,请参阅 Cython 文档中的 编译器指令

Numba(JIT 编译)#

除了静态编译 Cython 代码之外,还可以使用 Numba 的动态即时(JIT)编译器。

Numba 允许您编写纯 Python 函数,这些函数可以通过 @jit 装饰器进行 JIT 编译为原生机器指令,其性能类似于 C、C++ 和 Fortran。

Numba 通过在导入时、运行时或静态地(使用包含的 pycc 工具)使用 LLVM 编译器基础设施生成优化的机器代码。Numba 支持将 Python 编译为在 CPU 或 GPU 硬件上运行,并且旨在与 Python 科学软件栈集成。

注意

@jit 编译会给函数的运行时增加开销,因此在使用小型数据集时可能无法实现性能优势。请考虑 缓存 您的函数以避免每次运行函数时都进行编译开销。

Numba 可以通过两种方式与 pandas 一起使用

  1. 在选定的 pandas 方法中指定 engine="numba" 关键字

  2. 定义您自己的用 @jit 装饰的 Python 函数,并将 SeriesDataFrame 的底层 NumPy 数组(使用 Series.to_numpy())传递到函数中

pandas Numba 引擎#

如果安装了 Numba,可以在某些 pandas 方法中指定 engine="numba",以使用 Numba 执行该方法。支持 engine="numba" 的方法还将具有一个 engine_kwargs 关键字,它接受一个字典,允许用户指定 "nogil""nopython""parallel" 键,并使用布尔值传递到 @jit 装饰器中。如果未指定 engine_kwargs,则默认值为 {"nogil": False, "nopython": True, "parallel": False},除非另有说明。

注意

在性能方面,**第一次使用 Numba 引擎运行函数时会很慢**,因为 Numba 会有一些函数编译开销。但是,JIT 编译的函数会被缓存,后续调用会很快。通常,Numba 引擎在处理大量数据点(例如 100 万个以上)时性能很高。

In [1]: data = pd.Series(range(1_000_000))  # noqa: E225

In [2]: roll = data.rolling(10)

In [3]: def f(x):
   ...:     return np.sum(x) + 5
# Run the first time, compilation time will affect performance
In [4]: %timeit -r 1 -n 1 roll.apply(f, engine='numba', raw=True)
1.23 s ± 0 ns per loop (mean ± std. dev. of 1 run, 1 loop each)
# Function is cached and performance will improve
In [5]: %timeit roll.apply(f, engine='numba', raw=True)
188 ms ± 1.93 ms per loop (mean ± std. dev. of 7 runs, 10 loops each)

In [6]: %timeit roll.apply(f, engine='cython', raw=True)
3.92 s ± 59 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)

如果您的计算硬件包含多个 CPU,可以通过将 parallel 设置为 True 来利用多个 CPU,从而实现最大的性能提升。在内部,pandas 利用 numba 对 DataFrame 的列进行并行计算;因此,这种性能优势仅对具有大量列的 DataFrame 有益。

In [1]: import numba

In [2]: numba.set_num_threads(1)

In [3]: df = pd.DataFrame(np.random.randn(10_000, 100))

In [4]: roll = df.rolling(100)

In [5]: %timeit roll.mean(engine="numba", engine_kwargs={"parallel": True})
347 ms ± 26 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)

In [6]: numba.set_num_threads(2)

In [7]: %timeit roll.mean(engine="numba", engine_kwargs={"parallel": True})
201 ms ± 2.97 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)

自定义函数示例#

通过使用 Series.to_numpy() 传递其 NumPy 数组表示,可以使用装饰有 @jit 的自定义 Python 函数与 pandas 对象一起使用。

import numba


@numba.jit
def f_plain(x):
    return x * (x - 1)


@numba.jit
def integrate_f_numba(a, b, N):
    s = 0
    dx = (b - a) / N
    for i in range(N):
        s += f_plain(a + i * dx)
    return s * dx


@numba.jit
def apply_integrate_f_numba(col_a, col_b, col_N):
    n = len(col_N)
    result = np.empty(n, dtype="float64")
    assert len(col_a) == len(col_b) == n
    for i in range(n):
        result[i] = integrate_f_numba(col_a[i], col_b[i], col_N[i])
    return result


def compute_numba(df):
    result = apply_integrate_f_numba(
        df["a"].to_numpy(), df["b"].to_numpy(), df["N"].to_numpy()
    )
    return pd.Series(result, index=df.index, name="result")
In [4]: %timeit compute_numba(df)
1000 loops, best of 3: 798 us per loop

在这个例子中,使用 Numba 比 Cython 更快。

Numba 还可以用来编写向量化函数,这些函数不需要用户显式地循环遍历向量的观测值;向量化函数会自动应用于每一行。考虑以下将每个观测值加倍的示例

import numba


def double_every_value_nonumba(x):
    return x * 2


@numba.vectorize
def double_every_value_withnumba(x):  # noqa E501
    return x * 2
# Custom function without numba
In [5]: %timeit df["col1_doubled"] = df["a"].apply(double_every_value_nonumba)  # noqa E501
1000 loops, best of 3: 797 us per loop

# Standard implementation (faster than a custom function)
In [6]: %timeit df["col1_doubled"] = df["a"] * 2
1000 loops, best of 3: 233 us per loop

# Custom function with numba
In [7]: %timeit df["col1_doubled"] = double_every_value_withnumba(df["a"].to_numpy())
1000 loops, best of 3: 145 us per loop

注意事项#

Numba 最擅长加速对 NumPy 数组应用数值函数的函数。如果您尝试 @jit 一个包含不支持的 PythonNumPy 代码的函数,编译将恢复 对象模式,这很可能不会加速您的函数。如果您希望 Numba 在无法以加速代码的方式编译函数时抛出错误,请将参数 nopython=True 传递给 Numba(例如 @jit(nopython=True))。有关 Numba 模式故障排除的更多信息,请参阅 Numba 故障排除页面

使用 parallel=True(例如 @jit(parallel=True))可能会导致 SIGABRT,如果线程层导致不安全的行为。您首先可以 指定一个安全的线程层,然后再运行带有 parallel=True 的 JIT 函数。

通常,如果您在使用 Numba 时遇到段错误 (SIGSEGV),请将问题报告给 Numba 问题跟踪器

通过 eval()# 的表达式求值

顶级函数 pandas.eval() 实现对 SeriesDataFrame 的高效表达式求值。表达式求值允许将操作表示为字符串,并且可以通过一次性评估所有算术和布尔表达式来为大型 DataFrame 提供潜在的性能提升。

注意

对于简单的表达式或涉及小型 DataFrames 的表达式,您不应该使用 eval()。事实上,对于较小的表达式或对象,eval() 比普通 Python 慢几个数量级。一个好的经验法则是,只有当您拥有超过 10,000 行的 DataFrame 时才使用 eval()

支持的语法#

这些操作受 pandas.eval() 支持

  • 除了左移 (<<) 和右移 (>>) 运算符之外的算术运算,例如:df + 2 * pi / s ** 4 % 42 - the_golden_ratio

  • 比较运算,包括链式比较,例如:2 < df < df2

  • 布尔运算,例如:df < df2 and df3 < df4 or not df_bool

  • listtuple 字面量,例如:[1, 2](1, 2)

  • 属性访问,例如:df.a

  • 下标表达式,例如:df[0]

  • 简单变量评估,例如:pd.eval("df")(这不太有用)

  • 数学函数:sincosexplogexpm1log1psqrtsinhcoshtanharcsinarccosarctanarccosharcsinharctanhabsarctan2log10

以下 Python 语法**不允许**

  • 表达式

    • 除了数学函数之外的函数调用。

    • is/is not 运算

    • if 表达式

    • lambda 表达式

    • list/set/dict 推导式

    • 字面量 dictset 表达式

    • yield 表达式

    • 生成器表达式

    • 仅由标量值组成的布尔表达式

  • 语句

    • 不允许使用 简单复合 语句。这包括 forwhileif

局部变量#

您必须显式引用要在表达式中使用的任何局部变量,方法是在名称前面加上 @ 字符。此机制对于 DataFrame.query()DataFrame.eval() 都是一样的。例如,

In [18]: df = pd.DataFrame(np.random.randn(5, 2), columns=list("ab"))

In [19]: newcol = np.random.randn(len(df))

In [20]: df.eval("b + @newcol")
Out[20]: 
0   -0.206122
1   -1.029587
2    0.519726
3   -2.052589
4    1.453210
dtype: float64

In [21]: df.query("b < @newcol")
Out[21]: 
          a         b
1  0.160268 -0.848896
3  0.333758 -1.180355
4  0.572182  0.439895

如果您没有在局部变量前面加上 @,pandas 将引发异常,告诉您变量未定义。

在使用 DataFrame.eval()DataFrame.query() 时,这允许您在表达式中拥有一个局部变量和一个与之同名的 DataFrame 列。

In [22]: a = np.random.randn()

In [23]: df.query("@a < a")
Out[23]: 
          a         b
0  0.473349  0.891236
1  0.160268 -0.848896
2  0.803311  1.662031
3  0.333758 -1.180355
4  0.572182  0.439895

In [24]: df.loc[a < df["a"]]  # same as the previous expression
Out[24]: 
          a         b
0  0.473349  0.891236
1  0.160268 -0.848896
2  0.803311  1.662031
3  0.333758 -1.180355
4  0.572182  0.439895

警告

如果您无法使用 @ 前缀(因为它在该上下文中未定义),pandas.eval() 将引发异常。

In [25]: a, b = 1, 2

In [26]: pd.eval("@a + b")
Traceback (most recent call last):

  File ~/micromamba/envs/test/lib/python3.10/site-packages/IPython/core/interactiveshell.py:3577 in run_code
    exec(code_obj, self.user_global_ns, self.user_ns)

  Cell In[26], line 1
    pd.eval("@a + b")

  File ~/work/pandas/pandas/pandas/core/computation/eval.py:325 in eval
    _check_for_locals(expr, level, parser)

  File ~/work/pandas/pandas/pandas/core/computation/eval.py:167 in _check_for_locals
    raise SyntaxError(msg)

  File <string>
SyntaxError: The '@' prefix is not allowed in top-level eval calls.
please refer to your variables by name without the '@' prefix.

在这种情况下,您应该像在标准 Python 中一样引用变量。

In [27]: pd.eval("a + b")
Out[27]: 3

pandas.eval() 解析器#

有两种不同的表达式语法解析器。

默认的 'pandas' 解析器允许更直观的语法来表达类似查询的操作(比较、连接和析取)。特别是,&| 运算符的优先级与相应的布尔运算符 andor 的优先级相同。

例如,上面的连接可以在没有括号的情况下编写。或者,您可以使用 'python' 解析器来强制执行严格的 Python 语义。

In [28]: nrows, ncols = 20000, 100

In [29]: df1, df2, df3, df4 = [pd.DataFrame(np.random.randn(nrows, ncols)) for _ in range(4)]

In [30]: expr = "(df1 > 0) & (df2 > 0) & (df3 > 0) & (df4 > 0)"

In [31]: x = pd.eval(expr, parser="python")

In [32]: expr_no_parens = "df1 > 0 & df2 > 0 & df3 > 0 & df4 > 0"

In [33]: y = pd.eval(expr_no_parens, parser="pandas")

In [34]: np.all(x == y)
Out[34]: True

相同的表达式可以使用单词 and 以及“与”运算符连接在一起

In [35]: expr = "(df1 > 0) & (df2 > 0) & (df3 > 0) & (df4 > 0)"

In [36]: x = pd.eval(expr, parser="python")

In [37]: expr_with_ands = "df1 > 0 and df2 > 0 and df3 > 0 and df4 > 0"

In [38]: y = pd.eval(expr_with_ands, parser="pandas")

In [39]: np.all(x == y)
Out[39]: True

这里的 andor 运算符具有与 Python 中相同的优先级。

pandas.eval() 引擎#

有两种不同的表达式引擎。

'numexpr' 引擎是性能更高的引擎,与标准 Python 语法相比,它可以为大型 DataFrame 带来性能提升。此引擎需要安装可选的依赖项 numexpr

除了用于测试其他评估引擎,'python' 引擎通常有用。使用 eval()engine='python' 不会带来任何性能优势,甚至可能导致性能下降。

In [40]: %timeit df1 + df2 + df3 + df4
6.88 ms +- 49.8 us per loop (mean +- std. dev. of 7 runs, 100 loops each)
In [41]: %timeit pd.eval("df1 + df2 + df3 + df4", engine="python")
7.52 ms +- 23.8 us per loop (mean +- std. dev. of 7 runs, 100 loops each)

DataFrame.eval() 方法#

除了顶层的 pandas.eval() 函数,您还可以评估 DataFrame 的“上下文”中的表达式。

In [42]: df = pd.DataFrame(np.random.randn(5, 2), columns=["a", "b"])

In [43]: df.eval("a + b")
Out[43]: 
0   -0.161099
1    0.805452
2    0.747447
3    1.189042
4   -2.057490
dtype: float64

任何有效的 pandas.eval() 表达式也是有效的 DataFrame.eval() 表达式,其额外优势在于您无需在要评估的列名之前添加 DataFrame 的名称。

此外,您可以在表达式中执行列的赋值。这允许进行公式化评估。赋值目标可以是新的列名或现有的列名,并且必须是有效的 Python 标识符。

In [44]: df = pd.DataFrame(dict(a=range(5), b=range(5, 10)))

In [45]: df = df.eval("c = a + b")

In [46]: df = df.eval("d = a + b + c")

In [47]: df = df.eval("a = 1")

In [48]: df
Out[48]: 
   a  b   c   d
0  1  5   5  10
1  1  6   7  14
2  1  7   9  18
3  1  8  11  22
4  1  9  13  26

返回包含新列或修改后的列的 DataFrame 的副本,原始框架保持不变。

In [49]: df
Out[49]: 
   a  b   c   d
0  1  5   5  10
1  1  6   7  14
2  1  7   9  18
3  1  8  11  22
4  1  9  13  26

In [50]: df.eval("e = a - c")
Out[50]: 
   a  b   c   d   e
0  1  5   5  10  -4
1  1  6   7  14  -6
2  1  7   9  18  -8
3  1  8  11  22 -10
4  1  9  13  26 -12

In [51]: df
Out[51]: 
   a  b   c   d
0  1  5   5  10
1  1  6   7  14
2  1  7   9  18
3  1  8  11  22
4  1  9  13  26

可以使用多行字符串执行多个列赋值。

In [52]: df.eval(
   ....:     """
   ....: c = a + b
   ....: d = a + b + c
   ....: a = 1""",
   ....: )
   ....: 
Out[52]: 
   a  b   c   d
0  1  5   6  12
1  1  6   7  14
2  1  7   8  16
3  1  8   9  18
4  1  9  10  20

标准 Python 中的等效项是

In [53]: df = pd.DataFrame(dict(a=range(5), b=range(5, 10)))

In [54]: df["c"] = df["a"] + df["b"]

In [55]: df["d"] = df["a"] + df["b"] + df["c"]

In [56]: df["a"] = 1

In [57]: df
Out[57]: 
   a  b   c   d
0  1  5   5  10
1  1  6   7  14
2  1  7   9  18
3  1  8  11  22
4  1  9  13  26

eval() 性能比较#

pandas.eval() 在包含大型数组的表达式中效果很好。

In [58]: nrows, ncols = 20000, 100

In [59]: df1, df2, df3, df4 = [pd.DataFrame(np.random.randn(nrows, ncols)) for _ in range(4)]

DataFrame 算术运算

In [60]: %timeit df1 + df2 + df3 + df4
7.11 ms +- 195 us per loop (mean +- std. dev. of 7 runs, 100 loops each)
In [61]: %timeit pd.eval("df1 + df2 + df3 + df4")
2.79 ms +- 16.6 us per loop (mean +- std. dev. of 7 runs, 100 loops each)

DataFrame 比较

In [62]: %timeit (df1 > 0) & (df2 > 0) & (df3 > 0) & (df4 > 0)
6.01 ms +- 56 us per loop (mean +- std. dev. of 7 runs, 100 loops each)
In [63]: %timeit pd.eval("(df1 > 0) & (df2 > 0) & (df3 > 0) & (df4 > 0)")
9.31 ms +- 53.2 us per loop (mean +- std. dev. of 7 runs, 100 loops each)

DataFrame 未对齐轴的算术运算。

In [64]: s = pd.Series(np.random.randn(50))

In [65]: %timeit df1 + df2 + df3 + df4 + s
12.5 ms +- 198 us per loop (mean +- std. dev. of 7 runs, 100 loops each)
In [66]: %timeit pd.eval("df1 + df2 + df3 + df4 + s")
3.59 ms +- 38.7 us per loop (mean +- std. dev. of 7 runs, 100 loops each)

注意

诸如

1 and 2  # would parse to 1 & 2, but should evaluate to 2
3 or 4  # would parse to 3 | 4, but should evaluate to 3
~1  # this is okay, but slower when using eval

之类的操作应在 Python 中执行。如果您尝试对类型不是 boolnp.bool_ 的标量操作数执行任何布尔/按位运算,则会引发异常。

以下是一个图表,显示了 pandas.eval() 的运行时间与参与计算的框架大小的关系。这两条线是两个不同的引擎。

../_images/eval-perf.png

只有当您的 DataFrame 行数超过大约 100,000 行时,您才会看到使用 numexpr 引擎与 pandas.eval() 的性能优势。

此图表是使用一个 DataFrame 创建的,该 DataFrame 包含 3 列,每列都包含使用 numpy.random.randn() 生成的浮点值。

使用 numexpr 的表达式评估限制#

由于 NaT,会导致对象类型或涉及日期时间操作的表达式必须在 Python 空间中进行评估,但表达式的部分仍然可以使用 numexpr 进行评估。例如

In [67]: df = pd.DataFrame(
   ....:     {"strings": np.repeat(list("cba"), 3), "nums": np.repeat(range(3), 3)}
   ....: )
   ....: 

In [68]: df
Out[68]: 
  strings  nums
0       c     0
1       c     0
2       c     0
3       b     1
4       b     1
5       b     1
6       a     2
7       a     2
8       a     2

In [69]: df.query("strings == 'a' and nums == 1")
Out[69]: 
Empty DataFrame
Columns: [strings, nums]
Index: []

比较的数字部分 (nums == 1) 将由 numexpr 评估,而比较的对象部分 ("strings == 'a') 将由 Python 评估。