umami/mkdocs.yml at master · umami-hep/umami · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
site_name: Umami documentation
site_description: Documentation for Umami
site_author: Umami team
site_url: https://umami-docs.web.cern.ch

repo_name: GitLab
repo_url: https://gitlab.cern.ch/atlas-flavor-tagging-tools/algorithms/umami
edit_uri: 'tree/master/docs'

theme:
    name: material
    features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
    - Home: index.md
    - Setup:
        - Installation: setup/installation.md
        - Development:
            - Overview: setup/development/index.md
            - Good practices code: setup/development/good_practices_code.md
            - Good practices docs: setup/development/good_practices_docs.md
            - VS Code: setup/development/VS_code.md

        - Changelog: setup/changelog.md
    - Preprocessing:
        - Overview: preprocessing/Overview.md
        - Ntuple preparation: preprocessing/ntuple_preparation.md
        - Resampling: preprocessing/resampling.md
        - Scaling/Shifting: preprocessing/scaling_shifting.md
        - Write train sample: preprocessing/write_train_sample.md
        - MC samples: 'https://ftag.docs.cern.ch/samples/sample_list/'
        - Truth labels: 'https://ftag-docs.docs.cern.ch/algorithms/labelling/jet_labels/'
    - Training:
        - Overview: trainings/Overview.md
        - Start Training your Model: trainings/train.md
        - Validate your Training: trainings/validate.md
        - Evaluate your Training: trainings/evaluate.md
        - Running GNN: trainings/GNN-instructions.md
        - LWTNN Conversion: trainings/LWTNN-conversion.md
    - Plotting:
        - Overview: plotting/index.md
        - Input variables: plotting/plotting_inputs.md
        - Tagger performance: plotting/plotting_umami.md
        - Python API:
            - Overview: plotting/python_api/index.md
            - Input Correlation plots: plotting/python_api/input_correlations.md
    - Tutorial:
        - Overview: tutorial/index.md
        - Preprocessing: tutorial/preprocessing.md
        - Training: tutorial/training.md
        - Validation: tutorial/validation.md
        - ATLAS FTAG: tutorial/tutorial-umami.md
    - Contributing:
        - contributing/index.md
    - FAQ:
        - Overview: faq/overview_faq.md
        - Preprocessing: faq/preprocessing_faq.md
        - Training: faq/training_faq.md
        - Validation of the trainings: faq/validation_faq.md
        - Evaluation of the trainings: faq/evaluation_faq.md

plugins:
    - search

markdown_extensions:
    - admonition
    - codehilite
    - pymdownx.arithmatex
    - pymdownx.details
    - pymdownx.inlinehilite
    - pymdownx.smartsymbols
    - pymdownx.snippets
    - pymdownx.superfences
    - toc:
        permalink: "#"


extra_javascript:
    - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'