diff --git a/docs/source/intro/intro.rst b/docs/source/intro/intro.rst index 57dd3f1ab..d2757fe63 100644 --- a/docs/source/intro/intro.rst +++ b/docs/source/intro/intro.rst @@ -1,4 +1,14 @@ -.. include:: ../substitutions.rst +.. |graphnet| image:: ../../assets/identity/favicon.svg + :width: 25px + :height: 25px + :alt: graphnet + :align: bottom + +.. |graphnet-header| image:: ../../assets/identity/favicon.svg + :width: 50px + :height: 50px + :alt: graphnet + :align: bottom GraphNeT\ |graphnet-header| ######## @@ -10,7 +20,7 @@ GraphNeT\ |graphnet-header| |graphnet|\ GraphNeT comprises a number of modules providing the necessary tools to build workflows. These workflows range from ingesting raw training data in domain-specific formats to deploying trained models in domain-specific reconstruction chains, as illustrated in [the Figure](flowchart). .. _flowchart: -.. figure:: ../../../paper/flowchart.png +.. figure:: ../../paper/flowchart.png High-level overview of a typical workflow using |graphnet|\ GraphNeT: :code:`graphnet.data` enables converting domain-specific data to industry-standard, intermediate file formats and reading this data; :code:`graphnet.models` allows for configuring and building complex models using simple, physics-oriented components; :code:`graphnet.training` manages model training and experiment logging; and finally, :code:`graphnet.deployment` allows for using trained models for inference in domain-specific reconstruction chains. @@ -23,7 +33,7 @@ Trained models are deployed to a domain-specific reconstruction chain, yielding By splitting up the model development as in :numref:`flowchart`, |graphnet|\ GraphNeT 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. -.. image:: ../../../assets/images/eu-emblem.jpg +.. image:: ../../assets/images/eu-emblem.jpg :width: 150 This project has received funding from the European Union’s Horizon 2020 research and innovation programme under the Marie Skłodowska-Curie grant agreement No. 890778.