From f19a120f619a94e1267e576e6039f1411da6cfc0 Mon Sep 17 00:00:00 2001 From: dsdsdshe Date: Sat, 9 Aug 2025 00:12:11 +0800 Subject: [PATCH] Fix: Correct mindquantum wheel filenames in installation docs --- .../docs/source_en/mindquantum_install.md | 62 ++++++++++++------ .../docs/source_zh_cn/mindquantum_install.md | 64 +++++++++++++------ 2 files changed, 85 insertions(+), 41 deletions(-) diff --git a/docs/mindquantum/docs/source_en/mindquantum_install.md b/docs/mindquantum/docs/source_en/mindquantum_install.md index 3bf300dcdf..f5e2064c61 100644 --- a/docs/mindquantum/docs/source_en/mindquantum_install.md +++ b/docs/mindquantum/docs/source_en/mindquantum_install.md @@ -53,34 +53,34 @@ Please select the appropriate `mindquantum-0.11.0` version from the table below Linux x86_64 (CPU/GPU) 3.9 - mindquantum-0.11.0-cp39-cp39-manylinux_2_27_x86_64.whl - sha256 + mindquantum-0.11.0-cp39-cp39-linux_x86_64.whl + sha256 3.10 - mindquantum-0.11.0-cp310-cp310-manylinux_2_27_x86_64.whl - sha256 + mindquantum-0.11.0-cp310-cp310-linux_x86_64.whl + sha256 3.11 - mindquantum-0.11.0-cp311-cp311-manylinux_2_27_x86_64.whl - sha256 + mindquantum-0.11.0-cp311-cp311-linux_x86_64.whl + sha256 aarch64 (CPU) 3.9 - mindquantum-0.11.0-cp39-cp39-manylinux_2_26_aarch64.manylinux_2_27_aarch64.whl - sha256 + mindquantum-0.11.0-cp39-cp39-linux_aarch64.whl + sha256 3.10 - mindquantum-0.11.0-cp310-cp310-manylinux_2_26_aarch64.manylinux_2_27_aarch64.whl - sha256 + mindquantum-0.11.0-cp310-cp310-linux_aarch64.whl + sha256 3.11 - mindquantum-0.11.0-cp311-cp311-manylinux_2_26_aarch64.manylinux_2_27_aarch64.whl - sha256 + mindquantum-0.11.0-cp311-cp311-linux_aarch64.whl + sha256 Windows @@ -143,16 +143,38 @@ You can install directly via URL using pip, or download the whl package and its ```bash # Method 1: Install directly from URL (e.g., for Linux x86_64, Python 3.9) -pip install https://ms-release.obs.cn-north-4.myhuaweicloud.com/2.7.0rc1/MindQuantum/gpu/x86_64/cuda-11.1/mindquantum-0.11.0-cp39-cp39-manylinux_2_27_x86_64.whl - -# Method 2: Install after local download -# 1. Download the whl package and its corresponding .sha256 file from the table above -# 2. Verify integrity (optional, but recommended) -sha256sum -c mindquantum-0.11.0-cp39-cp39-manylinux_2_27_x86_64.whl.sha256 -# 3. Install using pip -pip install mindquantum-0.11.0-cp39-cp39-manylinux_2_27_x86_64.whl +pip install https://ms-release.obs.cn-north-4.myhuaweicloud.com/2.7.0rc1/MindQuantum/gpu/x86_64/cuda-11.1/mindquantum-0.11.0-cp39-cp39-linux_x86_64.whl ``` +**Installation and Verification from Local Download** + +1. **Download Files**: Download the `whl` package and its corresponding `.whl.sha256` checksum file from the table above. + +2. **Verify the Hash** (optional) + + First, compute the hash value of your downloaded `whl` file (replace `your_downloaded_file.whl` with your actual filename): + + ```bash + sha256sum your_downloaded_file.whl + ``` + + Next, display the official hash value recorded in the `.sha256` file: + + ```bash + cat your_downloaded_file.whl.sha256 + ``` + + **Manually compare** the hash strings from the two outputs. If they are identical, the file is correct. + + > **Note:** Please be aware that the filename recorded in the `.whl.sha256` file may not exactly match the actual filename of the downloaded `whl` package. This can happen because the build system sometimes standardizes filenames for broader compatibility (e.g., renaming `manylinux_2_27_x86_64` to `linux_x86_64`). Please use the hash value as the authoritative reference. + +3. **Install the Package**: After successful verification, install the package using `pip`: + + ```bash + # Replace your_downloaded_file.whl with your actual filename + pip install your_downloaded_file.whl + ``` + > - If you have a poor network connection, you can try using the Huawei Cloud mirror to speed up the download: `pip install -i https://repo.huaweicloud.com/repository/pypi/simple mindquantum`. ### Installing by Source Code diff --git a/docs/mindquantum/docs/source_zh_cn/mindquantum_install.md b/docs/mindquantum/docs/source_zh_cn/mindquantum_install.md index ebb10854be..4c943a135c 100644 --- a/docs/mindquantum/docs/source_zh_cn/mindquantum_install.md +++ b/docs/mindquantum/docs/source_zh_cn/mindquantum_install.md @@ -6,7 +6,7 @@ 在开始安装前，请确认您的软硬件环境满足以下要求： -- **Python 版本**：请确保您的Python环境是 **Python 3.9, 3.10 或 3.11** 版本。您可以使用 `python --version` 命令查看。 +- **Python 版本**：请确保您的 Python 环境是 **Python 3.9, 3.10 或 3.11** 版本。您可以使用 `python --version` 命令查看。 ### 版本配套关系 @@ -53,34 +53,34 @@ pip install mindquantum Linux x86_64 (CPU/GPU) 3.9 - mindquantum-0.11.0-cp39-cp39-manylinux_2_27_x86_64.whl - sha256 + mindquantum-0.11.0-cp39-cp39-linux_x86_64.whl + sha256 3.10 - mindquantum-0.11.0-cp310-cp310-manylinux_2_27_x86_64.whl - sha256 + mindquantum-0.11.0-cp310-cp310-linux_x86_64.whl + sha256 3.11 - mindquantum-0.11.0-cp311-cp311-manylinux_2_27_x86_64.whl - sha256 + mindquantum-0.11.0-cp311-cp311-linux_x86_64.whl + sha256 aarch64 (CPU) 3.9 - mindquantum-0.11.0-cp39-cp39-manylinux_2_26_aarch64.manylinux_2_27_aarch64.whl - sha256 + mindquantum-0.11.0-cp39-cp39-linux_aarch64.whl + sha256 3.10 - mindquantum-0.11.0-cp310-cp310-manylinux_2_26_aarch64.manylinux_2_27_aarch64.whl - sha256 + mindquantum-0.11.0-cp310-cp310-linux_aarch64.whl + sha256 3.11 - mindquantum-0.11.0-cp311-cp311-manylinux_2_26_aarch64.manylinux_2_27_aarch64.whl - sha256 + mindquantum-0.11.0-cp311-cp311-linux_aarch64.whl + sha256 Windows @@ -143,16 +143,38 @@ pip install mindquantum ```bash # 方式一：使用URL直接安装 (以Linux x86_64，Python 3.9为例) -pip install https://ms-release.obs.cn-north-4.myhuaweicloud.com/2.7.0rc1/MindQuantum/gpu/x86_64/cuda-11.1/mindquantum-0.11.0-cp39-cp39-manylinux_2_27_x86_64.whl - -# 方式二：本地下载后安装 -# 1. 从上表下载whl包和对应的.sha256文件 -# 2. 校验完整性 (可选，推荐) -sha256sum -c mindquantum-0.11.0-cp39-cp39-manylinux_2_27_x86_64.whl.sha256 -# 3. 使用pip安装 -pip install mindquantum-0.11.0-cp39-cp39-manylinux_2_27_x86_64.whl +pip install https://ms-release.obs.cn-north-4.myhuaweicloud.com/2.7.0rc1/MindQuantum/gpu/x86_64/cuda-11.1/mindquantum-0.11.0-cp39-cp39-linux_x86_64.whl ``` +**本地下载后安装与校验** + +1. **下载文件**：从上表下载 `whl` 安装包和对应的 `.whl.sha256` 校验文件。 + +2. **校验哈希值**（可选） + + 首先，计算您下载的 `whl` 文件的哈希值（请将命令中的 `your_downloaded_file.whl` 替换为您的实际文件名）： + + ```bash + sha256sum your_downloaded_file.whl + ``` + + 然后，查看 `.sha256` 文件中记录的官方哈希值： + + ```bash + cat your_downloaded_file.whl.sha256 + ``` + + **手动比对**两个命令输出的哈希字符串。如果完全一致，则说明文件正确无误。 + + > **说明：** `.whl.sha256` 文件中记录的文件名可能与您下载的 `whl` 包的实际文件名不一致。这是因为构建系统有时会为了确保更广泛的兼容性而对文件名进行标准化处理（例如，将 `manylinux_2_27_x86_64.whl` 重命名为 `linux_x86_64.whl`）。请以哈希值为准。 + +3. **安装软件包**：确认校验无误后，使用 `pip` 安装： + + ```bash + # 请将 your_downloaded_file.whl 替换为您的实际文件名 + pip install your_downloaded_file.whl + ``` + > - 如果您的网络环境不佳，可以尝试使用华为云镜像源加速下载：`pip install -i https://repo.huaweicloud.com/repository/pypi/simple mindquantum`。 ### 源码安装 -- Gitee