Skip to content

Commit 5bc92df

Browse files
smk2007tiagoshibataSheil Kumarsnnn
authored
CP Fixes to enable C# UWP Apps to install the Microsoft.AI.MachineLearning Package (microsoft#7129)
* Fix app packaging in UWP (microsoft#6804) * Change msbuild condition for UAP * update .netcore target as well * create nuget packages with _native path * validate path under _native directory for windowsai package * pep8 * add diagnostic error message * pep8 * use baseame * lib\uap10.0 * uap10 * build\\uap10.0 * Manually binplace winmds into appx when PackageReference is used. * always binplace winmd regardless of packagereference since c# should work with packages.config also * resolve all paths to full paths to avoid some reference warnings * move winmds out of lib folder to prevent automatic component registration Co-authored-by: Sheil Kumar <[email protected]> * Only set _native folder for Microsoft.AI.MachineLearning package (microsoft#6939) * only set _native folder for Microsoft.AI.MachineLearning package Co-authored-by: Sheil Kumar <[email protected]> Co-authored-by: Tiago Koji Castro Shibata <[email protected]> Co-authored-by: Sheil Kumar <[email protected]> Co-authored-by: Changming Sun <[email protected]>
1 parent 6c61d2e commit 5bc92df

File tree

5 files changed

+65
-51
lines changed

5 files changed

+65
-51
lines changed

‎csharp/src/Microsoft.AI.MachineLearning.Interop/Microsoft.AI.MachineLearning.targets

+5-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@
99
</PropertyGroup>
1010

1111
<PropertyGroup>
12-
<RuntimesDirectory Condition="'$(OutputType)' == 'AppContainerExe'">$(MSBuildThisFileDirectory)..\..\runtimes\win-$(WindowsAI-Platform)\uap</RuntimesDirectory>
13-
<RuntimesDirectory Condition="'$(RuntimesDirectory)' == ''">$(MSBuildThisFileDirectory)..\..\runtimes\win-$(WindowsAI-Platform)\native</RuntimesDirectory>
14-
<WindowsAIBinary>$(RuntimesDirectory)\Microsoft.AI.MachineLearning.dll</WindowsAIBinary>
15-
<OnnxRuntimeBinary>$(RuntimesDirectory)\onnxruntime.dll</OnnxRuntimeBinary>
12+
<RuntimesDirectory Condition="'$(TargetPlatformIdentifier)' == 'UAP'">$(MSBuildThisFileDirectory)..\..\runtimes\win-$(WindowsAI-Platform)\lib\uap10.0</RuntimesDirectory>
13+
<RuntimesDirectory Condition="'$(TargetPlatformIdentifier)' != 'UAP'">$(MSBuildThisFileDirectory)..\..\runtimes\win-$(WindowsAI-Platform)\_native</RuntimesDirectory>
14+
<WindowsAIBinarySubfolder Condition="'$(UseWindowsMLStaticRuntime)' == 'true'">static\</WindowsAIBinarySubfolder>
15+
<WindowsAIBinary>$(RuntimesDirectory)\$(WindowsAIBinarySubfolder)Microsoft.AI.MachineLearning.dll</WindowsAIBinary>
16+
<OnnxRuntimeBinary>$(RuntimesDirectory)\$(WindowsAIBinarySubfolder)onnxruntime.dll</OnnxRuntimeBinary>
1617
</PropertyGroup>
1718

1819
<Target Name="CopyMLBinaries" BeforeTargets="CoreBuild">

‎csharp/src/Microsoft.AI.MachineLearning/Microsoft.AI.MachineLearning.targets

+12-6
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,32 @@
66
</PropertyGroup>
77

88
<PropertyGroup>
9-
<RuntimesDirectory Condition="'$(OutputType)' == 'AppContainerExe'">$(MSBuildThisFileDirectory)..\..\runtimes\win-$(WindowsAI-Platform)\uap</RuntimesDirectory>
10-
<RuntimesDirectory Condition="'$(RuntimesDirectory)' == ''">$(MSBuildThisFileDirectory)..\..\runtimes\win-$(WindowsAI-Platform)\native</RuntimesDirectory>
9+
<RuntimesDirectory Condition="'$(TargetPlatformIdentifier)' == 'UAP'">$(MSBuildThisFileDirectory)..\..\runtimes\win-$(WindowsAI-Platform)\lib\uap10.0</RuntimesDirectory>
10+
<RuntimesDirectory Condition="'$(TargetPlatformIdentifier)' != 'UAP'">$(MSBuildThisFileDirectory)..\..\runtimes\win-$(WindowsAI-Platform)\_native</RuntimesDirectory>
1111
<WindowsAIBinarySubfolder Condition="'$(UseWindowsMLStaticRuntime)' == 'true'">static\</WindowsAIBinarySubfolder>
12-
<WindowsAIBinary>$(RuntimesDirectory)\$(WindowsAIBinarySubfolder)Microsoft.AI.MachineLearning.dll</WindowsAIBinary>
12+
<WindowsAIBinary>$(RuntimesDirectory)\$(WindowsAIBinarySubfolder)microsoft.ai.machinelearning.dll</WindowsAIBinary>
13+
<WindowsAIWinMD>$(MSBuildThisFileDirectory)..\..\winmds\Microsoft.AI.MachineLearning.winmd</WindowsAIWinMD>
14+
<WindowsAIExperimentalWinMD>$(MSBuildThisFileDirectory)..\..\winmds\Microsoft.AI.MachineLearning.Experimental.winmd</WindowsAIExperimentalWinMD>
15+
16+
<WindowsAIBinary>$([System.IO.Path]::GetFullPath($(WindowsAIBinary)))</WindowsAIBinary>
17+
<WindowsAIWinMD>$([System.IO.Path]::GetFullPath($(WindowsAIWinMD)))</WindowsAIWinMD>
18+
<WindowsAIExperimentalWinMD>$([System.IO.Path]::GetFullPath($(WindowsAIExperimentalWinMD)))</WindowsAIExperimentalWinMD>
1319
</PropertyGroup>
1420

1521
<PropertyGroup Condition="'$(DisableOnnxRuntimeDllCopy)' != 'true'">
1622
<OnnxRuntimeBinary Condition="'$(OnnxRuntimeBinary)' == ''">$(RuntimesDirectory)\$(WindowsAIBinarySubfolder)onnxruntime.dll</OnnxRuntimeBinary>
1723
</PropertyGroup>
1824

1925
<ItemGroup>
20-
<Reference Include="$(MSBuildThisFileDirectory)\..\..\lib\uap\Microsoft.AI.MachineLearning.winmd">
26+
<Reference Include="$(WindowsAIWinMD)">
2127
<Implementation>$(WindowsAIBinary)</Implementation>
2228
</Reference>
23-
<Reference Include="$(MSBuildThisFileDirectory)\..\..\lib\uap\Microsoft.AI.MachineLearning.Experimental.winmd">
29+
<Reference Include="$(WindowsAIExperimentalWinMD)">
2430
<Implementation>$(WindowsAIBinary)</Implementation>
2531
</Reference>
2632
</ItemGroup>
2733

28-
<ItemGroup>
34+
<ItemGroup Condition="'$(NuGetProjectStyle)' != 'PackageReference'">
2935
<ReferenceCopyLocalPaths Include="$(WindowsAIBinary);$(OnnxRuntimeBinary)" />
3036
</ItemGroup>
3137
</Project>

‎tools/ci_build/github/azure-pipelines/nuget/templates/windowsai.yml

+30-30
Original file line numberDiff line numberDiff line change
@@ -322,30 +322,30 @@ jobs:
322322
$arm_static_runtime_nupkg_unzipped_directory = [System.IO.Path]::Combine($arm_static_runtime_nupkg_unzipped_directory_root, 'binaries', [System.IO.Path]::GetFileNameWithoutExtension($arm_static_runtime_nuget_package))
323323
[System.IO.Compression.ZipFile]::ExtractToDirectory($arm_static_runtime_nuget_package, $arm_static_runtime_nupkg_unzipped_directory)
324324
325-
$x64_store_runtime_path_old = [System.IO.Path]::Combine($x64_store_nupkg_unzipped_directory, 'runtimes', 'win-x64', 'uap')
326-
$x64_store_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x64', 'uap')
327-
$x64_static_runtime_path_old = [System.IO.Path]::Combine($x64_static_runtime_nupkg_unzipped_directory, 'runtimes', 'win-x64', 'native')
328-
$x64_static_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x64', 'native', 'static')
329-
$x86_runtime_path_old = [System.IO.Path]::Combine($x86_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'native')
330-
$x86_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'native')
331-
$x86_store_runtime_path_old = [System.IO.Path]::Combine($x86_store_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'uap')
332-
$x86_store_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'uap')
333-
$x86_static_runtime_path_old = [System.IO.Path]::Combine($x86_static_runtime_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'native')
334-
$x86_static_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'native', 'static')
335-
$arm64_runtime_path_old = [System.IO.Path]::Combine($arm64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'native')
336-
$arm64_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'native')
337-
$arm64_store_runtime_path_old = [System.IO.Path]::Combine($arm64_store_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'uap')
338-
$arm64_store_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'uap')
339-
$arm64_static_runtime_path_old = [System.IO.Path]::Combine($arm64_static_runtime_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'native')
340-
$arm64_static_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'native', 'static')
341-
$arm_runtime_path_old = [System.IO.Path]::Combine($arm_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'native')
342-
$arm_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'native')
343-
$arm_store_runtime_path_old = [System.IO.Path]::Combine($arm_store_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'uap')
344-
$arm_store_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'uap')
345-
$arm_static_runtime_path_old = [System.IO.Path]::Combine($arm_static_runtime_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'native')
346-
$arm_static_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'native', 'static')
347-
$uap_build_path_old = [System.IO.Path]::Combine($x64_store_nupkg_unzipped_directory, 'build', 'uap')
348-
$uap_build_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'build', 'uap')
325+
$x64_store_runtime_path_old = [System.IO.Path]::Combine($x64_store_nupkg_unzipped_directory, 'runtimes', 'win-x64', 'lib\\uap10.0')
326+
$x64_store_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x64', 'lib\\uap10.0')
327+
$x64_static_runtime_path_old = [System.IO.Path]::Combine($x64_static_runtime_nupkg_unzipped_directory, 'runtimes', 'win-x64', '_native')
328+
$x64_static_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x64', '_native', 'static')
329+
$x86_runtime_path_old = [System.IO.Path]::Combine($x86_nupkg_unzipped_directory, 'runtimes', 'win-x86', '_native')
330+
$x86_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x86', '_native')
331+
$x86_store_runtime_path_old = [System.IO.Path]::Combine($x86_store_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'lib\\uap10.0')
332+
$x86_store_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'lib\\uap10.0')
333+
$x86_static_runtime_path_old = [System.IO.Path]::Combine($x86_static_runtime_nupkg_unzipped_directory, 'runtimes', 'win-x86', '_native')
334+
$x86_static_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x86', '_native', 'static')
335+
$arm64_runtime_path_old = [System.IO.Path]::Combine($arm64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', '_native')
336+
$arm64_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', '_native')
337+
$arm64_store_runtime_path_old = [System.IO.Path]::Combine($arm64_store_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'lib\\uap10.0')
338+
$arm64_store_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'lib\\uap10.0')
339+
$arm64_static_runtime_path_old = [System.IO.Path]::Combine($arm64_static_runtime_nupkg_unzipped_directory, 'runtimes', 'win-arm64', '_native')
340+
$arm64_static_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', '_native', 'static')
341+
$arm_runtime_path_old = [System.IO.Path]::Combine($arm_nupkg_unzipped_directory, 'runtimes', 'win-arm', '_native')
342+
$arm_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm', '_native')
343+
$arm_store_runtime_path_old = [System.IO.Path]::Combine($arm_store_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'lib\\uap10.0')
344+
$arm_store_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'lib\\uap10.0')
345+
$arm_static_runtime_path_old = [System.IO.Path]::Combine($arm_static_runtime_nupkg_unzipped_directory, 'runtimes', 'win-arm', '_native')
346+
$arm_static_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm', '_native', 'static')
347+
$uap_build_path_old = [System.IO.Path]::Combine($x64_store_nupkg_unzipped_directory, 'build', 'uap10.0')
348+
$uap_build_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'build', 'uap10.0')
349349
350350
New-Item -Path $x64_store_runtime_path_new -ItemType Directory
351351
New-Item -Path $x64_static_runtime_path_new -ItemType Directory
@@ -469,12 +469,12 @@ jobs:
469469
$arm_nupkg_unzipped_directory = [System.IO.Path]::Combine($arm_nupkg_unzipped_directory_root, 'symbols', [System.IO.Path]::GetFileNameWithoutExtension($arm_nuget_package))
470470
[System.IO.Compression.ZipFile]::ExtractToDirectory($arm_nuget_package, $arm_nupkg_unzipped_directory)
471471
472-
$x86_runtime_path_old = [System.IO.Path]::Combine($x86_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'native')
473-
$x86_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x86', 'native')
474-
$arm64_runtime_path_old = [System.IO.Path]::Combine($arm64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'native')
475-
$arm64_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', 'native')
476-
$arm_runtime_path_old = [System.IO.Path]::Combine($arm_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'native')
477-
$arm_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm', 'native')
472+
$x86_runtime_path_old = [System.IO.Path]::Combine($x86_nupkg_unzipped_directory, 'runtimes', 'win-x86', '_native')
473+
$x86_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-x86', '_native')
474+
$arm64_runtime_path_old = [System.IO.Path]::Combine($arm64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', '_native')
475+
$arm64_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm64', '_native')
476+
$arm_runtime_path_old = [System.IO.Path]::Combine($arm_nupkg_unzipped_directory, 'runtimes', 'win-arm', '_native')
477+
$arm_runtime_path_new = [System.IO.Path]::Combine($x64_nupkg_unzipped_directory, 'runtimes', 'win-arm', '_native')
478478
479479
New-Item -Path $x86_runtime_path_new -ItemType Directory
480480
New-Item -Path $arm64_runtime_path_new -ItemType Directory

‎tools/nuget/generate_nuspec_for_native_nuget.py

+12-7
Original file line numberDiff line numberDiff line change
@@ -216,9 +216,14 @@ def generate_files(list, args):
216216
copy_command = "cp"
217217
runtimes_target = '" target="runtimes\\linux-'
218218

219+
if is_windowsai_package:
220+
runtimes_native_folder = '_native'
221+
else:
222+
runtimes_native_folder = 'native'
223+
219224
runtimes = '{}{}\\{}"'.format(runtimes_target,
220225
args.target_architecture,
221-
'uap' if args.is_store_build else 'native')
226+
'lib\\uap10.0' if args.is_store_build else runtimes_native_folder)
222227

