Improve performance and remove resources from package by default

Author: pdil

CHANGELOG.md

@@ -1,3 +1,18 @@
+
+#### Improvements
+* Add background engine processing for better performance.
+* Remove neural network resource files for greatly reduced package size.
+  * These can be added manually by bundling the desired files and setting the appropriate engine to use them (see `Resources` directory).
+  * For `Stockfish 15.1` (`nn-1337b1adec5b.nnue`):
+    ``` swift
+    engine.send(command: .setoption(id: "EvalFile", value: evalFileURL))
+    engine.send(command: .setoption(id: "Use NNUE", value: "true"))
+    ```
+  * For `LeelaChessZero 0.29` (`192x15_network`):
+    ``` swift
+    engine.send(command: .setoption(id: "WeightsFile", value: weightsFileURL))
+    ```
+
 # ChessKitEngine 0.2.2
 Released Thursday, May 18, 2023.
 

Package.swift

@@ -18,11 +18,7 @@ let package = Package(
     targets: [
         .target(
             name: "ChessKitEngine",
-            dependencies: ["ChessKitEngineCore"],
-            resources: [
-                .copy("Resources/192x15_network"),
-                .copy("Resources/nn-1337b1adec5b.nnue")
-            ]
+            dependencies: ["ChessKitEngineCore"]
         ),
         .target(
             name: "ChessKitEngineCore",

…/ChessKitEngine/Resources/192x15_network Resources/192x15_networkSources/ChessKitEngine/Resources/192x15_network renamed to Resources/192x15_network Sources/ChessKitEngine/Resources/192x15_network renamed to Resources/192x15_network

@@ -27,7 +27,12 @@ public class Engine {
     ///
     /// Engine must be running for `send(command:)` to work.
     public private(set) var isRunning = false
-    
+
+    private let queue = DispatchQueue(
+        label: "ck-engine-queue",
+        qos: .userInteractive
+    )
+
     /// Initializes an engine with the provided `type`.
     ///
     /// - parameter type: The type of engine to use.
@@ -40,11 +45,13 @@ public class Engine {
         messenger.responseHandler = { [weak self] response in
             guard let self else { return }
 
-            if let parsedResponse = EngineResponse(rawValue: response) {
-                self.log(parsedResponse.rawValue)
-                self.receiveResponse(parsedResponse)
-            } else if !response.isEmpty {
-                self.log(response)
+            DispatchQueue.main.async {
+                if let parsedResponse = EngineResponse(rawValue: response) {
+                    self.log(parsedResponse.rawValue)
+                    self.receiveResponse(parsedResponse)
+                } else if !response.isEmpty {
+                    self.log(response)
+                }
             }
         }
     }
@@ -110,9 +117,11 @@ public class Engine {
             log("Engine is not running, call start() first.")
             return
         }
-        
-        log(command.rawValue)
-        messenger.sendCommand(command.rawValue)
+
+        queue.async {
+            self.log(command.rawValue)
+            self.messenger.sendCommand(command.rawValue)
+        }
     }
 
     /// Closure that is called when engine responses are received.

…KitEngine/Resources/nn-1337b1adec5b.nnue Resources/nn-1337b1adec5b.nnueSources/ChessKitEngine/Resources/nn-1337b1adec5b.nnue renamed to Resources/nn-1337b1adec5b.nnue Sources/ChessKitEngine/Resources/nn-1337b1adec5b.nnue renamed to Resources/nn-1337b1adec5b.nnue

@@ -39,26 +39,12 @@ public enum EngineType: Int {
     var setupCommands: [EngineCommand] {
         switch self {
         case .stockfish:
-            let evalFile = Bundle.module.url(forResource: "nn-1337b1adec5b", withExtension: "nnue")?
-                .absoluteString
-                .replacingOccurrences(of: "file://", with: "")
-            
-            return [
-                evalFile != nil ?
-                    .setoption(id: "EvalFile", value: evalFile!) : nil,
-                .setoption(id: "Use NNUE", value: "true"),
+            [
+                .setoption(id: "Use NNUE", value: "false"),
                 .setoption(id: "UCI_AnalyseMode", value: "true")
-            ].compactMap { $0 }
+            ]
         case .lc0:
-            let weights = Bundle.module.url(forResource: "192x15_network", withExtension: nil)?
-                .absoluteString
-                .replacingOccurrences(of: "file://", with: "")
-            
-            return [
-                .setoption(id: "Backend", value: "eigen"),
-                weights != nil ?
-                    .setoption(id: "WeightsFile", value: weights!) : nil
-            ].compactMap { $0 }
+            []
         }
     }