aitune/mkdocs.yml at main · ai-dynamo/aitune · 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
site_name: NVIDIA AITune
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/ai-dynamo/aitune
repo_name: GitHub Repository
plugins:
    - autorefs
    - htmlproofer:
        ignore_urls:
            - '**/aot_tuning/backend/#aitune.torch.backend*'
            - '**/backends/*/#aitune.torch.backend*'
    - 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
    - redirects:
        redirect_maps:
            index.md: learn/overview.md

watch:
    - aitune
    - docs
    - mkdocs.yml
    - LICENSE
    - 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: learn/overview.md
            -   Install: learn/install.md
            -   Quick Start: learn/quick_start.md
            -   Core Functionalities: learn/core_functionalities.md
            -   Backends: learn/backends.md
            -   Observability: learn/observability.md
    -   Guides:
            - Ahead-of-time Tuning: guides/aot_tuning.md
            - Ahead-of-time Inspect: guides/aot_inspect.md
            - Just-in-time Tuning: guides/jit_tuning.md
            - Just-in-time Inspect: guides/jit_inspect.md
            - Backends:
                - TensorRT Backend: guides/backends/tensorrt_backend.md
                - TensorRT Optimization Profiles: guides/backends/tensorrt_optimization_profiles.md
                - Torch-TensorRT Backend (JIT): guides/backends/torch_tensorrt_jit_backend.md
                - Torch-TensorRT Backend (AOT): guides/backends/torch_tensorrt_aot_backend.md
                - TorchAO Backend: guides/backends/torchao_backend.md
                - Torch Inductor Backend: guides/backends/torch_inductor_backend.md
            - Tune Strategies: guides/tune_strategies/tune_strategies.md
            - Deployment: guides/deployment/deployment.md
            - Advanced:
                - Tuning Workflow: guides/advanced/tuning_workflow.md
                - Execution Graphs: guides/advanced/execution_graphs.md
                - NVTX Profiling: guides/advanced/profiling_nvtx.md

    -   Examples:
            - Overview: examples/examples.md
            - E5Large: examples/E5Large/README.md
            - ESM2: examples/ESM2/README.md
            - FLUX: examples/FLUX/README.md
            - JitTuning: examples/JitTuning/README.md
            - LLM: examples/LLM/README.md
            - ParakeetCTC: examples/ParakeetCTC/README.md
            - ParakeetRNNT: examples/ParakeetRNNT/README.md
            - ResNet: examples/ResNet/README.md
            - StableDiffusion: examples/StableDiffusion/README.md
    -   API:
            -   Ahead-of-time Tuning API:
                    -   Module: api/aot_tuning/module.md
                    -   Tuning: api/aot_tuning/tuning.md
                    -   Config: api/aot_tuning/config.md
                    -   Backend: api/aot_tuning/backend.md
                    -   Inspect: api/aot_tuning/inspect.md
            -   Just-in-time Tuning API:
                    -   Config: api/jit_tuning/config.md
            -   Backends API:
                    -   TensorRT Backend: api/backends/tensorrt_backend.md
                    -   Torch-TensorRT Backend (JIT): api/backends/torch_tensorrt_jit_backend.md
                    -   Torch-TensorRT Backend (AOT): api/backends/torch_tensorrt_aot_backend.md
                    -   TorchAO Backend: api/backends/torchao_backend.md
                    -   Torch Inductor Backend: api/backends/torch_inductor_backend.md
            -   Tuning Strategies API:
                    -   FirstWinsStrategy: api/tune_strategies/first_wins_strategy.md
                    -   OneBackendStrategy: api/tune_strategies/one_backend_strategy.md
                    -   HighestThroughputStrategy: api/tune_strategies/highest_throughput_strategy.md

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