ANEForge/mkdocs.yml at main · comp-physics/ANEForge · 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
site_name: ANEForge
site_description: Direct, CoreML-free Apple Neural Engine backend for Python
site_author: Spencer H. Bryngelson
repo_url: https://github.com/sbryngelson/ANEForge
repo_name: sbryngelson/ANEForge
edit_uri: edit/main/docs/
docs_dir: docs

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - content.code.copy
    - search.suggest
    - search.highlight
    - toc.follow

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            heading_level: 2
            members_order: source
            filters: ["!^_"]
            show_root_heading: true
            show_root_full_path: false
            show_source: true
            separate_signature: true
            show_signature_annotations: true
            docstring_section_style: table

markdown_extensions:
  - admonition
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.details

nav:
  - Home: index.md
  - Get something running:
      - Getting started: getting-started.md
      - API reference: aneforge-api.md
      - Training on the ANE: training.md
      - MIL primer: mil-primer.md
      - FAQ: faq.md
  - Use the engine well:
      - Cross-chip deployment: cross-chip.md
      - Dispatch backends: dispatch.md
      - e5rt dispatch reference: e5rt-dispatch-reference.md
  - Know what works:
      - Capabilities: capabilities.md
      - Op catalog: op-catalog.md
      - ONNX import: onnx.md
      - LLMs (decode, MoE, speculative): llm.md
      - MLPerf (ResNet-50 on the ANE): mlperf.md
  - API reference:
      - Overview: api/index.md
      - Graph & operators: api/graph.md
      - Compile, optimize, estimate: api/compile.md
      - Training & autograd: api/training.md
      - Pretrained models: api/models.md
      - Applied math: api/math.md
  - Internals (developer):
      - Overview: developer/overview.md
      - Compile pipeline: developer/compile-pipeline.md
      - Optimizer & cost model: developer/optimizer-and-cost.md
      - Numerics: developer/numerics.md
      - Native bridges: developer/bridges.md
      - Op quirks: developer/op-quirks.md
      - Capabilities & targets: developer/capabilities-and-targets.md
      - Autograd internals: developer/autograd.md
      - Model loaders: developer/models.md
  - Contribute:
      - Development: development.md
      - Glossary: glossary.md
      - Roadmap: roadmap.md
  - Reproducibility: reproducibility.md

validation:
  nav:
    omitted_files: ignore
  not_found: warn