saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-05-14 20:48:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update doc "How_To_Update_ONNX_Dev_Notes" (#1288)

Browse source 
* update documentation to match current code

* plus some wording changes
This commit is contained in:
Ashwini Khade 2019-06-24 12:59:30 -07:00 committed by GitHub
parent 92dc5c506d
commit 01715c0ff1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/How_To_Update_ONNX_Dev_Notes.md
View file

@ -2,7 +2,7 @@ This is a note only for ONNX Runtime developers.
It's very often, you need to update the ONNX submodule to a newer version in the upstream. Please follow the steps below, don't miss any!
1. Update the ONNX subfolder
1. Update the ONNX subfolder
```
cd cmake/external/onnx
git remote update
@ -12,23 +12,22 @@ git add onnx
```
(Change the <commit_id> to yours. If you are not sure, use 'origin/master'. Like 'git reset --hard origin/master')
2. Update [cgmanifest.json](/cgmanifest.json)
2. Update [cgmanifest.json](/cgmanifest.json)
Search 'https://github.com/onnx/onnx.git', update the commitHash with it.
3. Update [tools/ci_build/github/linux/docker/scripts/install_deps.sh](/tools/ci_build/github/linux/docker/scripts/install_deps.sh)
and [tools/ci_build/github/linux/docker/scripts/install_deps_x86.sh](/tools/ci_build/github/linux/docker/scripts/install_deps_x86.sh)
Search 'for onnx_version in', update the commit hashes. The list should contain every release version from ONNX 1.2, and the latest one in our cmake/external/onnx folder.
3. Update [tools/ci_build/github/linux/docker/scripts/install_onnx.sh](/tools/ci_build/github/linux/docker/scripts/install_onnx.sh)
Search 'for version2tag', update the commit hashes. The list should contain every release version from ONNX 1.2, and the latest one in our cmake/external/onnx folder.
4. Update onnxruntime/core/protobuf
If there is any change on `cmake/external/onnx/onnx/*.in.proto` since the last sync, please apply these changes to `onnxruntime/core/protobuf/*.in.proto`
4. If there is any change to `cmake/external/onnx/onnx/*.in.proto`, update onnxruntime/core/protobuf as follows :
```
- Apply these changes to onnxruntime/core/protobuf/*.in.proto
- Copy cmake/external/onnx/onnx/gen_proto.py to onnxruntime/core/protobuf and use this script to generate the new \*.proto and \*.proto3 files
- Regenerate csharp/test/Microsoft.ML.OnnxRuntime.Tests/OnnxMl.cs
```
Then copy cmake/external/onnx/onnx/gen_proto.py to onnxruntime/core/protobuf, use that script generating the new \*.proto and \*.proto3 files.
5. Send you PR, and run the CI builds.
Regenerate csharp/test/Microsoft.ML.OnnxRuntime.Tests/OnnxMl.cs
5. Send you PR, and run the CI builds.
6. If there is any unitest failure, caught by onnx_test_runner. Please also update
6. If there is any unitest failure, caught by onnx_test_runner. Please also update
- [onnxruntime/test/onnx/main.cc](/onnxruntime/test/onnx/main.cc)
- [onnxruntime/test/python/onnx_backend_test_series.py](/onnxruntime/test/python/onnx_backend_test_series.py)