223228
# Process headers
224229
files_list.append('<file src=' + '"' + os.path.join(args.sources_path,
@@ -277,11 +282,11 @@ def generate_files(list, args):
277282
# Process microsoft.ai.machinelearning.winmd
278283
files_list.append('<file src=' + '"' + os.path.join(args.ort_build_path, args.build_config,
279284
'microsoft.ai.machinelearning.winmd') +
280-
'" target="lib\\uap\\Microsoft.AI.MachineLearning.winmd" />')
285+
'" target="winmds\\Microsoft.AI.MachineLearning.winmd" />')
281286
# Process microsoft.ai.machinelearning.experimental.winmd
282287
files_list.append('<file src=' + '"' + os.path.join(args.ort_build_path, args.build_config,
283288
'microsoft.ai.machinelearning.experimental.winmd') +
284-
'" target="lib\\uap\\Microsoft.AI.MachineLearning.Experimental.winmd" />')
289+
'" target="winmds\\Microsoft.AI.MachineLearning.Experimental.winmd" />')
285290
if args.target_architecture == 'x64' and not args.is_store_build:
286291
interop_dll_path = 'Microsoft.AI.MachineLearning.Interop\\net5.0-windows10.0.19041.0'
287292
interop_dll = interop_dll_path + '\\Microsoft.AI.MachineLearning.Interop.dll'
@@ -312,17 +317,17 @@ def generate_files(list, args):
312317
files_list.append('<file src=' + '"' +
313318
os.path.join(args.native_build_path, 'microsoft.ai.machinelearning.lib') +
314319
runtimes_target + args.target_architecture + '\\' +
315-
('uap' if args.is_store_build else 'native') +
320+
('lib\\uap10.0' if args.is_store_build else '_native') +
316321
'\\Microsoft.AI.MachineLearning.lib" />')
317322
files_list.append('<file src=' + '"' + os.path.join(args.native_build_path,
318323
'microsoft.ai.machinelearning.dll') +
319324
runtimes_target + args.target_architecture + '\\' +
320-
('uap' if args.is_store_build else 'native') +
325+
('lib\\uap10.0' if args.is_store_build else '_native') +
321326
'\\Microsoft.AI.MachineLearning.dll" />')
322327
files_list.append('<file src=' + '"' + os.path.join(args.native_build_path,
323328
'microsoft.ai.machinelearning.pdb') +
324329
runtimes_target + args.target_architecture + '\\' +
325-
('uap' if args.is_store_build else 'native') +
330+
('lib\\uap10.0' if args.is_store_build else '_native') +
326331
'\\Microsoft.AI.MachineLearning.pdb" />')
327332
# Process execution providers which are built as shared libs
328333
if args.execution_provider == "tensorrt":
@@ -398,7 +403,7 @@ def generate_files(list, args):
398403
windowsai_rules = 'Microsoft.AI.MachineLearning.Rules.Project.xml'
399404
windowsai_native_rules = os.path.join(args.sources_path, 'csharp', 'src', windowsai_src, windowsai_rules)
400405
windowsai_native_targets = os.path.join(args.sources_path, 'csharp', 'src', windowsai_src, windowsai_targets)
401-
build = 'build\\{}'.format('uap' if args.is_store_build else 'native')
406+
build = 'build\\{}'.format('uap10.0' if args.is_store_build else 'native')
402407
files_list.append('<file src=' + '"' + windowsai_native_props + '" target="' + build + '" />')
403408
# Process native targets
404409
files_list.append('<file src=' + '"' + windowsai_native_targets + '" target="' + build + '" />')

