安装

aeon 目前支持 Python 版本 3.9、3.10、3.11 和 3.12。在执行这些说明之前,请确保您已安装兼容的 Python 版本(即从 https://www.python.org 获取)。

aeon 适用于大多数知名操作系统,并且我们的开发CI经常在macOS、Ubuntu和Windows服务器上进行测试。

在安装aeon时,目前主要有三种选择:

注意

While we try to keep output similar between OS and Python version, we cannot
guarantee estimators will output the same results for macOS ARM processors.

可选依赖项

所有安装选项都包括运行aeon框架组件所需的核心依赖项。一些估计器和功能需要可选的依赖项。如果没有这些依赖项,您可能会发现,在尝试使用某些功能时,系统会提示您安装额外的包。

对于每个安装选项,我们提供了一种仅安装核心依赖项的方法和一种安装所有依赖项(不包括某些不稳定的依赖项)的方法。安装所有依赖项可能需要一些时间来处理安装过程,并可能对其他包的版本引入限制,但将允许所有aeon功能无障碍使用。

从PyPi安装最新版本

我们建议为您的aeon安装创建一个虚拟环境。这将确保aeon的依赖项不会与您可能已安装的其他包发生冲突。

aeon 版本可通过 PyPI 获取。要通过 pip 安装最新的 aeon 版本及其核心依赖项,请输入:

pip install -U aeon

要安装带有所有稳定依赖项的aeon,请使用all_extras修饰符进行安装。这将同时安装核心依赖项,因此不需要上述命令。

pip install -U aeon[all_extras]

注意

If this results in a "no matches found" error, it may be due to how your shell
handles special characters. Try surrounding the dependency portion with quotes i.e.

pip install -U aeon"[all_extras]"

警告

Some dependencies included in `all_extras` may have installation issues for macOS
with ARM processors. More details can be found in the troubleshooting section below.

安装后,您可以通过运行以下命令来验证aeon是否正确安装:

pip show aeon  # see information about the installation i.e. version and file location
pip freeze  # see all installed packages for the current environment

有关aeon的依赖项以及更多依赖项组(例如仅用于深度学习的依赖项,或从all_extras中排除的不太稳定的依赖项列表)的更多信息,请参阅pyproject.toml配置文件。

从conda-forge安装最新版本

aeon 版本也可以通过 conda-forge 获取。 运行以下命令以创建新的 aeon 环境并安装该包:

conda create -n aeon-env -c conda-forge aeon
conda activate aeon-env

安装后,您可以通过运行以下命令来验证aeon是否正确安装:

conda list aeon  # see information about the installation i.e. version and file location
conda list  # see all installed packages for the current environment

目前对于conda安装,可选依赖项必须单独安装。

使用 pip 安装最新的开发版本

与上述方法类似,我们建议为您的aeon安装创建一个虚拟环境

如果您已经安装了最新的aeon版本或aeon GitHub main分支,您需要先卸载它,然后再按照以下说明操作:

pip uninstall aeon

aeon 的最新进展和错误修复可在 aeon GitHubmain 分支上获取。可以通过 pip install 直接从 GitHub 安装 main 分支:

pip install -U git+https://github.com/aeon-toolkit/aeon.git@main

要从GitHub的main分支安装aeon并包含所有稳定依赖项,可以使用以下命令。

pip install -U "aeon[all_extras] @ git+https://github.com/aeon-toolkit/aeon.git@main"

关于MacOS ARM处理器的相同警告和信息,检查安装版本和pyproject.toml依赖项的内容在前一节中同样适用。

使用 pip 虚拟环境

为了避免与其他包发生潜在冲突,我们强烈建议使用虚拟环境(venv)或全新的conda环境来进行上述安装选项。

您可以使用以下命令创建一个虚拟环境。虚拟环境名称 aeon-venv 可以替换为您选择的名称。

Windows 和 macOS:

python -m venv aeon-venv

Linux:

python3 -m venv aeon-venv

然后可以使用以下命令激活此环境:

Windows:

aeon-venv\Scripts\activate

macOS 和 Linux:

source aeon-venv/bin/activate

请注意,这只会为当前终端会话激活环境。 如果您希望在不同的终端会话中使用该环境,您将需要 再次激活它。

故障排除

如果下面的常见错误没有帮助,可能值得查看scikit-learn故障排除部分

ModuleNotFoundError

出现ModuleNotFoundError的最常见原因是使用最小依赖项安装aeon(即仅pip install aeon),并使用了一个需要环境中未安装的包的估计器。要解决此问题,请安装缺失的包,或使用最大依赖项安装aeon(见上文),或根据错误提示安装单独的包。

ImportError

导入错误通常是由未正确链接的虚拟环境引起的。请确保您的环境已激活并链接到您正在使用的任何IDE。您可以在VScode中找到执行此操作的说明这里。如果您使用的是Jupyter Notebooks,请按照这些说明将您的虚拟环境添加为笔记本的新内核。

在带有ARM处理器的Mac上安装all_extras

如果您使用的是带有ARM处理器的Mac,在安装aeon[all_extras]时可能会遇到错误。这是因为all_extras中包含的一些库与基于ARM的处理器不兼容。如果您遇到此问题,可以尝试单独安装软依赖项。

如果您能在基于ARM的处理器上遇到all_extras安装的任何问题,请报告到aeon GitHub issues page,我们将不胜感激。

此外,基于ARM的处理器在安装以源代码分发包而非Python轮子形式分发的包时可能会遇到问题。为了避免在安装包时出现此问题,您可以尝试通过conda安装,或者使用之前以轮子形式分发的包版本。

安装all_extrasno matches found

一些shell(例如常用的Zsh)使用方括号作为特殊字符。如果您使用这样的shell,在安装aeon[all_extras]时可能会遇到错误。可以通过将依赖部分用引号括起来来解决,例如。

pip install -U aeon"[all_extras]"