Go to file
i-robot a381f51732
!46620 add new api GetTrainableParams in lite-training
Merge pull request !46620 from zhangyanhui/code_mas
2022-12-16 09:44:49 +00:00
.gitee Update checking function return value item. 2022-07-25 08:19:42 +08:00
.github
.jenkins fix msvc exception handler register 2022-12-16 14:14:03 +08:00
akg@a5ba9c3e8d adapt to gcc11 2022-12-13 09:50:14 +08:00
cmake !46549 [MSLITE] Change ascend ge to plugin and supports independent session. 2022-12-13 03:46:55 +00:00
config updata op info conifg 2022-12-09 17:04:40 +08:00
docs !46908 modify format 2022-12-16 09:37:32 +00:00
graphengine@2360018061 upgrade Ascend package 27 Sept on master 2022-10-07 22:38:24 +08:00
include !46620 add new api GetTrainableParams in lite-training 2022-12-16 09:44:49 +00:00
mindspore !46620 add new api GetTrainableParams in lite-training 2022-12-16 09:44:49 +00:00
scripts !45154 merge all cuda version and ascend to an unify wheel package 2022-11-18 01:57:32 +00:00
tests !45884 [Golden-Stick] support quant lenet model lite inference 2022-12-16 08:46:26 +00:00
third_party Adding support for FP16, cross & T5 MHA 2022-12-06 09:56:12 +02:00
.clang-format
.gitignore change runtime to litert 2022-07-30 02:35:17 -07:00
.gitmodules add models as submodule in tests 2021-09-16 10:03:19 +08:00
CMakeLists.txt adapt to gcc11 2022-12-13 09:50:14 +08:00
CONTRIBUTING.md add Chinese file 2022-07-21 16:53:49 +08:00
CONTRIBUTING_CN.md contributing_cn.md add link to pre-push reade_cn.md 2022-08-12 15:58:01 +08:00
LICENSE
NOTICE
OWNERS modify code owner 2022-09-20 15:58:39 +08:00
README.md fix readme 2022-11-01 19:42:37 +08:00
README_CN.md fix readme 2022-11-01 19:42:37 +08:00
RELEASE.md modify doc 2022-11-25 14:10:36 +08:00
RELEASE_CN.md modify doc 2022-11-25 14:10:36 +08:00
SECURITY.md add security for mindspore lite to SECURITY.md 2020-12-15 16:50:05 +08:00
Third_Party_Open_Source_Software_Notice notice update 2022-11-18 17:44:55 +08:00
build.bat support for incredibuild 2022-10-30 18:41:32 +08:00
build.sh plugin dynamic load 2022-09-05 19:27:38 +08:00
requirements.txt !45647 support GatherD onnx 2022-11-18 07:49:25 +00:00
setup.py include notice 2022-11-25 15:14:28 +08:00
version.txt upgrade Ascend package 27 Sept on master 2022-10-07 22:38:24 +08:00

README.md

MindSpore Logo

PyPI - Python Version PyPI Downloads DockerHub LICENSE Slack PRs Welcome

查看中文

What Is MindSpore

MindSpore is a new open source deep learning training/inference framework that could be used for mobile, edge and cloud scenarios. MindSpore is designed to provide development experience with friendly design and efficient execution for the data scientists and algorithmic engineers, native support for Ascend AI processor, and software hardware co-optimization. At the meantime MindSpore as a global AI open source community, aims to further advance the development and enrichment of the AI software/hardware application ecosystem.

MindSpore Architecture

For more details please check out our Architecture Guide.

Automatic Differentiation

Currently, there are two automatic differentiation techniques in mainstream deep learning frameworks:

  • Operator Overloading (OO): Overloading the basic operators of the programming language to encapsulate their gradient rules. Record the operation trajectory of the network during forward execution in an operator overloaded manner, then apply the chain rule to the dynamically generated data flow graph to implement automatic differentiation.
  • Source Transformation (ST): This technology is evolving from the functional programming framework and performs automatic differential transformation on the intermediate expression (the expression form of the program during the compilation process) in the form of just-in-time compilation (JIT), supporting complex control flow scenarios, higher-order functions and closures.

