-

graphnetGraphNeT is an open-source Python framework aimed at providing high quality, user friendly, end-to-end functionality to perform reconstruction tasks at neutrino telescopes using deep learning. graphnetGraphNeT makes it fast and easy to train complex models that can provide event reconstruction with state-of-the-art performance, for arbitrary detector configurations, with inference times that are orders of magnitude faster than traditional reconstruction techniques. -graphnetGraphNeT provides a common, detector agnostic framework for ML developers and physicists that wish to use the state-of-the-art tools in their research. By uniting both user groups, graphnetGraphNeT aims to increase the longevity and usability of individual code contributions from ML developers by building a general, reusable software package based on software engineering best practices, and lowers the technical threshold for physicists that wish to use the most performant tools for their scientific problems.

+

graphnetGraphNeT is an open-source Python framework aimed at providing high quality, user friendly, end-to-end functionality to perform reconstruction tasks at neutrino telescopes using deep learning. graphnetGraphNeT makes it fast and easy to train complex models that can provide event reconstruction with state-of-the-art performance, for arbitrary detector configurations, with inference times that are orders of magnitude faster than traditional reconstruction techniques. +graphnetGraphNeT provides a common, detector agnostic framework for ML developers and physicists that wish to use the state-of-the-art tools in their research. By uniting both user groups, graphnetGraphNeT aims to increase the longevity and usability of individual code contributions from ML developers by building a general, reusable software package based on software engineering best practices, and lowers the technical threshold for physicists that wish to use the most performant tools for their scientific problems.

Usage

-

graphnetGraphNeT comprises a number of modules providing the necessary tools to build workflows from ingesting raw training data in domain-specific formats to deploying trained models in domain-specific reconstruction chains, as illustrated in [the Figure](flowchart).

+

graphnetGraphNeT comprises a number of modules providing the necessary tools to build workflows from ingesting raw training data in domain-specific formats to deploying trained models in domain-specific reconstruction chains, as illustrated in [the Figure](flowchart).

../_images/flowchart.png
-

High-level overview of a typical workflow using graphnetGraphNeT: graphnet.data enables converting domain-specific data to industry-standard, intermediate file formats and reading this data; graphnet.models allows for configuring and building complex models using simple, physics-oriented components; graphnet.training manages model training and experiment logging; and finally, graphnet.deployment allows for using trained models for inference in domain-specific reconstruction chains.

+

High-level overview of a typical workflow using graphnetGraphNeT: graphnet.data enables converting domain-specific data to industry-standard, intermediate file formats and reading this data; graphnet.models allows for configuring and building complex models using simple, physics-oriented components; graphnet.training manages model training and experiment logging; and finally, graphnet.deployment allows for using trained models for inference in domain-specific reconstruction chains.

-

graphnet.models provides modular components subclassing torch.nn.Module, meaning that users only need to import a few existing, purpose-built components and chain them together to form a complete model. ML developers can contribute to graphnetGraphNeT by extending this suite of model components — through new layer types, physics tasks, graph connectivities, etc. — and experiment with optimising these for different reconstruction tasks using experiment tracking.

+

graphnet.models provides modular components subclassing torch.nn.Module, meaning that users only need to import a few existing, purpose-built components and chain them together to form a complete model. ML developers can contribute to graphnetGraphNeT by extending this suite of model components — through new layer types, physics tasks, graph connectivities, etc. — and experiment with optimising these for different reconstruction tasks using experiment tracking.

These models are trained using graphnet.training on data prepared using graphnet.data, to satisfy the high I/O loads required when training ML models on large batches of events, which domain-specific neutrino physics data formats typically do not allow.

Trained models are deployed to a domain-specific reconstruction chain, yielding predictions, using the components in graphnet.deployment. This can either be through model files or container images, making deployment as portable and dependency-free as possible.

-

By splitting up the model development as in flowchart, graphnetGraphNeT allows physics users to interface only with high-level building blocks or pre-trained models that can be used directly in their reconstruction chains, while allowing ML developers to continuously improve and expand the framework’s capabilities.

+

By splitting up the model development as in flowchart, graphnetGraphNeT allows physics users to interface only with high-level building blocks or pre-trained models that can be used directly in their reconstruction chains, while allowing ML developers to continuously improve and expand the framework’s capabilities.

Acknowledgements

@@ -400,7 +407,7 @@

AcknowledgementsSphinx 7.3.7. + Sphinx 8.0.2. and Material for Sphinx diff --git a/api/graphnet.constants.html b/api/graphnet.constants.html index b9ecca20c..27e1ed73d 100644 --- a/api/graphnet.constants.html +++ b/api/graphnet.constants.html @@ -61,7 +61,7 @@ - constants — graphnet documentation + graphnet.constants module — graphnet documentation