Merge pull request #3 from relaypro-open/macos

Macos

Author: mortont

config/config.exs

@@ -5,3 +5,14 @@ config :elixir, :dbg_callback, {Macro, :dbg, []}
 
 config :ortex,
   add_backend_on_inspect: config_env() != :test
+
+# Set the cargo feature flags required to use the matching execution provider
+# based on the OS we're running on
+ortex_features =
+  case :os.type() do
+    {:win32, _} -> ["directml"]
+    {:unix, :darwin} -> ["coreml"]
+    {:unix, _} -> ["cuda", "tensorrt"]
+  end
+
+config :ortex, Ortex.Native, features: ortex_features

lib/ortex/native.ex

@@ -4,13 +4,23 @@ defmodule Ortex.Native do
 
   Stubs for `Rustler` NIFs. These should never be called directly.
   """
+
+  # We have to compile the crate before `use Rustler` compiles the crate since
+  # cargo downloads the onnxruntime shared libraries and they are not available
+  # to load or copy into Elixir's during the on_load or Elixir compile steps.
+  # In the future, this may be configurable in Rustler.
+  Rustler.Compiler.compile_crate(__MODULE__, otp_app: :ortex, crate: :ortex)
+  Ortex.Util.copy_ort_libs()
+
   use Rustler,
     otp_app: :ortex,
     crate: :ortex
 
   # When loading a NIF module, dummy clauses for all NIF function are required.
   # NIF dummies usually just error out when called when the NIF is not loaded, as that should never normally happen.
-  def init(_model_path, _execution_providers, _optimization_level), do: :erlang.nif_error(:nif_not_loaded)
+  def init(_model_path, _execution_providers, _optimization_level),
+    do: :erlang.nif_error(:nif_not_loaded)
+
   def run(_model, _inputs), do: :erlang.nif_error(:nif_not_loaded)
   def from_binary(_bin, _shape, _type), do: :erlang.nif_error(:nif_not_loaded)
   def to_binary(_reference, _bits, _limit), do: :erlang.nif_error(:nif_not_loaded)

lib/ortex/util.ex

@@ -0,0 +1,55 @@
+defmodule Ortex.Util do
+  def copy_ort_libs() do
+    rust_env =
+      case Mix.env() do
+        :prod -> "release"
+        _ -> "debug"
+      end
+
+    case :os.type() do
+      {:win32, _} ->
+        Path.wildcard(
+          Path.join([
+            "./_build",
+            Mix.env() |> Atom.to_string(),
+            "lib/ortex/native/ortex",
+            rust_env,
+            "libonnxruntime*.dll*"
+          ])
+        )
+
+      {:unix, :darwin} ->
+        Path.wildcard(
+          Path.join([
+            "./_build/",
+            Mix.env() |> Atom.to_string(),
+            "lib/ortex/native/ortex",
+            rust_env,
+            "libonnxruntime*.dylib*"
+          ])
+        )
+
+      {:unix, _} ->
+        Path.wildcard(
+          Path.join([
+            "./_build/",
+            Mix.env() |> Atom.to_string(),
+            "lib/ortex/native/ortex",
+            rust_env,
+            "libonnxruntime*.so*"
+          ])
+        )
+    end
+    |> Enum.map(fn x ->
+      File.cp!(
+        x,
+        Path.join([
+          "./_build",
+          Mix.env() |> Atom.to_string(),
+          "lib/ortex/priv/native/",
+          Path.basename(x)
+        ])
+      )
+    end)
+  end
+end

mix.exs

@@ -17,7 +17,6 @@ defmodule Ortex.MixProject do
         main: "readme",
         extras: ["README.md"]
       ],
-
       package: package()
     ]
   end
@@ -34,7 +33,6 @@ defmodule Ortex.MixProject do
     [
       {:rustler, "~> 0.26.0"},
       {:nx, "~>0.5.3"},
-      # {:dialyxir, "~>1.3.0", only: [:dev], runtime: false},
       {:tokenizers, "~> 0.3.0", only: :dev},
       {:ex_doc, "0.29.4", only: :dev, runtime: false},
       {:axon_onnx, "~>0.4.0", only: :dev},
@@ -51,5 +49,5 @@ defmodule Ortex.MixProject do
       links: %{"GitHub" => "https://github.com/relaypro-open/ortex"},
       description: "ONNX Runtime bindings for Elixir"
     ]
-    end
+  end
 end

native/ortex/.cargo/config.toml

@@ -8,6 +8,7 @@ rpath=true
 rustflags = [
     "-C", "link-arg=-undefined",
     "-C", "link-arg=dynamic_lookup",
+    "-C", "link-args=-Wl,-rpath,@loader_path",
 ]
 [target.x86_64-unknown-linux-gnu]
 rustflags = [ "-Clink-args=-Wl,-rpath,$ORIGIN" ]

native/ortex/Cargo.lock

@@ -11,8 +11,19 @@ crate-type = ["cdylib"]
 
 [dependencies]
 rustler = "0.26.0"
-ort = {version = "1.14.6", features = ["cuda", "tensorrt"]}
+ort = {version = "1.14.6", default-features = false, features = ["half", "copy-dylibs"]}
 ndarray = "0.15.6"
 half = "2.2.1"
 tracing-subscriber = { version = "0.3", features = [ "env-filter", "fmt" ] }
 num-traits = "0.2.15"
+
+[features]
+default = ["download-binaries"]
+
+download-binaries = ["ort/download-binaries"]
+
+# ONNXRuntime Execution providers
+directml = ["ort/directml"]
+coreml = ["ort/coreml"]
+cuda = ["ort/cuda"]
+tensorrt = ["ort/tensorrt"]

native/ortex/Cargo.toml

@@ -17,11 +17,17 @@ use rustler::types::Binary;
 use rustler::{Atom, Env, NifResult, Term};
 
 #[rustler::nif(schedule = "DirtyIo")]
-fn init(env: Env, model_path: String, eps: Vec<Atom>, opt: i32) -> NifResult<ResourceArc<model::OrtexModel>> {
+fn init(
+    env: Env,
+    model_path: String,
+    eps: Vec<Atom>,
+    opt: i32,
+) -> NifResult<ResourceArc<model::OrtexModel>> {
     let eps = utils::map_eps(env, eps);
-    Ok(ResourceArc::new(model::init(model_path, eps, opt).map_err(
-        |e| rustler::Error::Term(Box::new(e.to_string())),
-    )?))
+    Ok(ResourceArc::new(
+        model::init(model_path, eps, opt)
+            .map_err(|e| rustler::Error::Term(Box::new(e.to_string())))?,
+    ))
 }
 
 #[rustler::nif]

native/ortex/src/lib.rs

@@ -17,7 +17,6 @@ use std::sync::Arc;
 use ort::{
     environment, execution_providers::ExecutionProvider, session::SessionBuilder,
     tensor::InputTensor, LoggingLevel, OrtError,
-    
 };
 use rustler::resource::ResourceArc;
 use rustler::Atom;
@@ -37,7 +36,11 @@ unsafe impl Sync for OrtexModel {}
 
 /// Creates a model given the path to the model and vector of execution providers.
 /// The execution providers are Atoms from Erlang/Elixir.
-pub fn init(model_path: String, eps: Vec<ExecutionProvider>, opt: i32) -> Result<OrtexModel, OrtError> {
+pub fn init(
+    model_path: String,
+    eps: Vec<ExecutionProvider>,
+    opt: i32,
+) -> Result<OrtexModel, OrtError> {
     // TODO: send tracing logs to erlang/elixir _somehow_
     // tracing_subscriber::fmt::init();
     let environment = environment::Environment::builder()

native/ortex/src/model.rs

@@ -16,47 +16,3 @@
     dynamic_axes={"input": {0: "batch_size"}, "output": {0: "batch_size"}},
     export_params=True,
 )
-
-"""
-onnx.load("./resnet50.onnx")
-...
-  input {
-    name: "input"
-    type {
-      tensor_type {
-        elem_type: 1
-        shape {
-          dim {
-            dim_value: -1
-          }
-          dim {
-            dim_value: 3
-          }
-          dim {
-            dim_value: 224
-          }
-          dim {
-            dim_value: 224
-          }
-        }
-      }
-    }
-  }
-  output {
-    name: "output"
-    type {
-      tensor_type {
-        elem_type: 1
-        shape {
-          dim {
-            dim_value: -1
-          }
-          dim {
-            dim_value: 1000
-          }
-        }
-      }
-    }
-  }
-}
-"""