mlx

Author: KSemenenko

.github/workflows/ci.yml

@@ -14,11 +14,20 @@ jobs:
         with:
           submodules: recursive
 
+      - name: Install CMake
+        run: brew install cmake
+
+      - name: Build native stub library
+        run: |
+          cmake -S native -B native/build -DCMAKE_BUILD_TYPE=Release
+          cmake --build native/build --target mlxsharp --config Release
+          mkdir -p src/MLXSharp.Native/runtimes/osx-arm64/native
+          cp native/build/libmlxsharp.dylib src/MLXSharp.Native/runtimes/osx-arm64/native/
+
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 9.0.x
-          include-prerelease: true
 
       - name: Show .NET info
         run: dotnet --info
@@ -29,28 +38,38 @@ jobs:
       - name: Build
         run: dotnet build MLXSharp.sln --configuration Release --no-restore
 
+      - name: Copy native library to test output
+        run: |
+          TEST_OUTPUT="src/MLXSharp.Tests/bin/Release/net9.0"
+          mkdir -p "$TEST_OUTPUT/runtimes/osx-arm64/native"
+          cp src/MLXSharp.Native/runtimes/osx-arm64/native/libmlxsharp.dylib "$TEST_OUTPUT/runtimes/osx-arm64/native/"
+          ls -la "$TEST_OUTPUT/runtimes/osx-arm64/native/"
+
+      - name: Run tests
+        run: dotnet test MLXSharp.sln --configuration Release --no-build --logger "trx;LogFileName=TestResults.trx" --results-directory artifacts/test-results
+
       - name: Prepare artifact folders
         run: |
           mkdir -p artifacts/test-results
           mkdir -p artifacts/packages
           mkdir -p artifacts/native
-
-      - name: Install dependencies
-        run: brew install cmake
-
-      - name: Build native stub library
-        run: |
-          cmake -S native -B native/build -DCMAKE_BUILD_TYPE=Release
-          cmake --build native/build --target mlxsharp --config Release
-          cp native/build/libmlxsharp.dylib artifacts/native/
-          cp native/build/libmlxsharp.dylib src/MLXSharp.Native/runtimes/osx-arm64/native/
-
-      - name: Run tests
-        run: dotnet test MLXSharp.sln --configuration Release --no-build --logger "trx;LogFileName=TestResults.trx" --results-directory artifacts/test-results
+          cp src/MLXSharp.Native/runtimes/osx-arm64/native/libmlxsharp.dylib artifacts/native/
 
       - name: Pack library
         run: dotnet pack src/MLXSharp/MLXSharp.csproj --configuration Release --no-build --output artifacts/packages
 
+      - name: Verify package contains native libraries
+        run: |
+          echo "Checking package contents..."
+          if unzip -l artifacts/packages/*.nupkg | grep -q "runtimes/osx-arm64/native/libmlxsharp.dylib"; then
+            echo "✓ Native library found in package"
+          else
+            echo "✗ ERROR: Native library NOT found in package!"
+            echo "Package contents:"
+            unzip -l artifacts/packages/*.nupkg
+            exit 1
+          fi
+
       - name: Upload native artifact
         uses: actions/upload-artifact@v4
         with:

README.md

@@ -67,12 +67,24 @@ history.AddUserMessage("Summarise MLX in one sentence");
 var response = await chat.GetChatMessageContentsAsync(history, new PromptExecutionSettings(), kernel, CancellationToken.None);
 ```
 
-## Native Runtime Packaging
-
-- `src/MLXSharp.Native` mimics NuGet runtime assets with `runtimes/<rid>/native/libmlxsharp.*` folders.
-  The Linux x64 directory contains a stub library compiled from `native/src/mlxsharp.cpp` so tests can load it.
-- Drop the real macOS build (`libmlxsharp.dylib`) into `runtimes/osx-arm64/native/` before packing a release build.
-- At runtime `MlxNativeLibrary` probes the explicit `MlxClientOptions.LibraryPath`, the `MLXSHARP_LIBRARY` environment variable, and packaged runtime folders before falling back to system search paths.
+## NuGet Package
+
+**MLXSharp** NuGet package містить:
+- Managed DLL з `Microsoft.Extensions.AI` інтеграціями
+- Native бібліотеки в `runtimes/{rid}/native/`:
+  - `runtimes/linux-x64/native/libmlxsharp.so` - stub для CI/testing
+  - `runtimes/osx-arm64/native/libmlxsharp.dylib` - білдиться в CI на macOS
+
+GitHub Actions автоматично:
+1. Компілює native wrapper з MLX submodule
+2. Копіює `libmlxsharp.dylib` в `src/MLXSharp.Native/runtimes/osx-arm64/native/`
+3. Пакує managed + native разом в один NuGet пакет
+
+Під час виконання `MlxNativeLibrary` автоматично знаходить правильну бібліотеку:
+- Перевіряє `MlxClientOptions.LibraryPath`
+- Перевіряє `MLXSHARP_LIBRARY` environment variable
+- Шукає в `runtimes/{rid}/native/` (NuGet розпаковує автоматично)
+- Fallback на system library search paths
 
 To build the native wrapper locally (mirroring the LLamaSharp workflow):
 

src/MLXSharp.Native/MLXSharp.Native.csproj

@@ -13,6 +13,10 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <None Include="runtimes/**" Pack="true" PackagePath="runtimes/%(RecursiveDir)%(Filename)%(Extension)" CopyToOutputDirectory="PreserveNewest" />
+    <None Include="runtimes/**/*.*"
+          Pack="true"
+          PackagePath="runtimes/%(RecursiveDir)%(Filename)%(Extension)"
+          CopyToOutputDirectory="PreserveNewest"
+          Link="runtimes/%(RecursiveDir)%(Filename)%(Extension)" />
   </ItemGroup>
 </Project>

src/MLXSharp/MLXSharp.csproj

@@ -16,6 +16,18 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\MLXSharp.Native\MLXSharp.Native.csproj" ReferenceOutputAssembly="false" PrivateAssets="all" />
+    <ProjectReference Include="..\MLXSharp.Native\MLXSharp.Native.csproj"
+                      ReferenceOutputAssembly="false"
+                      PrivateAssets="all"
+                      IncludeAssets="none" />
+  </ItemGroup>
+
+  <!-- Include native binaries from MLXSharp.Native project into this package -->
+  <ItemGroup>
+    <None Include="..\MLXSharp.Native\runtimes\**\*.*"
+          Pack="true"
+          PackagePath="runtimes/%(RecursiveDir)%(Filename)%(Extension)"
+          CopyToOutputDirectory="PreserveNewest"
+          Link="runtimes\%(RecursiveDir)%(Filename)%(Extension)" />
   </ItemGroup>
 </Project>