ONNX Runtime Training RC3.1

Fixes issue discovered during validation.

Changes:

• #5350

ONNX Runtime Training RC3

See: https://github.com/microsoft/onnxruntime/releases/tag/v1.5.1

ONNX Runtime v1.5.1

Key Updates

General

• Reduced Operator Kernel build allows ORT binaries to be built with only required operators in the model(s) - learn more
• [Preview] ORT for Mobile Platforms - minimizes build size for mobile and embedded devices - learn more
• Transformer model inferencing performance optimizations
  • Perf improvement for DistilBERT
  • Benchmark tool supports more pretrained models
• Improvements in quantization tool
  • Support quantization-aware training models
  • Make calibration tool to support general preprocessing and calibrate on input
  • Simplify the quantization APIs
  • Support of model larger than 2G
• New operators for static quantization: QLinearMul, QLinearAdd, QlinearSigmoid and QLinearLeakyRelu
• Prepack constant matrix B for float GEMM (MatMul, Attention)
• Limited Python 3.8 support added in addition to 3.5-3.7 for official Python packages. Not yet supported for Windows GPU and Linux ARM builds.
• Telemetry enabled in Java and NodeJS packages for Windows builds. Note: data is not directly sent to Microsoft or ORT teams by ONNX Runtime; enabling telemetry means trace events are collected by the Windows operating system and may be sent to the cloud based on the user's privacy settings - learn more.

API

• Python API support for RegisterCustomOpsLibrary
• IO Binding API for C/C++/C# language bindings. This allows use of pre-allocated buffers on targeted devices and also target device for unknown output shapes.
• Sharing of allocators between multiple sessions. This allows much better utilization of memory by not creating a separate arena for each session in the same process. See this for details.

Windows ML

• NuGet package now supports UWP applications targeting Windows Store deployment (CPU only)
• NuGet package now supports .NET and .NET framework applications
• RUST Developers can now deploy Windows ML – sample and documentation available here
• New APIs to for additional performance control:
  • IntraopNumThreads: Provides an ability to change the number of threads used in the threadpool for Intra Operator Execution for CPU operators through LearningModelSessionOptions.
  • SetNamedDimensionOverrides: Provides the ability to override named input dimensions to concrete values through LearningModelSessionOptions in order to achieve better runtime performance.
• Support for additional ONNX format image type denotations – Gray8, normalized [0..1] and normalized [-1..1]
• Reduced Windows ML package size by separating debug symbols into separate distribution package.

Execution Providers

• CUDA updates
  • CUDA 10.2 / cuDNN 8.0 in official package
  • CUDA 11 support added and available to build from source
  • CUDA conv kernel support asymmetrical padding to fully support models such as YoloV3 for improved GPU perf
• TensorRT EP updates
  • Support for TensorRT 7.1
  • Added TensorRT engine caching feature, turned on by setting env variable ORT_TENSORRT_ENGINE_CACHE_ENABLE=1
  • TensorRT builds are now built with the Execution Provider as a separate dll. If enabled in the build, the provider will be available as a shared library. This was previously also enabled for the DNNL EP (ORT 1.3). Other Execution Providers will be added in the future.
• OpenVINO EP updates
  • Support for OpenVINO 2020.4
  • Added runtime options for VPU hardware to select specific hardware device and enable fast compilation of models.
  • Enable C# binding support for OpenVINO EP
• DirectML EP updates
  • API available for Python (build from source) and C# Microsoft.ML.OnnxRuntime.DirectML
  • 7 new operators for ONNX 1.7 (opset 12): Celu, GreaterOrEqual, LessOrEqual, ArgMin/Max with select_last_index, GatherND with batch_dim, RoiAlign
  • New data integer types were added to existing operators: Clip int, Max int, Min int, MaxPool int8, ReduceMin int8, ReduceMax int8, Pow int exponent
  • Higher dimension support 1D to 8D added to these operators: ElementWise*, Activation*, Reduce*, ArgMin/ArgMax, Gather*, Scatter*, OneHot
  • 64-bit support for indices on GPU's that support it: Gather, Scatter, OneHot, ArgMax/ArgMin, Cast.
• Android NNAPI EP updates:
  • Support for dynamic input shape
  • Int32/float32/uint8 data type
  • 50% more supported operators (36 total)
  • Support for Uint8 static quantization
  • Smaller binary size
  • Lower memory consumption
  • CPU fallback for Android level 26-
• MiGraphX EP updates
  • Added ONNX operators: GatherElements, NonZero, Equal, and Where
  • Support for Boolean data type
  • Improve support for existing operators:
    • Asymmetric padding of AveragePool
    • Multi-dimensional support for Convolution, Pooling, LRN, and Batchnormalization
    • Ceil mode support for AveragePool and MaxPool
    • More general approach to check whether constant folding is possible
  • Improved graph partitioning logic