PyTorch used OO. Compared to ST, OO generates gradient graph in runtime, so it does not need to take function call and control flow into consideration, which makes it easier to develop. However, OO can not perform gradient graph optimization in compilation time and the control flow has to be unfolded in runtime, so it is difficult to achieve extreme optimization in performance.

MindSpore implemented automatic differentiation based on ST. On the one hand, it supports automatic differentiation of automatic control flow, so it is quite convenient to build models like PyTorch. On the other hand, MindSpore can perform static compilation optimization on neural networks to achieve great performance.

Automatic Differentiation

The implementation of MindSpore automatic differentiation can be understood as the symbolic differentiation of the program itself. Because MindSpore IR is a functional intermediate expression, it has an intuitive correspondence with the composite function in basic algebra. The derivation formula of the composite function composed of arbitrary basic functions can be derived. Each primitive operation in MindSpore IR can correspond to the basic functions in basic algebra, which can build more complex flow control.

Automatic Parallel

The goal of MindSpore automatic parallel is to build a training method that combines data parallelism, model parallelism, and hybrid parallelism. It can automatically select a least cost model splitting strategy to achieve automatic distributed parallel training.

Automatic Parallel

At present, MindSpore uses a fine-grained parallel strategy of splitting operators, that is, each operator in the figure is split into a cluster to complete parallel operations. The splitting strategy during this period may be very complicated, but as a developer advocating Pythonic, you don't need to care about the underlying implementation, as long as the top-level API compute is efficient.

Installation

Pip mode method installation

MindSpore offers build options across multiple backends:

Hardware Platform Operating System Status
Ascend910 Ubuntu-x86 ✔️
Ubuntu-aarch64 ✔️
EulerOS-aarch64 ✔️
CentOS-x86 ✔️
CentOS-aarch64 ✔️
GPU CUDA 10.1 Ubuntu-x86 ✔️
CPU Ubuntu-x86 ✔️
Ubuntu-aarch64 ✔️
Windows-x86 ✔️

For installation using pip, take CPU and Ubuntu-x86 build version as an example:

  1. Download whl from MindSpore download page, and install the package.

    pip install https://ms-release.obs.cn-north-4.myhuaweicloud.com/1.2.0-rc1/MindSpore/cpu/ubuntu_x86/mindspore-1.2.0rc1-cp37-cp37m-linux_x86_64.whl
    
  2. Run the following command to verify the install.

    import numpy as np
    import mindspore.context as context
    import mindspore.nn as nn
    from mindspore import Tensor
    from mindspore.ops import operations as P
    
    context.set_context(mode=context.GRAPH_MODE, device_target="CPU")
    
    class Mul(nn.Cell):
        def __init__(self):
            super(Mul, self).__init__()
            self.mul = P.Mul()
    
        def construct(self, x, y):
            return self.mul(x, y)
    
    x = Tensor(np.array([1.0, 2.0, 3.0]).astype(np.float32))
    y = Tensor(np.array([4.0, 5.0, 6.0]).astype(np.float32))
    
    mul = Mul()
    print(mul(x, y))
    
    [ 4. 10. 18.]
    

Use pip mode method to install MindSpore in different environments. Refer to the following documents.

Source code compilation installation

Use the source code compilation method to install MindSpore in different environments. Refer to the following documents.

Docker Image

MindSpore docker image is hosted on Docker Hub, currently the containerized build options are supported as follows:

Hardware Platform Docker Image Repository Tag Description
CPU mindspore/mindspore-cpu x.y.z Production environment with pre-installed MindSpore x.y.z CPU release.
devel Development environment provided to build MindSpore (with CPU backend) from the source, refer to https://www.mindspore.cn/install/en for installation details.
runtime Runtime environment provided to install MindSpore binary package with CPU backend.
GPU mindspore/mindspore-gpu x.y.z Production environment with pre-installed MindSpore x.y.z GPU release.
devel Development environment provided to build MindSpore (with GPU CUDA10.1 backend) from the source, refer to https://www.mindspore.cn/install/en for installation details.
runtime Runtime environment provided to install MindSpore binary package with GPU CUDA10.1 backend.

