mkdocs.yml

# Copyright (c) 2022-2024, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
site_name: Triton Model Navigator
theme:
    name: material
    custom_dir: docs/overrides
    logo: assets/logo.png
    favicon: assets/favicon.png
    palette:
        primary: black
    features:
        - navigation.top
        - navigation.tabs
        - navigation.tabs.sticky
        - navigation.expand
        - navigation.sections
extra_css:
    - assets/styles.css
repo_url: https://github.com/triton-inference-server/model_navigator
repo_name: Git Repository
plugins:
    - autorefs
    - htmlproofer
    - mike
    -   mkdocstrings:
            enable_inventory: true
            handlers:
                python:
                    import:
                        - https://docs.python.org/3/objects.inv
                    options:
                        docstring_style: google
                        show_root_heading: true
                        heading_level: 2
                        line_length: 120
                        docstring_section_style: list
                        merge_init_into_class: true
                        separate_signature: true
                        inherited_members: true
                        signature_crossrefs: true
    - search
watch:
    - model_navigator
    - docs
    - mkdocs.yml
    - LICENSE
    - README.md
    - CHANGELOG.md
    - CONTRIBUTING.md
view_uri_template: blob/{ref}/{path}  # used by scripts/rewrite_links_to_repo.py hook
hooks:
    - scripts/rewrite_links_to_repo.py
extra:
    version:
        provider: mike
markdown_extensions:
    - admonition
    - pymdownx.details
    -   pymdownx.highlight:
            anchor_linenums: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences
nav:
    -   Learn:
            -   Overview: README.md
            -   Installation: installation.md
            -   Quick start: quick_start.md
            -   Support Matrix: support_matrix.md
    -   Guides:
            - Optimize Pipelines: pipelines_optimize/optimize/optimize.md
            - Optimize Models: models_optimize/optimize/optimize.md
            - Profile model or callable : pipelines_optimize/profile/profile.md
            - Navigator Package: models_optimize/package/package.md
            - Deployment on Pytriton: inference_deployment/pytriton/deployment.md
            - Deployment on Triton Inference Server: inference_deployment/triton/deployment.md
    -   Tutorials: examples.md
    -   References:
            -   Pipeline Optimize API:
                    -   Module: pipelines_optimize/optimize/api/module.md
                    -   Optimize: pipelines_optimize/optimize/api/optimize.md
                    -   Config: pipelines_optimize/optimize/api/config.md
            -   Profile API:
                    -   Profile: pipelines_optimize/profile/api/profile.md
            -   Model Optimize API:
                    -   Config: models_optimize/optimize/api/config.md
                    -   JAX: models_optimize/optimize/api/jax.md
                    -   ONNX: models_optimize/optimize/api/onnx.md
                    -   TensorFlow 2: models_optimize/optimize/api/tensorflow.md
                    -   TensorRT: models_optimize/optimize/api/tensorrt.md
                    -   PyTorch: models_optimize/optimize/api/torch.md
                    -   Python: models_optimize/optimize/api/python.md
            -   Navigator Package API:
                    -   Package: models_optimize/package/api/package.md
                    -   Load: models_optimize/package/api/package_load.md
                    -   Save: models_optimize/package/api/package_save.md
                    -   Optimize: models_optimize/package/api/package_optimize.md
                    -   Profile: models_optimize/package/api/package_profile.md
            -   PyTriton API:
                    - Adapter: inference_deployment/pytriton/api/adapter.md
                    - Deployment Config: inference_deployment/pytriton/api/config.md
            -   Triton Model Store API:
                    -   Adding Model: inference_deployment/triton/api/adding_model.md
                    -   Specialized Configs: inference_deployment/triton/api/specialized_configs.md
                    -   Instance Group: inference_deployment/triton/api/instance_groups.md
                    -   Inputs and Outputs: inference_deployment/triton/api/inputs_and_outputs.md
                    -   Dynamic Batcher: inference_deployment/triton/api/dynamic_batcher.md
                    -   Sequence Batcher: inference_deployment/triton/api/sequence_batcher.md
                    -   Accelerators: inference_deployment/triton/api/accelerators.md
                    -   Model Warmup: inference_deployment/triton/api/warmup.md
    -   Resources:

            -   Changelog: CHANGELOG.md
            -   Known Issues: known_issues.md
            -   Contributing: CONTRIBUTING.md
            -   License: LICENSE.md