安装

警告

  1. classicML 兼容的Python版本: Python 3.7-3.10; 推荐使用Python 3.8 以上版本, Python 3.7目前已不进行软件测试并将在未来逐渐停止支持

  2. classicML 仅支持64位的系统,强行在32位系统上编译可能会导致精度异常

  3. classicML 现已支持在Apple Silicon上原生运行, 但您需要使用 Python 3.8 以上的版本

  4. classicML 将在v0.7.1的正式版开始支持Windows平台

1.在系统上安装Python开发环境

检查你是否安装了Python环境:

python3 --version
pip3 --version
virtualenv --version

如果已经安装这些软件包,请直接跳过.

否则,请安装 Pythonpip软件包管理器virtualenv虚拟环境

2.创建虚拟环境

Python 虚拟环境用于将软件包和系统隔离,避免你的误操作导致系统崩溃。

python3 -m venv --system-site-packages ./classicML  # 如果你使用的是Windows操作系统,路径将修改为 .\classicML
source ./classicML/bin/activate  # 激活虚拟环境, Windows操作系统对应命令为 .\classicML\Scripts\activate

3.安装classicML

使用PyPI安装预编译的软件包.

pip install classicML-python  # 这个软件包使用纯Python编写的,没有额外的加速

安装代码加速的软件包(可选)

警告

你执行完上面的操作就已经安装成功classicML,但是,你可以通过下面的方式安装拥有加速版本的classicML. 你可以选择以下两种方式中的任意一种进行安装加速版的classicML.值得注意的是,非常不推荐使用源码编译的方式在Windows安装.

使用PyPI安装预编译的软件包

pip install classicML

从GitHub上下载源代码进行构建

备注

  1. 若使用 Eigen 3.3.7或更高版本, 可以编译 classicML 0.5~0.7.1

  2. 若使用 Eigen 3.4.0或更高版本, 可以编译 classicML 0.8或更高版本

  3. 若使用 pybind11 2.6.0或更高版本, 可以编译 classicML 0.5~0.7

  4. 若使用 pybind11 2.9.0或更高版本, 可以编译 classicML 0.7.1或更高版本

  5. C++ 的版本不得低于 c++17

安装Eigen 3(以macOS为例)

Eigen3 在不同平台软件包的名称可能有差异,安装方法也有差异.

brew install eigen
# Linux: apt install libeigen3-dev
# Windows: vcpkg install eigen3:x64-windows

安装pybind11

pip install pybind11

下载源码并安装classicML

使用Git克隆仓库,安装脚本将自动安装classicML软件包.

git clone https://github.com/sun1638650145/classicML.git
cd classicML
python3 setup.py install