Installation

Confirming Version Matching Relationship

The currently supported hardware is the Atlas 800T A2 training server.

The current recommended Python version for the suite is 3.10.

MindFormers	MindSpore	CANN	Firmware & Drivers	Mirror Links
1.3.0	2.4.0	8.0.RC3.beta1	24.1.RC3	Link

Currently MindFormers recommends using a software package relationship as above.

Historical version matching relationship:

MindFormers	MindSpore	CANN	Firmware & Drivers	Mirror Links
1.2.0	2.3.0	8.0.RC2.beta1	24.1.RC2	Link

Install Firmware and Driver: Download the firmware and driver package through the Version Matching Relationship to download the installation package, and refer to the Ascend official tutorial for installation.
Install CANN and MindSpore: Use the officially provided Docker image (CANN, MindSpore are already included in the image, no need to install them manually) or follow the Manual Installation section on the MindSpore website for installation.

MindFormers supports both source code compiled installation and pip installation.

Users can compile and install MindFormers by executing the following command:

git clone -b v1.3.0 https://gitee.com/mindspore/mindformers.git
cd mindformers
bash build.sh

Users can download and install MindFormers by executing the following command:

pip install mindformers==1.3.0

Note: This method only installs the MindFormers base package, please get the model files, scripts, etc. from the MindFormers gitee repository.

To determine whether MindFormers has been successfully installed, execute the following command:

import mindformers as mf
mf.run_check()

A similar result as below proves that the installation was successful:

- INFO - All checks passed, used **** seconds, the environment is correctly set up!