mkdocs.yml

site_name: coral_pytorch
site_url: http://raschka-research-group.github.io/coral_pytorch
site_author: Sebastian Raschka
site_description: coral_pytorch is a package implementing the CORAL PyTorch utilities.

repo_url: https://github.com/raschka-research-group/coral_pytorch

#include_search: true
#theme: yeti

docs_dir: docs
site_favicon: favicon.ico

# install via pip install mkdocs-material
theme: material

markdown_extensions:
  - pymdownx.highlight # syntax highlighting
  - pymdownx.superfences # syntax highlighting
  - tables
  - fenced_code
  - mdx_math:
      enable_dollar_delimiter: True # for use of inline $..$
extra_javascript:
  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML
  - mathjaxhelper.js
extra_css:
  - extra.css

copyright: Copyright &copy; 2020-2022 <a href="http://sebastianraschka.com">Sebastian Raschka</a>
#google_analytics: ['UA-38457794-3', 'raschka-research-group.github.io/pytorch_coral']

nav:
    - Home: index.md
    - Tutorials:   
      - PyTorch Lightning Examples:
        - CORAL multilayer perceptron for tabular data (Cement dataset): tutorials/pytorch_lightning/ordinal-coral_cement.md
        - CORAL convolutional neural net for image data (MNIST dataset): tutorials/pytorch_lightning/ordinal-coral_mnist.md
        - CORN multilayer perceptron for tabular data (Cement dataset): tutorials/pytorch_lightning/ordinal-corn_cement.md
        - CORN convolutional neural net for image data (MNIST dataset): tutorials/pytorch_lightning/ordinal-corn_mnist.md
        - CORN large language transformer (DistilBERT) for text data (TripAdvisor dataset): tutorials/pytorch_lightning/distilbert-corn-tripadvisor.md
      - Pure PyTorch Examples:
        - CORAL CNN model for image data (MNIST dataset): tutorials/pure_pytorch/CORAL_mnist.md
        - CORAL MLP model for tabular data (Cement dataset): tutorials/pure_pytorch/CORAL_cement.md
        - CORN CNN model for image data (MNIST dataset): tutorials/pure_pytorch/CORN_mnist.md
        - CORN MLP model for tabular data (Cement dataset): tutorials/pure_pytorch/CORN_cement.md
    - API:
          - coral_pytorch.dataset: api_subpackages/coral_pytorch.dataset.md
          - coral_pytorch.layers: api_subpackages/coral_pytorch.layers.md
          - coral_pytorch.losses: api_subpackages/coral_pytorch.losses.md
    - Installation: installation.md
    - Changelog: CHANGELOG.md
    - Citing: citing.md
    - License: license.md