NOTICE: For GPU devel docker image, it's NOT suggested to directly install the whl package after building from the source, instead we strongly RECOMMEND you transfer and install the whl package inside GPU runtime docker image.

  • CPU

    For CPU backend, you can directly pull and run the latest stable image using the below command:

    docker pull mindspore/mindspore-cpu:1.1.0
    docker run -it mindspore/mindspore-cpu:1.1.0 /bin/bash
    
  • GPU

    For GPU backend, please make sure the nvidia-container-toolkit has been installed in advance, here are some install guidelines for Ubuntu users:

    DISTRIBUTION=$(. /etc/os-release; echo $ID$VERSION_ID)
    curl -s -L https://nvidia.github.io/nvidia-docker/gpgkey | apt-key add -
    curl -s -L https://nvidia.github.io/nvidia-docker/$DISTRIBUTION/nvidia-docker.list | tee /etc/apt/sources.list.d/nvidia-docker.list
    
    sudo apt-get update && sudo apt-get install -y nvidia-container-toolkit nvidia-docker2
    sudo systemctl restart docker
    

    Then edit the file daemon.json:

    $ vim /etc/docker/daemon.json
    {
        "runtimes": {
            "nvidia": {
                "path": "nvidia-container-runtime",
                "runtimeArgs": []
            }
        }
    }
    

    Restart docker again:

    sudo systemctl daemon-reload
    sudo systemctl restart docker
    

    Then you can pull and run the latest stable image using the below command:

    docker pull mindspore/mindspore-gpu:1.1.0
    docker run -it -v /dev/shm:/dev/shm --runtime=nvidia --privileged=true mindspore/mindspore-gpu:1.1.0 /bin/bash
    

    To test if the docker image works, please execute the python code below and check the output:

    import numpy as np
    import mindspore.context as context
    from mindspore import Tensor
    from mindspore.ops import functional as F
    
    context.set_context(mode=context.PYNATIVE_MODE, device_target="GPU")
    
    x = Tensor(np.ones([1,3,3,4]).astype(np.float32))
    y = Tensor(np.ones([1,3,3,4]).astype(np.float32))
    print(F.tensor_add(x, y))
    
    [[[ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.]],
    
    [[ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.]],
    
    [[ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.],
    [ 2.  2.  2.  2.]]]
    

If you want to learn more about the building process of MindSpore docker images, please check out docker repo for the details.

Quickstart

See the Quick Start to implement the image classification.

Docs

More details about installation guide, tutorials and APIs, please see the User Documentation.

Community

Governance

Check out how MindSpore Open Governance works.

Communication

Contributing

Welcome contributions. See our Contributor Wiki for more details.

Maintenance phases

Project stable branches will be in one of the following states:

State Time frame Summary
Planning 1 - 3 months Features are under planning.
Development 3 months Features are under development.
Maintained 6 - 12 months All bugfixes are appropriate. Releases produced.
Unmaintained 0 - 3 months All bugfixes are appropriate. No Maintainers and No Releases produced.
End Of Life (EOL) N/A Branch no longer accepting changes.

Maintenance status

Branch Status Initial Release Date Next Phase EOL Date
r1.9 Maintained 2022-10-26 Unmaintained
2023-10-26 estimated
r1.8 Maintained 2022-07-29 Unmaintained
2023-07-29 estimated
r1.7 Maintained 2022-04-29 Unmaintained
2023-04-29 estimated
r1.6 Maintained 2022-01-29 Unmaintained
2023-01-29 estimated
r1.5 End Of Life 2021-10-15 2022-10-15
r1.4 End Of Life 2021-08-15 2022-08-15
r1.3 End Of Life 2021-07-15 2022-07-15
r1.2 End Of Life 2021-04-15 2022-04-29
r1.1 End Of Life 2020-12-31 2021-09-30
r1.0 End Of Life 2020-09-24 2021-07-30
r0.7 End Of Life 2020-08-31 2021-02-28
r0.6 End Of Life 2020-07-31 2020-12-30
r0.5 End Of Life 2020-06-30 2021-06-30
r0.3 End Of Life 2020-05-31 2020-09-30
r0.2 End Of Life 2020-04-30 2020-08-31
r0.1 End Of Life 2020-03-28 2020-06-30

Release Notes

The release notes, see our RELEASE.

License

Apache License 2.0