Skip to content

Introduction#

Welcome to the Salt framework!

Salt is a general-purpose framework to train multi-modal, multi-task models. It was developed for state-of-the art jet flavour tagging algorithms such as GN1 and GN2, but can be applied much more widely. For example, you could use Salt to classify or regress properties of objects or events, or all these things at once!

Features#

  • Built on Pytorch Lightning.
  • Support for multiple YAML-configurable input modalities and output tasks.
  • ONNX export support to use trained models in Athena.
  • Easily extensible: you can implement your own custom dataloaders and models.
  • Documented and tested.

Getting Started#

Below are some helpful links to get you started:

You can find out more about flavour tagging algorithms at the FTAG docs

There is a channel for the framework in the FTAG Mattermost workspace

A tutorial on how to use Salt can be found here and here

Contributions are welcome! Check out existing issues for inspiration, or open your own

You can become a Salt expert by checking out the API reference

Current Usage#

Salt is currently used for the following projects:

The framework is originally based on work from two previously existing projects: [1] [2].


Last update: March 6, 2024
Created: October 7, 2022