saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-12 17:57:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge two helpers involving the kernel def hashes into one file (#10609)

Browse source 
* Merge two helpers involving the kernel def hashes used by ORT format models. Add codeowners entry to ensure updates involving hashes are checked.
This commit is contained in:
Scott McKay 2022-02-23 20:46:09 +10:00 committed by GitHub
parent ea7f773a6e
commit e0d1d6906a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 101 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CODEOWNERS
View file

@ -12,6 +12,7 @@ samples/python/training/** @thiagocrepaldi @tlh20 @liqunfu @baijumeswani @Sherlo
# Mobile
/onnxruntime/test/testdata/kernel_def_hashes/ @skottmckay @gwang-msft @YUNQIUGUO @edgchen1
/onnxruntime/core/framework/kernel_def_hash_helpers.* @skottmckay @gwang-msft @YUNQIUGUO @edgchen1
# Contrib Ops
onnxruntime/core/graph/contrib_ops/nhwc_schema_defs.cc @zhanghuanrong @chenfucn @yufenglee @yihonglyu @snnn

71
onnxruntime/core/framework/kernel_def_hash_helpers.cc Normal file
View file

@ -0,0 +1,71 @@
#include "core/framework/kernel_def_hash_helpers.h"
namespace onnxruntime {
namespace utils {
std::optional<HashValue> GetHashValueFromStaticKernelHashMap(const std::string& op_type, int since_version) {
// Layout tranformer can add new nodes to the graph.
// Since layout transformation can happen in an extended build, if these nodes are not picked up and compiled by
// NNAPI or other compiling EPs then we need a way to get the hashes for these nodes. Since the infrastructure
// as well as op_schema required to generate these hashes is not available in an extended minimal build,
// we maintain a static map of nodes to hash value. This hash value can then be used to retireive the
// kernel for the given op.
static std::unordered_map<std::string, HashValue> static_kernel_hashes{
{"Transpose_1", 4324835766923221184ULL},
{"Transpose_13", 17267477159887372848ULL},
{"Squeeze_1", 12889825108950034784ULL},
{"Squeeze_11", 14725795030460042064ULL},
{"Squeeze_13", 16122603335179721968ULL},
{"UnSqueeze_1", 15964030255371555232ULL},
{"UnSqueeze_11", 16989589986691430224ULL},
{"UnSqueeze_13", 9466011545409597224ULL},
{"Gather_1", 625186873870077080ULL},
{"Gather_11", 11761559382112736008ULL},
{"Gather_13", 7462749543760614528ULL},
{"Identity_1", 18001636502361632792ULL},
{"Identity_13", 16879814636194901248ULL},
{"Identity_14", 16515685968327103576ULL},
{"Identity_16", 17661628575887109792ULL},
};
auto key = op_type + "_" + std::to_string(since_version);
auto iter = static_kernel_hashes.find(key);
if (iter != static_kernel_hashes.end()) {
return iter->second;
}
return std::nullopt;
}
void UpdateHashForBackwardsCompatibility(HashValue& hash) {
// map of old hash to new hash if we were forced to break backwards compatibility for a kernel registration
//
// If we need to update the hash for an existing registration, an entry needs to be added here to map the
// old hash to the new. This should rarely be required as historically the only need for it was fixing
// kernel registrations with invalid type constraints. Please carefully read through the information at the top of
// onnxruntime/test/providers/kernel_def_hash_test.cc regarding how/when hashes might change and the best way to
// address that.
static const std::unordered_map<HashValue, HashValue> hashes{
// old new domain, operator, opset[, type]
{2832535737534577496ULL, 16708009824840936392ULL}, // kOnnxDomain, Dropout, 7
{12198479371038564912ULL, 1718418059112844640ULL}, // kOnnxDomain, Scan, 9
{2560955351529676608ULL, 3668627007850399040ULL}, // kOnnxDomain, Scan, 11
{10232409728231027688ULL, 5212043150202938416ULL}, // kOnnxDomain, Not, 1
{11912523891622051440ULL, 10225383741733918632ULL}, // kOnnxDomain, RoiAlign, 10, float
{18084231515768318048ULL, 17022700455473327752ULL}, // kOnnxDomain, RoiAlign, 10, double
{14033689580222898712ULL, 634727773751317256ULL}, // kOnnxDomain, GatherND, 11
{646512416908411600ULL, 3064028185911332496ULL}, // kOnnxDomain, GatherND, 12
{15019893097608892000ULL, 11311962292460032936ULL}, // kOnnxDomain, GatherND, 13
{14259324427750852648ULL, 7767393334034626736ULL}, // kOnnxDomain, StringNormalizer, 10
// contrib ops
{7642430665819070720ULL, 8620498355864235632ULL}, // kMSDomain, CropAndResize, 1
{15019666093341768288ULL, 11924582339825775592ULL}}; // kMSDomain, GridSample, 1
auto iter = hashes.find(hash);
if (iter != hashes.cend()) {
// hash was updated in newer version of ORT kernel registrations
hash = iter->second;
}
}
} // namespace utils
} // namespace onnxruntime

19
onnxruntime/core/framework/static_kernel_def_hashes.h → onnxruntime/core/framework/kernel_def_hash_helpers.h
View file

@ -3,11 +3,13 @@
#pragma once
#include <unordered_map>
#include <string>
#include "core/common/common.h"
#include "core/graph/basic_types.h"
#include <optional>
#include "core/common/basic_types.h"
namespace onnxruntime {
#include <string>
namespace onnxruntime::utils {
/**
* @brief Gets the hash value for provided op type + version combination if it is available, otherwise
* returns a nullopt. The hash value is available if this node was added by layout transformer. For all other
@ -16,4 +18,11 @@ namespace onnxruntime {
* @return std::optional<HashValue>
*/
std::optional<HashValue> GetHashValueFromStaticKernelHashMap(const std::string& op_type, int since_version);
} // namespace onnxruntime
/**
* Get replacement hash for backwards compatibility if we had to modify an existing kernel registration.
* @param hash Hash to update if needed.
*/
void UpdateHashForBackwardsCompatibility(HashValue& hash);
} // namespace onnxruntime::utils