‎tools/nuget/validate_nuget.py

+6-4
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@ def is_windows():
3333
return sys.platform.startswith("win")
3434

3535

36-
def check_if_dlls_are_present(platforms_supported, zip_file):
36+
def check_if_dlls_are_present(is_windows_ai_package, platforms_supported, zip_file):
3737
platforms = platforms_supported.strip().split(",")
3838
for platform in platforms:
3939
if platform.startswith("win"):
40-
path = "runtimes/" + platform + "/native/onnxruntime.dll"
40+
native_folder = '_native' if is_windows_ai_package else 'native'
41+
path = "runtimes/" + platform + "/" + native_folder + "/onnxruntime.dll"
4142
print('Checking path: ' + path)
4243
if (path not in zip_file.namelist()):
4344
print("onnxruntime.dll not found for " + platform)
@@ -109,7 +110,7 @@ def main():
109110
raise Exception('Nuget validation is currently supported only on Windows')
110111

111112
# Make a copy of the Nuget package
112-
print('Making a copy of the Nuget and extracting its contents')
113+
print('Copying [' + full_nuget_path + '] -> [' + nupkg_copy_name + '], and extracting its contents')
113114
os.system("copy " + full_nuget_path + " " + nupkg_copy_name)
114115

115116
# Convert nupkg to zip
@@ -118,7 +119,8 @@ def main():
118119

119120
# Check if the relevant dlls are present in the Nuget/Zip
120121
print('Checking if the Nuget contains relevant dlls')
121-
check_if_dlls_are_present(args.platforms_supported, zip_file)
122+
is_windows_ai_package = os.path.basename(full_nuget_path).startswith('Microsoft.AI.MachineLearning')
123+
check_if_dlls_are_present(is_windows_ai_package, args.platforms_supported, zip_file)
122124

123125
# Check if the Nuget has been signed
124126
if (args.verify_nuget_signing != 'true' and args.verify_nuget_signing != 'false'):

0 commit comments

Comments
 (0)