Training (RC3 release)

• New and improved API to simplify integration with PyTorch trainer code - see instructions here
• Updated CUDA 11 / cuDNN 8.0 support to accelerate in NVIDIA A100

Dependency updates

MacOS binaries now rely on openmp to be installed. See this for reference.

Contributions

Contributors to ONNX Runtime include members across teams at Microsoft, along with our community members:

gwang-msft, snnn, skottmckay, hariharans29, thiagocrepaldi, tianleiwu, wangyems, RandySheriffH, yufenglee, SherlockNoMad, smk2007, jywu-msft, liqunfu, edgchen1, yuslepukhin, tiagoshibata, fdwr, ashbhandare, iK1D, wschin, BowenBao, zhanghuanrong, RyanUnderhill, ryanlai2, askhade, pranavsharma, martinb35, suffiank, ytaous, KeDengMS, rayankrish, natke, YUNQIUGUO, range4life, smkarlap, zhangxiang1993, xzhu1900, codemzs, weixingzhang, stevenlix, tracysh, mosdav, jingyanwangms, tlh20, souptc, orilevari, kit1980, yangchen-MS, faxu, fs-eire, wenbingl, chilo-ms, xkszltl, Andrews548, yuzawa-san, MaximKalininMS, jgbradley1, nickfeeney, zhijxu-MS, Tixxx, suryasidd, Craigacp, duli2012, jeffbloo

ORTTraining RC2

For ORTTraining RC2 release to include hotfix https://github.com/micr…

…osoft/onnxruntime/pull/4639.

It will be used to create docker image for orttraining examples.

ONNX Runtime v1.4.0

Key Updates

• Performance optimizations for Transformer models
  • GPT2 - Enable optimizations for Attention with Past State and Attention Mask
  • BERT - Improve EmbedLayerNormalization fusion coverage
• Quantization updates
  • Added new quantization operators: QLinearAdd, QAttention
  • Improved quantization performance for transformer based models on CPU
    • More graph fusion
    • Further optimization in MLAS kernel
    • Introduced pre-packing for constant Matrix B of DynamicQuantizeMatMul and Qattention
• New Python IOBinding APIs (bind_cpu_input, bind_output, copy_outputs_to_cpu) allow easier benchmarking
  • Users no longer need to allocate inputs and outputs on non-CPU devices using third-party allocators.
  • Users no longer need to copy inputs to non-CPU devices; ORT handles the copy.
  • Users can now use copy_outputs_to_cpu to copy outputs from non-CPU devices to CPU for verification.
• CUDA support for Einsum (opset12)
• ONNX Runtime Training updates
  • Opset 12 support
  • New sample for training experiment using Huggingface GPT-2.
    • Upgraded docker image built from the latest PyTorch release
• Telemetry is now enabled by default for Python packages and Github release zip files (C API); see more details on what/how telemetry is collected in ORT
• [Coming soon] Availability of Python package for ONNX Runtime 1.4 for Jetpack 4.4

Execution Providers

New Execution Providers available for preview:

• [Preview] AMD MIGraphX
• [Preview] ARM NN

Contributions

Contributors to ONNX Runtime include members across teams at Microsoft, along with our community members:

snnn, tianleiwu, edgchen1, hariharans29, skottmckay, tracysh, yufenglee, fs-eire, codemzs, tiagoshibata, yuslepukhin, gwang-msft, wschin, smk2007, prabhat00155, liuziyue, liqunfu, ytaous, iK1D, BowenBao, askhade, pranavsharma, faxu, jywu-msft, ryanlai2, xzhu1900, KeDengMS, tlh20, smkarlap, weixingzhang, jeffbloo, RyanUnderhill, mrry, jgbradley1, stevenlix, zhanghuanrong, suffiank, Andrews548, pengwa, SherlockNoMad, orilevari, duli2012, yangchen-MS, yan12125, jornt-xilinx, ashbhandare, neginraoof, Tixxx, thiagocrepaldi, Craigacp, mayeut, chilo-ms, prasanthpul, martinb35, manashgoswami, zhangxiang1993, suryasidd, wangyems, kit1980, RandySheriffH, fdwr

ONNX Runtime v1.3.1

This update includes changes to support the published packages for the Java and nodejs APIs for the 1.3.0 release.

• Maven: Java API CPU
• Maven: Java API GPU
• NPM: ONNX Runtime Node.js API

For all other APIs/builds, the 1.3.0 release packages are suggested. 1.3.1 does address the 1.3.0 issue of Crash when setting IntraOpNumThreads using the C/C++/C# API, so if this fix is needed it can be built from source using this release branch (with official release support).

ONNX Runtime v1.3.0

Key Updates

General

