Pandas 2.2 中文官方教程和指南（二十三）（1）-阿里云开发者社区

提高性能

原文：pandas.pydata.org/docs/user_guide/enhancingperf.html

在本教程的这一部分中，我们将研究如何加速在 pandas 的DataFrame上操作的某些函数，使用 Cython、Numba 和pandas.eval()。通常，使用 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)
74.9 ms +- 728 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
 605956 function calls (605938 primitive calls) in 0.167 seconds
 Ordered by: internal time
 List reduced from 163 to 4 due to restriction <4>
 ncalls  tottime  percall  cumtime  percall filename:lineno(function)
 1000    0.097    0.000    0.148    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.012    0.000 series.py:1095(__getitem__)
 3000    0.002    0.000    0.005    0.000 series.py:1220(_get_value)

绝大部分时间都花费在integrate_f或f内部，因此我们将集中精力将这两个函数进行 Cython 化。### 纯 Cython

首先，我们需要在 IPython 中导入 Cython 魔术函数：

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)
46.6 ms +- 466 us per loop (mean +- std. dev. of 7 runs, 10 loops each)

与纯 Python 方法相比，这已经将性能提升了三分之一。### 声明 C 类型

我们可以对函数变量和返回类型进行注释，以及使用cdef和cpdef来提高性能：

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.76 ms +- 83.8 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)
 52533 function calls (52515 primitive calls) in 0.019 seconds
 Ordered by: internal time
 List reduced from 161 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:1095(__getitem__)
 3000    0.002    0.000    0.005    0.000 series.py:1220(_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_96d1519457caba8fa4f96b759be00659f51c6b18.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())
834 us +- 4.04 us per loop (mean +- std. dev. of 7 runs, 1,000 loops each)

性能比以前的实现提高了近十倍。### 禁用编译器指令

现在大部分时间都花在apply_integrate_f上。禁用 Cython 的boundscheck和wraparound检查可以获得更多性能。

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:4062(__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_3bb7bde31cdaf5ab952bfe5a612c6edef03550d0.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 +- 2.65 us per loop (mean +- std. dev. of 7 runs, 1,000 loops each)

然而，访问数组中无效位置的循环索引器i会导致段错误，因为内存访问没有经过检查。有关boundscheck和wraparound的更多信息，请参阅 Cython 文档中关于编译器指令的部分。## Numba（JIT 编译）

作为静态编译 Cython 代码的替代方案，可以使用动态即时（JIT）编译器Numba。

Numba 允许您编写一个纯 Python 函数，该函数可以通过使用@jit装饰器编译为本机机器指令，性能类似于 C、C++和 Fortran，。

Numba 通过在导入时、运行时或静态（使用包含的 pycc 工具）生成优化的机器代码来工作。 Numba 支持将 Python 编译为在 CPU 或 GPU 硬件上运行，并设计用于与 Python 科学软件堆栈集成。

注意

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

Numba 可以与 pandas 一起以 2 种方式使用：

在选择的 pandas 方法中指定engine="numba"关键字
定义自己的 Python 函数，并使用@jit装饰器，并将Series或DataFrame的底层 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)

自定义函数示例

通过使用@jit修饰的自定义 Python 函数，可以通过使用Series.to_numpy()将它们的 NumPy 数组表示传递给 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一个包含不受支持的Python或NumPy代码的函数，编译将会回退到对象模式，这很可能不会加速您的函数。如果希望 Numba 在无法以加速代码的方式编译函数时抛出错误，请将参数nopython=True传递给 Numba（例如@jit(nopython=True)）。有关 Numba 模式故障排除的更多信息，请参阅Numba 故障排除页面。

使用parallel=True（例如@jit(parallel=True)）可能会导致SIGABRT，如果线程层导致不安全行为。您可以在使用parallel=True运行 JIT 函数之前，首先指定一个安全的线程层。

通常，如果在使用 Numba 时遇到段错误（SIGSEGV），请将问题报告给Numba 问题跟踪器。 ## 通过eval()进行表达式评估

顶层函数pandas.eval()实现了对Series和DataFrame的高性能表达式评估。表达式评估允许将操作表达为字符串，并且可以通过一次性评估大型DataFrame的算术和布尔表达式，潜在地提供性能改进。

注意

您不应该对简单表达式或涉及小 DataFrame 的表达式使用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
list和tuple字面值，例如，[1, 2]或(1, 2)
属性访问，例如，df.a
下标表达式，例如，df[0]
简单变量评估，例如，pd.eval("df")（这并不是很有用）
数学函数：sin、cos、exp、log、expm1、log1p、sqrt、sinh、cosh、tanh、arcsin、arccos、arctan、arccosh、arcsinh、arctanh、abs、arctan2和log10。

以下 Python 语法不允许：

表达式

除数学函数外的函数调用。

is/is not操作

if表达式

lambda表达式

list/set/dict推导

字面dict和set表达式

yield表达式

生成器表达式

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

语句

不允许使用简单或复合语句。这包括for、while和if。

本地变量

你必须显式引用你想在表达式中使用的任何本地变量，方法是在名称前面放置@字符。这个机制对于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'解析器允许更直观地表达类似查询的操作（比较、连接和离散）。特别是，&和|运算符的优先级被设置为与相应布尔操作and和or的优先级相等。

例如，上面的连接可以不使用括号写出。或者，你可以使用'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

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

Pandas 2.2 中文官方教程和指南（二十三）（2）https://developer.aliyun.com/article/1508853

Pandas 2.2 中文官方教程和指南（二十三）（1）

提高性能

Cython（为 pandas 编写 C 扩展）

纯 Python

pandas Numba 引擎

自定义函数示例

注意事项

支持的语法

本地变量

`pandas.eval()` 解析器

热门文章

最新文章

相关课程

相关电子书

相关实验场景

Pandas 2.2 中文官方教程和指南（二十三）（1）

提高性能

Cython（为 pandas 编写 C 扩展）

纯 Python

pandas Numba 引擎

自定义函数示例

注意事项

支持的语法

本地变量

pandas.eval() 解析器

热门文章

最新文章

相关课程

相关电子书

相关实验场景

`pandas.eval()` 解析器