feat: MLSolver hashe test and compilation in the CI (acts-project#1959)

This MR adds the Ml Ambiguity solver to the CI. For now, only hashes tests are available, but once the performance evaluation for the solver has been refactored to use root, we should also add it to the test.

Author: Corentin-Allaire

.github/workflows/builds.yml

@@ -166,6 +166,7 @@ jobs:
           -DACTS_BUILD_EXAMPLES_EDM4HEP=ON
           -DACTS_FORCE_ASSERTIONS=ON
           -DACTS_BUILD_ANALYSIS_APPS=ON
+          -DACTS_BUILD_PLUGIN_ONNX=ON
 
       - name: Build
         run: cmake --build build

Examples/Algorithms/TrackFinding/include/ActsExamples/TrackFinding/AmbiguityResolutionMLAlgorithm.hpp

@@ -9,7 +9,7 @@
 #pragma once
 
 #include "Acts/Plugins/Onnx/OnnxRuntimeBase.hpp"
-#include "ActsExamples/Framework/BareAlgorithm.hpp"
+#include "ActsExamples/Framework/IAlgorithm.hpp"
 
 #include <string>
 #include <vector>
@@ -22,7 +22,7 @@ namespace ActsExamples {
 ///  1) Cluster together nearby tracks using shared hits
 ///  2) For each track use a neural network to compute a score
 ///  3) In each cluster keep the track with the highest score
-class AmbiguityResolutionMLAlgorithm final : public BareAlgorithm {
+class AmbiguityResolutionMLAlgorithm final : public IAlgorithm {
  public:
   struct Config {
     /// Input trajectories collection.

Examples/Algorithms/TrackFinding/src/AmbiguityResolutionMLAlgorithm.cpp

@@ -28,7 +28,7 @@
 ActsExamples::AmbiguityResolutionMLAlgorithm::AmbiguityResolutionMLAlgorithm(
     ActsExamples::AmbiguityResolutionMLAlgorithm::Config cfg,
     Acts::Logging::Level lvl)
-    : ActsExamples::BareAlgorithm("AmbiguityResolutionMLAlgorithm", lvl),
+    : ActsExamples::IAlgorithm("AmbiguityResolutionMLAlgorithm", lvl),
       m_cfg(std::move(cfg)),
       m_env(ORT_LOGGING_LEVEL_WARNING, "MLClassifier"),
       m_duplicateClassifier(m_env, m_cfg.inputDuplicateNN.c_str()) {
@@ -71,7 +71,8 @@ std::unordered_map<int, std::vector<int>> clusterTracks(
     }
     // None of the hits have been matched to a track create a new cluster
     if (matchedTrack == hitToTrack.end()) {
-      cluster.emplace(track->second.first, {track->second.first});
+      cluster.emplace(track->second.first,
+                      std::vector<int>(1, track->second.first));
       for (const auto& hit : hits) {
         // Add the hits of the new cluster to the hitToTrack
         hitToTrack.emplace(hit, track->second.first);

Examples/Python/tests/root_file_hashes.txt

@@ -85,3 +85,4 @@ test_root_clusters_writer[configKwConstructor]__clusters.root: 97f04fdd2c0eef4d3
 test_root_clusters_writer[kwargsConstructor]__clusters.root: 97f04fdd2c0eef4d37dc8732dd25ab49a90bb51925b2638d94826becf5059fae
 test_exatrkx[onnx]__performance_track_finding.root: 89bf19c4e0414c78982e0b36c4125cd1d25335bca821941665d325152c05aeb1
 test_exatrkx[torch]__performance_track_finding.root: a06ff95c0baa4e07834d9c388af5f7da00f3c84ad9cf88aaf76385d50bf68195
+test_ML_Ambiguity_Solver__performance_ambiML.root: 080e183e758b8593a9c233e2d1b4d213f28fdcb18d82acefdac7c9a5a5763bfc

Examples/Python/tests/test_examples.py

@@ -324,7 +324,6 @@ def test_seeding_orthogonal(tmp_path, trk_geo, field, assert_root_hash):
 
 
 def test_itk_seeding(tmp_path, trk_geo, field, assert_root_hash):
-
     field = acts.ConstantBField(acts.Vector3(0, 0, 2 * acts.UnitConstants.T))
 
     csv = tmp_path / "csv"
@@ -480,7 +479,6 @@ def test_propagation(tmp_path, trk_geo, field, seq, assert_root_hash):
 @pytest.mark.skipif(not geant4Enabled, reason="Geant4 not set up")
 @pytest.mark.skipif(not dd4hepEnabled, reason="DD4hep not set up")
 def test_material_recording(tmp_path, material_recording, assert_root_hash):
-
     root_files = [
         (
             "geant4_material_tracks.root",
@@ -503,7 +501,6 @@ def test_material_recording(tmp_path, material_recording, assert_root_hash):
 @pytest.mark.skipif(not dd4hepEnabled, reason="DD4hep not set up")
 @pytest.mark.skipif(not geant4Enabled, reason="Geant4 not set up")
 def test_event_recording(tmp_path):
-
     script = (
         Path(__file__).parent.parent.parent.parent
         / "Examples"
@@ -1117,7 +1114,6 @@ def test_vertex_fitting(tmp_path):
 def test_vertex_fitting_reading(
     tmp_path, ptcl_gun, rng, finder, inputTracks, entries, assert_root_hash
 ):
-
     ptcl_file = tmp_path / "particles.root"
 
     detector, trackingGeometry, decorators = GenericDetector.create()
@@ -1240,6 +1236,40 @@ def test_full_chain_odd_example_pythia_geant4(tmp_path):
     )
 
 
+@pytest.mark.skipif(not dd4hepEnabled, reason="DD4hep not set up")
+@pytest.mark.slow
+def test_ML_Ambiguity_Solver(tmp_path, assert_root_hash):
+    root_file = "performance_ambiML.root"
+    output_dir = "odd_output"
+    assert not (tmp_path / root_file).exists()
+    # This test literally only ensures that the full chain example can run without erroring out
+    getOpenDataDetector(
+        getOpenDataDetectorDirectory()
+    )  # just to make sure it can build
+
+    script = (
+        Path(__file__).parent.parent.parent.parent
+        / "Examples"
+        / "Scripts"
+        / "Python"
+        / "full_chain_odd.py"
+    )
+    assert script.exists()
+    env = os.environ.copy()
+    env["ACTS_LOG_FAILURE_THRESHOLD"] = "WARNING"
+    subprocess.check_call(
+        [sys.executable, str(script), "-n5", "--MLSolver"],
+        cwd=tmp_path,
+        env=env,
+        stderr=subprocess.STDOUT,
+    )
+
+    rfp = tmp_path / output_dir / root_file
+    assert rfp.exists()
+
+    assert_root_hash(root_file, rfp)
+
+
 def test_bfield_writing(tmp_path, seq, assert_root_hash):
     from bfield_writing import runBFieldWriting
 

cmake/ActsConfig.cmake.in

@@ -84,9 +84,6 @@ endif()
 
 
 # dependencies which cannot be searched in CONFIG mode
-if(PluginOnnx IN_LIST Acts_COMPONENTS)
-  find_package(OnnxRuntime REQUIRED)
-endif()
 if(PluginSycl IN_LIST Acts_COMPONENTS)
   find_package(SYCL REQUIRED)
 endif()

cmake/FindOnnxRuntime.cmake

@@ -19,7 +19,7 @@ endif()
 find_path(
   OnnxRuntime_INCLUDE_DIR
   NAMES core/session/onnxruntime_cxx_api.h #core/session/providers/cuda_provider_factory.h
-  PATHS ${onxxruntime_DIR}
+  PATHS ${onnxruntime_DIR}
   PATH_SUFFIXES include include/onnxruntime
   DOC "The ONNXRuntime include directory")