Skip to content

Commit 1eade2c

Browse files
docs(alert): update documentation for DJL usage in ModelTrackFindingGNN
1 parent e268719 commit 1eade2c

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

‎reconstruction/alert/src/main/java/org/jlab/rec/alert/AI/ModelTrackFindingGNN.java‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@
2222
* Exported forward signature (see SingleGraphEdgeScorer):
2323
* forward(x: float32[N, 10], edge_index: int64[2, E], edge_attr: float32[E, 9])
2424
* -> float32[E] (sigmoid edge scores in [0, 1])
25+
*
26+
* <p>DJL (Deep Java Library) is the inference engine used here. See its
27+
* documentation for the {@code Criteria} / {@code ZooModel} / {@code Predictor}
28+
* / {@code NDArray} APIs used below:
29+
* <ul>
30+
* <li><a href="https://docs.djl.ai/master/index.html">DJL docs (master)</a></li>
31+
* <li><a href="https://docs.djl.ai/master/docs/load_model.html">Loading a model</a>
32+
* (drives the {@link Criteria}/{@link ZooModel} block)</li>
33+
* <li><a href="https://docs.djl.ai/master/engines/pytorch/pytorch-engine/index.html">PyTorch engine</a>
34+
* (TorchScript inference)</li>
35+
* </ul>
2536
*/
2637
public class ModelTrackFindingGNN {
2738

0 commit comments

Comments
 (0)