mkdocs.yml

site_name: LIBXSMM
site_author: Hans Pabst
copyright: Copyright (c) 2009-2023, LIBXSMM <a href="http://libxsmm.readthedocs.io/LICENSE/">Contributors</a>.
site_description: Library for specialized dense and sparse matrix operations, and deep learning primitives.
repo_url: https://github.com/libxsmm/libxsmm/
edit_uri: edit/main/documentation
site_url: https://libxsmm.readthedocs.io/
docs_dir: documentation

markdown_extensions:
- toc:
    permalink: True
    toc_depth: 3
    title: None
extra_css:
- style.css

theme:
    name: readthedocs
    custom_dir: .theme

hooks:
- .theme/ford_hook.py

nav:
- Overview: index.md
- Compatibility: libxsmm_compat.md
- Validation: libxsmm_valid.md
- Scripts: libxsmm_scripts.md
- Q&A: libxsmm_qna.md
- LIBXSMM Domains:
  - "MM: Matrix Multiplication": libxsmm_mm.md
  - "TPP: Tensor Processing Primitives": libxsmm_tpp.md
  - "DNN: Deep Neural Networks": https://libxsmm.readthedocs.io/#deep-learning
  - "AUX: Service Functions": libxsmm_aux.md
  - "PROF: Performance Profiling": libxsmm_prof.md
  - "TUNE: Customization": libxsmm_tune.md
  - "BE: Backend": libxsmm_be.md
- Fortran:
  - Reference: fortran/module/libxsmm.html
- Example Code:
  - Collection: libxsmm_samples.md
- Machine Learning (ML):
  - PlaidML tensor compiler: https://github.com/plaidml/plaidml
  - Extension for PyTorch: https://github.com/libxsmm/libxsmm/tree/main/samples/deeplearning/conv1dopti_layer
- Scientific (HPC):
  - CP2K: cp2k.md
  - SeisSol: https://seissol.readthedocs.io/en/latest/compilation.html#installing-libxsmm
  - SpECTRE: https://sxs-collaboration.github.io/spectre/installation.html
  - libCEED: https://ceed.exascaleproject.org/ceed-code/
  - Fastor: https://github.com/romeric/Fastor/wiki/9.-Using-the-LIBXSMM-MKL-JIT-backend
  - EDGE: https://usr.dial3343.org/en/master/chapters/install/edge.html#edge
  - PyFR: https://pyfr.readthedocs.io/en/latest/performance_tuning.html#libxsmm
- About:
  - Contributing: CONTRIBUTING.md
  - License: LICENSE.md