• ONNX 1.7 support
  • Opset 12
  • Function expansion support that enables several new ONNX 1.7 ops such as NegativeLogLikelihoodLoss, GreaterOrEqual, LessOrEqual, Celu to run without a kernel implementation.
• [Preview] ONNX Runtime Training
  • ONNX Runtime Training is a new capability released in preview to accelerate training transformer models. See the sample here to use this feature in your training experiments.
• Improved threadpool support for better resource utilization
  • Improved threadpool abstractions that switch between openmp and Eigen threadpools based on build settings. All operators have been updated to use these new abstractions.
  • Improved Eigen based threadpool now allow ops to provide cost (among other things like thread affinity) for operations
  • Simpler configuration of thread count. If built with OpenMP, use the OpenMP env variables; else use the ORT APIs to configure the number of threads.
  • Support for sessions to share global threadpool. See this for more information.
• Performance improvements
  • ~10% average measured latency improvements amongst key representative models (including ONNX model zoo models, MLPerf, and production models shipped in Microsoft products)
  • Further latency improvements for Transformer models on CPU and GPU - benchmark script
  • Improved batch inferencing latency for scikit-learn models for large batch sizes
    • Significant improvements in the implementations of the following ONNX operators: TreeEnsembleRegressor, TreeEnsembleClassifier, LinearRegressor, LinearClassifier, SVMRegressor, SVMClassifier, TopK
  • C# API optimizations - PR3171
• Telemetry enabled for Windows (more details on telemetry collection)
• Improved error reporting when a kernel cannot be found due to missing type implementation
• Minor fixes based on static code analysis

Dependency updates

Please note that this version of onnxruntime depends on Visual C++ 2019 runtime. Previous versions depended on Visual C++ 2017. Please also refer https://github.com/microsoft/onnxruntime/tree/rel-1.3.0#system-requirements for the full set of system requirements.

APIs and Packages

• [General Availability] Windows Machine Learning APIs - package published on Nuget - Microsoft.AI.MachineLearning
  • Performance improvements
  • Opset updates
• [General Availability] ONNX Runtime with DirectML package published on Nuget -Microsoft.ML.OnnxRuntime.DirectML
• [General Availability] Java API - Maven package coming soon.
• [Preview] Javascript (node.js) API now available to build from the master branch.
• ARM64 Linux CPU Python package now available on Pypi. Note: this requires building ONNX for ARM64.
• Nightly dev builds from master (Nuget feed, TestPypi-CPU, GPU)
• API Updates
  • I/O binding support for Python API - This reduces execution time significantly by allowing users to setup inputs/outputs on the GPU prior to model execution.
  • API to specify free dimensions based on both denotations and symbolic names.

Execution Providers

• OpenVINO v2.0 EP
• DirectML EP updates
  • Updated graph interface to abstract GPU-dependent graph optimization
  • ONNX opset 10 and 11 support
  • Initial support of 8bit and quantized operators
  • Performance optimizations
• [Preview] Rockchip NPU EP
• [Preview] Xilinx FPGA Vitis-AI EP
• Capability to build execution providers as DLLs - supported for DNNL EP, work in progress for other EPs.
  • If enabled in the build, the provider will be available as a shared library. Previously, EPs had to be statically linked with the core code.
  • No runtime cost to include the EP if it isn't loaded; can now dynamically decide when to load it based on the model

Contributions

We'd like to recognize our community members across various teams at Microsoft and other companies for all their valuable contributions. Our community contributors in this release include: Adam Pocock, pranavm-nvidia, Andrew Kane, Takeshi Watanabe, Jianhao Zhang, Colin Jermain, Andrews548, Jan Scholz, Pranav Prakash, suryasidd, and S. Manohar Karlapalem.

The ONNX Runtime Training code was originally developed internally at Microsoft, before being ported to Github. We’d like to recognize the original contributors: Aishwarya Bhandare, Ashwin Kumar, Cheng Tang, Du Li, Edward Chen, Ethan Tao, Fanny Nina Paravecino, Ganesan Ramalingam, Harshitha Parnandi Venkata, Jesse Benson, Jorgen Thelin, Ke Deng, Liqun Fu, Li-Wen Chang, Peng Wang, Sergii Dymchenko, Sherlock Huang, Stuart Schaefer, Tao Qin, Thiago Crepaldi, Tianju Xu, Weichun Wang, Wei Zuo, Wei-Sheng Chin, Weixing Zhang, Xiaowan Dong, Xueyun Zhu, Zeeshan Siddiqui, and Zixuan Jiang.

Known Issues

1. The source doesn't compile on Ubuntu 14.04. See #4048
2. Crash when setting IntraOpNumThreads using the C/C++/C# API. Fix is available in the master branch.
   Workaround: Setting IntraOpNumThreads is inconsequential when using ORT that is built with openmp enabled. Hence it's not required and can be safely commented out. Use the openmp env variables to set the threading params for openmp enabled builds (which is the recommended way).

