mkdocs.yml

# Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Project information
site_name: Docs for NetsPresso Trainer
site_url: https://nota-netspresso.github.io/netspresso-trainer/
site_author: Nota
site_description: >-
  Start training models (including ViTs) with NetsPresso Trainer,
  compress and deploy your model with NetsPresso!

# Repository
repo_name: nota-netspresso/netspresso-trainer
repo_url: https://github.com/nota-netspresso/netspresso-trainer

# Copyright
copyright: © 2023 Nota Inc.

# Configuration
theme:
  name: material
  custom_dir: docs/.material/.overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    # - navigation.sections
    - navigation.expand
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - scheme: default
      primary: black
      accent: light blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: light blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/images/favicon.png
  # logo: assets/images/NetsPresso.svg

extra_javascript:
  - assets/javascripts/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js  
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra_css:
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

# Customization
extra:
  annotate:
    json: [.s2]
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Nota-NetsPresso
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/netspresso-trainer/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/notaai

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: index.md
  - Getting started:
    - Installation:
      - Installation (Stable): getting_started/installation/installation.md
      - Setup with Docker: getting_started/installation/docker_installation.md
    - Simple use: getting_started/simple_use.md
    - Dataset preparation:
      - Local dataset: getting_started/dataset_preparation/local.md
      - Hugging Face dataset: getting_started/dataset_preparation/huggingface.md
    - Asking a question: https://github.com/Nota-NetsPresso/netspresso-trainer/issues
  - Components:
    - Overview: components/overview.md
    - Data: components/data.md
    - Augmentation: 
      - Overview: components/augmentation/overview.md
      - Transforms: components/augmentation/transforms.md
    - Training: 
      - Overview: components/training/overview.md
      - EMA: components/training/ema.md
      - Gradient clipping: components/training/gradient-clipping.md
      - Optimizers: components/training/optimizers.md
      - Schedulers: components/training/schedulers.md
    - Model:
      - Overview: components/model/overview.md
      - Losses: components/model/losses.md
      - Postprocessors: components/model/postprocessors.md
    - Logging: components/logging.md
    - Environment: components/environment.md
  - Models:
    - Overview: models/overview.md
    - Full models: 
      - PIDNet: models/fullmodels/pidnet.md
    - Backbones:
      - CSPDarkNet: models/backbones/cspdarknet.md
      - EfficientFormer: models/backbones/efficientformer.md
      - MixNet: models/backbones/mixnet.md
      - MixTransformer: models/backbones/mixtransformer.md
      - MobileNetV3: models/backbones/mobilenetv3.md
      - MobileNetV4: models/backbones/mobilenetv4.md
      - MobileViT: models/backbones/mobilevit.md
      - ResNet: models/backbones/resnet.md
      - ViT: models/backbones/vit.md
    - Necks:
      - FPN: models/necks/fpn.md
      - YOLOPAFPN: models/necks/yolopafpn.md
    - Heads:
      - AllMLPDecoder: models/heads/allmlpdecoder.md
      - AnchorDecoupledHead: models/heads/anchordecoupledhead.md
      - AnchorFreeDecoupledHead: models/heads/anchorfreedecoupledhead.md
      - FC: models/heads/fc.md  
      - RTMCC: models/heads/rtmcc.md
    - Layers:
      - Activations: models/layers/activations.md
      - Normalizations: models/layers/normalizations.md
  - Benchmarks & Deployment: 
    - Benchmarks: benchmarks/benchmarks.md
    - Compression compatibility matrix: benchmarks/compression_compat_matrix.md
    - Device deployment matrix: 
      - TensorRT: benchmarks/device_matrix/tensorrt.md
      - TFLite: benchmarks/device_matrix/tflite.md
      - OpenVINO: benchmarks/device_matrix/openvino.md
      - DRP-AI: benchmarks/device_matrix/drpai.md
    - TFLite runtime examples:
      - YOLOX-s: benchmarks/tflite_runtime_examples/yolox-s.md
  - NetsPresso: https://netspresso.ai/