Ejhg osx arm64 lib fix (#21)

* Increase libtorch version to 2.4.0 and use libtorch for osx-arm64

- libtorch requires libomp.dylib, but it is only included with libtorch 2.4.0 and above
- compiling osx-arm64 against libtorch-macos-arm64 instead of conda py3.10 libraries source significantly improves performance (~6X on M2 Macbook Air)

* Clean up references to unused conda LibTorchArchiveSource conditions

* Update SHA hashes for libtorch 2.4.0 on Windows and Linux

* Update distribution filenames

* Set BuildLibTorchPackages to true to build artifacts in CI

* Pin mac-x64 target against latest libtorch 2.2.2

* Specify TargetOS to fix failing CI build

* Revert "Specify TargetOS to fix failing CI build"

This reverts commit bf723f5.

* Specify TargetOS to fix failing CI build for mac-x64

---------

Co-authored-by: Eugenio De Hoyos <[email protected]>

Author: NiklasGustafsson

DEVGUIDE.md

@@ -52,7 +52,7 @@ Build with
 
 ## Packages
 
-An ephemeral feed of packages from Azure DevOps CI is available for those 
+An ephemeral feed of packages from Azure DevOps CI is available for those
 
 * View link: https://dotnet.visualstudio.com/TorchSharp/_packaging?_a=feed&feed=SignedPackages
 * Nuget feed: https://dotnet.pkgs.visualstudio.com/TorchSharp/_packaging/SignedPackages/nuget/v3/index.json
@@ -77,7 +77,7 @@ To change the TorchSharp package version update this [file](https://github.com/d
 The TorchSharp package is pushed to nuget.org via Azure DevOps CI release pipeline.  Assuming you're not building or updating the LibTorch packages
 (`BuildLibTorchPackages` is `false` in [azure-pipelines.yml](azure-pipelines.yml)) this is pretty simple once you have the permissions:
 
-1. Update the version number in [./build/BranchInfo.props](./build/BranchInfo.props) and in the [Release Notes](./RELEASENOTES.md) file and then submit a PR. 
+1. Update the version number in [./build/BranchInfo.props](./build/BranchInfo.props) and in the [Release Notes](./RELEASENOTES.md) file and then submit a PR.
 
    Updating the major or minor version number should only be done after a discussion with repo admins. The patch number should be incremented by one each release and set to zero after a change to the major or minor version.
 2. Integrate code to main and wait for CI to process
@@ -149,7 +149,7 @@ For this reason, we do the following
 This project grabs LibTorch and makes a C API wrapper for it, then calls these from C#. When updating to a newer
 version of PyTorch then quite a lot of careful work needs to be done.
 
-0. Make sure you have plenty of disk space, e.g. 15GB. 
+0. Make sure you have plenty of disk space, e.g. 15GB.
 
 1. Clean and reset to main
 
@@ -163,7 +163,7 @@ version of PyTorch then quite a lot of careful work needs to be done.
        https://download.pytorch.org/libtorch/cpu/libtorch-cxx11-abi-shared-with-deps-2.2.0%2Bcpu.zip
 
    Don't download anything yet, or manually. The downloads are acquired automatically in step 2.
-   
+
    To update the version, update this in [Dependencies.props](build/Dependencies.props):
 
        <LibTorchVersion>2.2.0</LibTorchVersion>
@@ -179,8 +179,9 @@ version of PyTorch then quite a lot of careful work needs to be done.
 On Windows:
 
         dotnet build src\Redist\libtorch-cpu\libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=linux /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
-        dotnet build src\Redist\libtorch-cpu\libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=mac /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
-        dotnet build src\Redist\libtorch-cpu\libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=windows /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true 
+        dotnet build src\Redist\libtorch-cpu\libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=mac /p:TargetArchitecture=x64 /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
+        dotnet build src\Redist\libtorch-cpu\libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=mac /p:TargetArchitecture=arm64 /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
+        dotnet build src\Redist\libtorch-cpu\libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=windows /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
         dotnet build src\Redist\libtorch-cpu\libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=windows /p:Configuration=Debug /t:Build /p:IncludeLibTorchCpuPackages=true
 
         dotnet build src\Redist\libtorch-cuda-12.1\libtorch-cuda-12.1.proj /p:UpdateSHA=true /p:TargetOS=linux /p:Configuration=Release /t:Build /p:IncludeLibTorchCudaPackages=true
@@ -190,8 +191,9 @@ On Windows:
 On Linux / Mac:
 
         dotnet build src/Redist/libtorch-cpu/libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=linux /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
-        dotnet build src/Redist/libtorch-cpu/libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=mac /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
-        dotnet build src/Redist/libtorch-cpu/libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=windows /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true 
+        dotnet build src/Redist/libtorch-cpu/libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=mac /p:TargetArchitecture=x64 /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
+        dotnet build src/Redist/libtorch-cpu/libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=mac /p:TargetArchitecture=arm64 /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
+        dotnet build src/Redist/libtorch-cpu/libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=windows /p:Configuration=Release /t:Build /p:IncludeLibTorchCpuPackages=true
         dotnet build src/Redist/libtorch-cpu/libtorch-cpu.proj /p:UpdateSHA=true /p:TargetOS=windows /p:Configuration=Debug /t:Build /p:IncludeLibTorchCpuPackages=true
 
         dotnet build src/Redist/libtorch-cuda-12.1/libtorch-cuda-12.1.proj /p:UpdateSHA=true /p:TargetOS=linux /p:Configuration=Release /t:Build /p:IncludeLibTorchCudaPackages=true
@@ -213,7 +215,7 @@ On Linux / Mac:
        dir bin\obj\x64.Release\libtorch-cpu\libtorch-cxx11-abi-shared-with-deps-2.2.0cpu\libtorch\lib\*.so*
 
    You may also need to precisely refactor the binaries into multiple parts so each package ends up under ~300MB. Before release 2.2.0 of libtorch, this really only affected the CUDA packagages, but it is now also affecting the CPU packages on Linux and OSX. Windows CPU is still small enough to be contained in just one package. The NuGet gallery does not allow packages larger than 250MB, so if files are 300MB, after compression, they are likely to be smaller than 250MB. However, you have to look out: if the compression is poor, then packages may end up larger. Note that it is 250 million
-   bytes that is the limit, **not** 250*1024*1024. In other words, it is 250 MB, not 250 MiB. Note that Windows Explorer will show file sizes in KiB, not thousands of bytes. Use 'dir' from a CMD window to get the exact size in bytes for each file. For example -- the file `libtorch_cpu.so` shows up as 511,872 KB in Windows Explorer, but 524,156,144 bytes in CMD. The 2.4% difference can be significant. Getting the partitioning right requires precision. 
+   bytes that is the limit, **not** 250*1024*1024. In other words, it is 250 MB, not 250 MiB. Note that Windows Explorer will show file sizes in KiB, not thousands of bytes. Use 'dir' from a CMD window to get the exact size in bytes for each file. For example -- the file `libtorch_cpu.so` shows up as 511,872 KB in Windows Explorer, but 524,156,144 bytes in CMD. The 2.4% difference can be significant. Getting the partitioning right requires precision.
 
    If the combined size of the files going into a part is smaller than 250MB, then everything is fine, and there is no need to split the part. It can be singular. If that is not the case, then the part should be fragmented into two or more parts that are linked together by their names.
 
@@ -229,12 +231,12 @@ On Linux / Mac:
    They must all be called either 'primary,' which should be the first fragment, or 'fragmentN' where 'N' is the ordinal number of the fragment, starting with '1'. The current logic allows for as many as 10 non-primary fragments. If more are needed, the code in [FileRestitcher.cs](pkg/FileRestitcher/FileRestitcher/FileRestitcher.cs) and [RestitchPackage.targets](pkg/common/RestitchPackage.targets) needs to be updated. Note that the size of each fragment is expressed in bytes, and that fragment start must be
    the sum of the size of all previous fragments. A '-1' should be used for the last fragment (and only for the last fragment): it means that the fragment size will be based on how much there is still left of the file.
 
-   Each part, whether singular or fragmented, should have its own .nupkgproj file in its own folder under pkg. The folder and file should have the same name as the part. If you need to add new fragments, it is straightforward to just copy an existing fragment folder and rename it as well as the project file to the new fragment. 
-   
+   Each part, whether singular or fragmented, should have its own .nupkgproj file in its own folder under pkg. The folder and file should have the same name as the part. If you need to add new fragments, it is straightforward to just copy an existing fragment folder and rename it as well as the project file to the new fragment.
+
    __Important:__
 
-   If you must fragment a previously singular part, it is best to rename the existing folder and file to '-fragment1' and then copy a '-primary' folder and rename with the right part name. This is because the primary .nupkgproj files look different from others. 
-   
+   If you must fragment a previously singular part, it is best to rename the existing folder and file to '-fragment1' and then copy a '-primary' folder and rename with the right part name. This is because the primary .nupkgproj files look different from others.
+
    Specifically, they include different build targets:
 
     ```xml
@@ -295,8 +297,8 @@ On Linux / Mac:
 
        <LibTorchPackageVersion>2.0.1.1</LibTorchPackageVersion>
 
-       dotnet pack -c Release -v:n /p:SkipNative=true /p:SkipTests=true /p:IncludeTorchSharpPackage=true /p:IncludeLibTorchCpuPackages=true /p:IncludeLibTorchCudaPackages=true 
-       dotnet pack -c Release -v:n /p:SkipNative=true /p:SkipTests=true /p:TargetOS=linux /p:IncludeTorchSharpPackage=true /p:IncludeLibTorchCpuPackages=true /p:IncludeLibTorchCudaPackages=true        
+       dotnet pack -c Release -v:n /p:SkipNative=true /p:SkipTests=true /p:IncludeTorchSharpPackage=true /p:IncludeLibTorchCpuPackages=true /p:IncludeLibTorchCudaPackages=true
+       dotnet pack -c Release -v:n /p:SkipNative=true /p:SkipTests=true /p:TargetOS=linux /p:IncludeTorchSharpPackage=true /p:IncludeLibTorchCpuPackages=true /p:IncludeLibTorchCudaPackages=true
 
     Once these finish, the output can be found in `bin\packages\Release`. Look at the file sizes -- if anything is larger than 250,000,000 bytes, you need to go back to #3 above and redefine the package contents and fragmentation scheme. It maybe necessary to introduce new fragments.
 

Directory.Build.props

@@ -20,7 +20,8 @@
     <SourceDir>$(RepoRoot)src/</SourceDir>
     <PkgDir>$(RepoRoot)pkg/</PkgDir>
 
-    <LibTorchPackageVersion>2.2.1.1</LibTorchPackageVersion>
+    <LibTorchPackageVersion>2.4.0.0</LibTorchPackageVersion>
+    <LibTorchPackageVersion Condition="'$(TargetOS)' == 'mac' and '$(TargetArchitecture)' == 'x64'">2.2.2.0</LibTorchPackageVersion>
 
     <!-- when building on local machines the massive downloads get placed up one directory -->
     <!-- so we can clean without triggering a re-download-->
@@ -86,7 +87,8 @@
   <!-- use stable versions for libtorch packages based on LibTorch version number scheme-->
   <!-- we manually update these -->
   <PropertyGroup Condition="'$(MSBuildProjectName.IndexOf(`libtorch-`))' != '-1'">
-    <LibTorchPackageVersion>2.2.1.1</LibTorchPackageVersion>
+    <LibTorchPackageVersion>2.4.0.0</LibTorchPackageVersion>
+    <LibTorchPackageVersion Condition="'$(TargetOS)' == 'mac' and '$(TargetArchitecture)' == 'x64'">2.2.2.0</LibTorchPackageVersion>
     <EnablePackageValidation>false</EnablePackageValidation>
     <VersionPrefix>$(LibTorchPackageVersion)</VersionPrefix>
     <VersionSuffix></VersionSuffix>
@@ -135,17 +137,14 @@
 
   <PropertyGroup>
     <LibTorchArchiveSource>pytorch</LibTorchArchiveSource>
-    <LibTorchArchiveSource Condition="'$(TargetPlatform)' == 'mac-arm64'">conda</LibTorchArchiveSource>
-    <CondaArchivePlatformName Condition="'$(TargetPlatform)' == 'mac-arm64'">osx-arm64</CondaArchivePlatformName>
     <LibTorchCpuArchiveNameSuffix Condition="'$(TargetOS)' != 'mac'">%252Bcpu</LibTorchCpuArchiveNameSuffix>
-    <LibTorchCpuArchiveNameSuffix Condition="'$(LibTorchArchiveSource)' == 'conda'">-py3.10_0</LibTorchCpuArchiveNameSuffix>
     <LibTorchCudaArchiveNameSuffix>%252Bcu$(CudaVersionNoDot)</LibTorchCudaArchiveNameSuffix>
     <LibTorchCpuLocalNameSuffix>cpu</LibTorchCpuLocalNameSuffix>
     <LibTorchCudaLocalNameSuffix>cu$(CudaVersionNoDot)</LibTorchCudaLocalNameSuffix>
     <LibTorchArchiveCoreName Condition="'$(TargetOS)' == 'windows'">libtorch-win-shared-with-deps$(LibTorchDebug)</LibTorchArchiveCoreName>
     <LibTorchArchiveCoreName Condition="'$(TargetOS)' == 'linux'">libtorch-cxx11-abi-shared-with-deps</LibTorchArchiveCoreName>
     <LibTorchArchiveCoreName Condition="'$(TargetOS)' == 'mac'">libtorch-macos-x86_64</LibTorchArchiveCoreName>
-    <LibTorchArchiveCoreName Condition="'$(LibTorchArchiveSource)' == 'conda'">pytorch</LibTorchArchiveCoreName>
+    <LibTorchArchiveCoreName Condition="'$(TargetPlatform)' == 'mac-arm64'">libtorch-macos-arm64</LibTorchArchiveCoreName>
     <LibTorchCpuArchiveBase>$(LibTorchArchiveCoreName)-$(LibTorchVersion)$(LibTorchCpuArchiveNameSuffix)</LibTorchCpuArchiveBase>
     <LibTorchCudaArchiveBase>$(LibTorchArchiveCoreName)-$(LibTorchVersion)$(LibTorchCudaArchiveNameSuffix)</LibTorchCudaArchiveBase>
     <LibTorchCpuLocalBase>$(LibTorchArchiveCoreName)-$(LibTorchVersion)$(LibTorchCpuLocalNameSuffix)</LibTorchCpuLocalBase>

azure-pipelines.yml

@@ -9,7 +9,7 @@ parameters:
   # push them to the artifacts feed of the Azure CI project
   - name: BuildLibTorchPackages
     type: boolean
-    default: false
+    default: true
   - name: PushPackagesToFeed
     type: boolean
     default: false
@@ -78,7 +78,7 @@ jobs:
   parameters:
     prepScript: echo "no prep needed"
     name: MacOS_x64
-    buildScript: dotnet build /p:SkipCuda=true /p:TargetArchitecture=x64 -c
+    buildScript: dotnet build /p:SkipCuda=true /p:TargetOS=mac /p:TargetArchitecture=x64 -c
     testScript: dotnet test --blame /p:SkipCuda=true --blame test/TorchSharpTest/TorchSharpTest.csproj -c
     pool:
       vmImage: 'macos-latest'

build/Dependencies.props

@@ -7,7 +7,8 @@
 
   <!-- Other/Non-Core Product Dependencies -->
   <PropertyGroup>
-    <LibTorchVersion>2.2.1</LibTorchVersion>
+    <LibTorchVersion>2.4.0</LibTorchVersion>
+    <LibTorchVersion Condition="'$(TargetArchitecture)' == 'x64' and '$(TargetOS)' == 'mac'">2.2.2</LibTorchVersion>
     <CudaVersionDot>12.1</CudaVersionDot>
     <CudaVersionNoDot>121</CudaVersionNoDot>
     <MklDnnVersion>2019.0.5.20190502</MklDnnVersion>

src/Redist/libtorch-cpu/libtorch-cpu.proj

@@ -29,7 +29,7 @@
     <MainPackageFolder>$(PackagePreparationPath)$(MSBuildProjectName)-$(TargetRuntimeID)</MainPackageFolder>
     <CopyToPackageSemaphore>$(MainPackageFolder)\.copied.SkipTests.$(SkipTests).IncludeLibTorchCpuPackages.$(IncludeLibTorchCpuPackages)</CopyToPackageSemaphore>
   </PropertyGroup>
-  
+
   <ItemGroup Condition="'$(TargetOS)' == 'windows'">
     <File Include="libtorch\lib\asmjit.dll" />
     <File Include="libtorch\lib\c10.dll" />
@@ -60,6 +60,8 @@
   <ItemGroup Condition="'$(NativeTargetArchitecture)' == 'arm64' and '$(TargetOS)' == 'mac'">
     <File Include="libtorch\lib\libc10.dylib" />
     <File Include="libtorch\lib\libshm.dylib" />
+    <!-- libomp.dylib is required for libtorch, but it is only bundled with libtorch 2.4.0 and above. -->
+    <File Include="libtorch\lib\libomp.dylib"/>
     <File Include="libtorch\lib\libtorch.dylib" />
     <File Include="libtorch\lib\libtorch_cpu.dylib" />
     <File Include="libtorch\lib\libtorch_global_deps.dylib" />

src/Redist/libtorch-cpu/libtorch-cxx11-abi-shared-with-deps-2.4.0%2Bcpu.zip.sha

@@ -0,0 +1 @@
+9D16CC0DA41E057F20C0BE5F26D7418F969E857631CFCB86550CCDECFEE8DE60

src/Redist/libtorch-cpu/libtorch-macos-arm64-2.4.0.zip.sha

@@ -0,0 +1 @@
+5B42BEDB9EE7BD42C7C72A0449A46985483A15F5A7C30FD42408A040F10EF104

src/Redist/libtorch-cpu/libtorch-macos-x86_64-2.2.2.zip.sha

@@ -0,0 +1 @@
+03A8066EE79BAEF6225BC3665FD3B0B7C4C11AC024086457974751BEBDFE43C1

src/Redist/libtorch-cpu/libtorch-win-shared-with-deps-2.4.0%2Bcpu.zip.sha

@@ -0,0 +1 @@
+D9C6290583680F9B850884AFE92978FA8C567FED079C8AB54F54B16E27CE04B5

src/Redist/libtorch-cpu/libtorch-win-shared-with-deps-debug-2.4.0%2Bcpu.zip.sha

@@ -0,0 +1 @@
+B01B5E57E772075DBC2034A0046D17F9A503EC5D0B4A6EE15A83DC42EE71C329