ONNX Runtime v1.2.0

Key Updates

Execution Providers

• [Preview] Availability of Windows Machine Learning (WinML) APIs in Windows builds of ONNX Runtime, with DirectML for GPU acceleration
  • Windows ML is a WinRT API designed specifically for Windows developers that already ships as an inbox component in newer Windows versions
  • Compatible with Windows 8.1 for CPU and Windows 10 1709 for GPU
  • Available as source code in the GitHub and pre-built Nuget packages (windows.ai.machinelearning.dll)
  • For additional documentation and samples on getting started, visit the Windows ML API Reference documentation
• TensorRT Execution Provider upgraded to TRT 7
• CUDA updated to 10.1
  • Linux build requires CUDA Runtime 10.1.243, cublas10-10.2.1.243, and CUDNN 7.6.5.32. Note: cublas 10.1.x will not work
  • Windows build requires CUDA Runtime 10.1.243, CUDNN 7.6.5.32
  • onnxruntime now depends on curand lib, which is part of the CUDA SDK. If you already have the SDK fully installed, then it won't be an issue

Builds and Packages

• Nuget package structure updated. There is now a separate Managed Assembly (Microsoft.ML.OnnxRuntime.Managed) shared between the CPU and GPU Nuget packages. The "native" Nuget will depend on the "managed" Nuget to bring it into relevant projects automatically. PR 3104 Note that this should transparent for customers installing the Nuget packages. ORT package details are here.
• Build system: support getting dependencies from vcpkg (a C++ package manager for Windows, Linux, and MacOS)
• Capability to generate an onnxruntime Android Archive (AAR) file from source, which can be imported directly in Android Studio

API Updates

• SessionOptions:
  • default value of max_num_graph_transformation_steps increased to 10
  • default value of graph optimization level is changed to ORT_ENABLE_ALL(99)
• OrtEnv can be created/destroyed multiple times
• Java API
  • Gradle now required to build onnxruntime
  • Available on Android
• C API Additions:
  • GetDenotationFromTypeInfo
  • CastTypeInfoToMapTypeInfo
  • CastTypeInfoToSequenceTypeInfo
  • GetMapKeyType
  • GetMapValueType
  • GetSequenceElementType
  • ReleaseMapTypeInfo
  • ReleaseSequenceTypeInfo
  • SessionEndProfiling
  • SessionGetModelMetadata
  • ModelMetadataGetProducerName
  • ModelMetadataGetGraphName
  • ModelMetadataGetDomain
  • ModelMetadataGetDescription
  • ModelMetadataLookupCustomMetadataMap
  • ModelMetadataGetVersion
  • ReleaseModelMetadata

Operators

• This release introduces a change to the forward-compatibility pattern ONNX Runtime previously followed. This change was added to guarantee correctness of model prediction and removes behavior ambiguity due to missing opset information. This release adds a model opset number and IR version check - ONNX Runtime will not support models with ONNX versions higher than the supported opset implemented for that version (see version matrix). If higher opset versions are needed, consider using custom operators via ORT's custom schema/kernel registry mechanism.
• Int8 type support for Where Op
• Updates to Contrib ops:
  • Changes: ReorderInput in kMSNchwcDomain, SkipLayerNormalization
  • New: QLinearAdd, QLinearMul, QLinearReduceMean, MulInteger, QLinearAveragePool
• Added featurizer operators as an expansion of Contrib operators - these are not part of the official build and are experimental

Contributions

We'd like to recognize our community members across various teams at Microsoft and other companies for all their valuable contributions. Our community contributors in this release include: Eric Cousineau (Toyota Research Institute), Adam Pocock (Oracle), tinchi, Changyoung Koh, Andrews548, Jianhao Zhang, nicklas-mohr-jas, James Yuzawa, William Tambellini, Maher Jendoubi, Mina Asham, Saquib Nadeem Hashmi, Sanster, and Takeshi Watanabe.

ONNX Runtime v1.1.2

This is a minor patch release on 1.1.1.

This fixes the a minor issue that some logging in execution_frame.cc cannot be controlled by SessionLogVerbosityLevel in SessionOptions. PR #3043

ONNX Runtime v1.1.1

This is a minor patch release on 1.1.0.

Summary

• Updated default optimization level to apply all by default to support best performance for popular models
• Operator updates and other bugs

All fixes

• update default optimization level + fix gemm_activation fusion #2791
• Fix C# handling of unicode strings #2697
• Initialize max of softmax with lowest of float #2786
• Implement a more stable softmax #2715
• add uint8 support to where op #2792
• Fix memory leak in samples and test #2778
• Fix memory leak in TRT #2815
• Fix nightly build version number issue #2771