Warning, /acts/Plugins/ExaTrkX/README.md is written in an unsupported language. File is not indexed.
0001 # Exa.TrkX Plugin
0002
0003 This plugin contains a track finding module based on Graph Neural Networks (GNNs) which is developed by the [Exa.TrkX](https://exatrkx.github.io/) team. More background information can be found in the [documentation](https://acts.readthedocs.io/en/latest/plugins/exatrkx.html).
0004
0005 ## Building
0006
0007 To build the plugin, enable the appropriate CMake options:
0008
0009 ```bash
0010 cmake -B <build> -S <source> \
0011 -D ACTS_BUILD_PLUGIN_EXATRKX=ON \
0012 -D ACTS_EXATRKX_ENABLE_TORCH=ON/OFF \
0013 -D ACTS_EXATRKX_ENABLE_ONNX=ON/OFF \
0014 -D ACTS_BUILD_EXAMPLES_EXATRKX=ON \
0015 -D ACTS_BUILD_EXAMPLES_PYTHON_BINDINGS=ON \
0016 -D CMAKE_PREFIX_PATH=<path-to-installed-dependencies-if-not-in-default-paths>
0017 ```
0018
0019 This plugin is known to build without errors with (as of September 2022)
0020
0021 - [GCC](https://gcc.gnu.org) versions 8 and 9
0022 - [CUDA](https://developer.nvidia.com/cuda-zone) v11.5.1
0023 - [libtorch](https://pytorch.org/) v1.10.2 for CUDA version 10.2 and cxx-11-abi ([download](https://download.pytorch.org/libtorch/cu102/libtorch-cxx11-abi-shared-with-deps-1.10.2%2Bcu102.zip))
0024
0025 *For the ONNX backend:*
0026 - [ONNX](https://github.com/microsoft/onnxruntime) v1.10.0 with CUDA support enabled
0027
0028 *For the Torch backend*
0029 - [TorchScatter](https://github.com/rusty1s/pytorch_scatter) v2.0.9
0030
0031 There were experienced problems with recent GCC 11 versions and CUDA 11.6. A docker image with all dependencies can be found [here](https://github.com/acts-project/machines).
0032
0033 ## Running
0034
0035 The Examples of this plugin provide a python-script using the python-bindings to demonstrate the use of the track finding module. The script can be found here:
0036
0037 ```bash
0038 ./Examples/Scripts/Python/ExaTrkX.py # tries to run torch
0039 ./Examples/Scripts/Python/ExaTrkX.py onnx # tries to run onnx
0040 ./Examples/Scripts/Python/ExaTrkX.py torch # tries to run torch
0041 ```
0042
0043 In order that python can find the `acts.examples` module, set up your `PYTHONPATH` with `source <build>/python/setup.sh`.
0044
0045 ## Required files
0046
0047 The track finding module requires some ONNX-files or TorchScript-files that describe the used neural networks. These files are currently not provided within the ACTS repository.