6
onnxruntime/core/framework/session_state.cc
View file

@ -10,13 +10,13 @@
#include "core/common/safeint.h"
#include "core/flatbuffers/schema/ort.fbs.h"
#include "core/framework/allocator.h"
#include "core/framework/kernel_def_hash_helpers.h"
#include "core/framework/node_index_info.h"
#include "core/framework/op_kernel.h"
#include "core/framework/ort_value_pattern_planner.h"
#include "core/framework/session_state_flatbuffers_utils.h"
#include "core/framework/session_state_utils.h"
#include "core/framework/utils.h"
#include "core/framework/static_kernel_def_hashes.h"
#include "core/providers/cpu/controlflow/utils.h"
#include "core/session/onnxruntime_session_options_config_keys.h"
@ -971,7 +971,7 @@ Status SessionState::LoadFromOrtFormat(const fbs::SessionState& fbs_session_stat
auto add_kernel_by_hash =
[&kernel_registry_manager, this](const Node& node, HashValue hash) {
const KernelCreateInfo* kci = nullptr;
fbs::utils::UpdateHashForBackwardsCompatibility(hash);
utils::UpdateHashForBackwardsCompatibility(hash);
ORT_RETURN_IF_NOT(kernel_registry_manager.SearchKernelRegistriesByHash(hash, &kci),
"Failed to find kernel def hash (", hash, ") in kernel registries for ",
@ -1024,7 +1024,7 @@ Status SessionState::LoadFromOrtFormat(const fbs::SessionState& fbs_session_stat
for (const auto& node : graph_.Nodes()) {
if (kernel_create_info_map_.count(node.Index()) == 0) {
if (node.Domain() == kOnnxDomain || node.Domain() == kOnnxDomainAlias) {
auto kernel_hash = GetHashValueFromStaticKernelHashMap(node.OpType(), node.SinceVersion());
auto kernel_hash = utils::GetHashValueFromStaticKernelHashMap(node.OpType(), node.SinceVersion());
if (kernel_hash.has_value()) {
ORT_RETURN_IF_ERROR(add_kernel_by_hash(node, *kernel_hash));
} else {

36
onnxruntime/core/framework/session_state_flatbuffers_utils.cc
View file

@ -3,6 +3,8 @@
#include "core/framework/session_state_flatbuffers_utils.h"
#include "core/framework/kernel_def_hash_helpers.h"
namespace onnxruntime::fbs::utils {
std::string GetSubgraphId(const NodeIndex node_idx, const std::string& attr_name) {
@ -48,7 +50,7 @@ FbsSessionStateViewer::NodeKernelInfo FbsSessionStateViewer::GetNodeKernelInfo(I
const auto* const fbs_kernel_def_hashes = fbs_kcis->kernel_def_hashes();
HashValue hash = fbs_kernel_def_hashes->Get(idx);
UpdateHashForBackwardsCompatibility(hash);
onnxruntime::utils::UpdateHashForBackwardsCompatibility(hash);
return {fbs_node_indices->Get(idx), hash};
}
@ -76,36 +78,4 @@ Status FbsSessionStateViewer::GetSubgraphSessionState(NodeIndex node_idx, const
fbs_subgraph_session_state_out = fbs_subgraph_session_state;
return Status::OK();
}
void UpdateHashForBackwardsCompatibility(HashValue& hash) {
// map of old hash to new hash if we were forced to break backwards compatibility for a kernel registration
//
// If we need to update the hash for an existing registration, an entry needs to be added here to map the
// old hash to the new. This should rarely be required as historically the only need for it was fixing
// kernel registrations with invalid type constraints. Please carefully read through the information at the top of
// onnxruntime/test/providers/kernel_def_hash_test.cc regarding how/when hashes might change and the best way to
// address that.
static const std::unordered_map<HashValue, HashValue> hashes{
// old new domain, operator, opset[, type]
{2832535737534577496ULL, 16708009824840936392ULL}, // kOnnxDomain, Dropout, 7
{12198479371038564912ULL, 1718418059112844640ULL}, // kOnnxDomain, Scan, 9
{2560955351529676608ULL, 3668627007850399040ULL}, // kOnnxDomain, Scan, 11
{10232409728231027688ULL, 5212043150202938416ULL}, // kOnnxDomain, Not, 1
{11912523891622051440ULL, 10225383741733918632ULL}, // kOnnxDomain, RoiAlign, 10, float
{18084231515768318048ULL, 17022700455473327752ULL}, // kOnnxDomain, RoiAlign, 10, double
{14033689580222898712ULL, 634727773751317256ULL}, // kOnnxDomain, GatherND, 11
{646512416908411600ULL, 3064028185911332496ULL}, // kOnnxDomain, GatherND, 12
{15019893097608892000ULL, 11311962292460032936ULL}, // kOnnxDomain, GatherND, 13
{14259324427750852648ULL, 7767393334034626736ULL}, // kOnnxDomain, StringNormalizer, 10
// contrib ops
{7642430665819070720ULL, 8620498355864235632ULL}, // kMSDomain, CropAndResize, 1
{15019666093341768288ULL, 11924582339825775592ULL}}; // kMSDomain, GridSample, 1
auto iter = hashes.find(hash);
if (iter != hashes.cend()) {
// hash was updated in newer version of ORT kernel registrations
hash = iter->second;
}
}
} // namespace onnxruntime::fbs::utils

7
onnxruntime/core/framework/session_state_flatbuffers_utils.h
View file

@ -77,11 +77,4 @@ class FbsSessionStateViewer {
private:
const fbs::SessionState& fbs_session_state_;
};
/**
* Get replacement hash for backwards compatibility if we had to modify an existing kernel registration.
* @param hash Hash to update if needed.
*/
void UpdateHashForBackwardsCompatibility(HashValue& hash);
} // namespace onnxruntime::fbs::utils

37
onnxruntime/core/framework/static_kernel_def_hashes.cc
View file

@ -1,37 +0,0 @@
#include "core/framework/static_kernel_def_hashes.h"
namespace onnxruntime {
std::optional<HashValue> GetHashValueFromStaticKernelHashMap(const std::string& op_type, int since_version) {
// Layout tranformer can add new nodes to the graph.
// Since layout transformation can happen in an extended build, if these nodes are not picked up and compiled by
// NNAPI or other compiling EPs then we need a way to get the hashes for these nodes. Since the infrastructure
// as well as op_schema required to generate these hashes is not available in an extended minimal build,
// we maintain a static map of nodes to hash value. This hash value can then be used to retireive the
// kernel for the given op.
static std::unordered_map<std::string, HashValue> static_kernel_hashes{
{"Transpose_1", 4324835766923221184ULL},
{"Transpose_13", 17267477159887372848ULL},
{"Squeeze_1", 12889825108950034784ULL},
{"Squeeze_11", 14725795030460042064ULL},
{"Squeeze_13", 16122603335179721968ULL},
{"UnSqueeze_1", 15964030255371555232ULL},
{"UnSqueeze_11", 16989589986691430224ULL},
{"UnSqueeze_13", 9466011545409597224ULL},
{"Gather_1", 625186873870077080ULL},
{"Gather_11", 11761559382112736008ULL},
{"Gather_13", 7462749543760614528ULL},
{"Identity_1", 18001636502361632792ULL},
{"Identity_13", 16879814636194901248ULL},
{"Identity_14", 16515685968327103576ULL},
{"Identity_16", 17661628575887109792ULL},
};
auto key = op_type + "_" + std::to_string(since_version);
auto iter = static_kernel_hashes.find(key);
if (iter != static_kernel_hashes.end()) {
return iter->second;
}
return std::nullopt;
}
}

4
onnxruntime/core/session/inference_session.cc
View file

@ -32,7 +32,7 @@
#include "core/framework/op_kernel_context_internal.h"
#include "core/framework/ort_value_pattern_planner.h"
#include "core/framework/utils.h"
#include "core/framework/static_kernel_def_hashes.h"
#include "core/framework/kernel_def_hash_helpers.h"
#include "core/graph/graph_viewer.h"
#include "core/graph/model.h"
#include "core/optimizer/graph_transformer_utils.h"
@ -1220,7 +1220,7 @@ Status AssignNodesToEpsFromHashesImpl(Graph& graph, const fbs::SessionState& fbs
// The following loop fetches the hash values for these nodes.
for (const auto& node : graph.Nodes()) {
if (node.GetExecutionProviderType().empty()) {
auto kernel_hash = GetHashValueFromStaticKernelHashMap(node.OpType(), node.SinceVersion());
auto kernel_hash = utils::GetHashValueFromStaticKernelHashMap(node.OpType(), node.SinceVersion());
if (kernel_hash.has_value()) {
ORT_RETURN_IF_ERROR(set_node_ep(node.Index(), kernel_hash.value()));
}

11
onnxruntime/test/providers/kernel_def_hash_test.cc
View file

@ -49,7 +49,7 @@
* In the unlikely event that we need to make a change to the kernel def
* hashing that breaks backward compatibility, the expected values may need to
* be updated. You will also need to update UpdateHashForBackwardsCompatibility
* in onnxruntime/core/framework/session_state_flatbuffers_utils.cc, add a
* in onnxruntime/core/framework/kernel_def_hash_helpers.cc, add a
* test model for the operator in question to onnxruntime/test/testdata/ort_backwards_compat
* and update OrtModelOnlyTests.TestBackwardsCompat in onnxruntime/test/framework/ort_model_only_test.cc
* to load the new model and validate the hash replacement works correctly.
@ -200,9 +200,12 @@ TEST(KernelDefHashTest, ExpectedCpuKernelDefHashes) {
// Adding this test here because resolution for this test failure requires fetching the hash
// for one of the ops in the list below and this file has information around that.
// Please update the following 3 places:
// 1. api_impl.cc "onnx_ops_available_versions" map, include the latest version in the map
// 2. static_kernel_def_hashes.cc "static_kernel_hashes" include an entry for latest version and it's associated hash
// 3. This file "onnx_ops_available_versions" map, include the latest version in the map
// 1. optimizer/transpose_optimizer/optimizer_api_impl.cc "onnx_ops_available_versions" map,
// include the latest version in the map
// 2. framework/kernel_def_hash_helpers.cc:GetHashValueFromStaticKernelHashMap "static_kernel_hashes" map,
// add an entry for latest version and its associated hash
// 3. KernelDefHashTest.TestNewOpsVersionSupportDuringLayoutTransform "onnx_ops_available_versions" map,
// include the latest version in the map
TEST(KernelDefHashTest, TestNewOpsVersionSupportDuringLayoutTransform) {
static const std::unordered_map<std::string, std::vector<int>> onnx_ops_available_versions = {
{"Squeeze", {1, 11, 13}},