production-vlm-engineering/mkdocs.yml at main · Mattral/production-vlm-engineering · 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
site_name: Production VLM Engineering
site_description: >-
  Reproducible, production-grade pipelines for multimodal vision systems:
  fine-tuning, drift monitoring, edge inference, robustness & safety.
site_url: https://mattral.github.io/production-vlm-engineering/
repo_url: https://github.com/Mattral/production-vlm-engineering
repo_name: Mattral/production-vlm-engineering
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  palette:
    - scheme: default
      primary: indigo
      accent: deep-purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: deep-purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - search.highlight
    - search.suggest

nav:
  - Home: index.md
  - Getting Started:
      - Quickstart: getting_started/quickstart.md
      - Installation: getting_started/installation.md
      - Architecture: getting_started/architecture.md
  - Examples:
      - Overview: examples/overview.md
      - VLM Chart Fine-Tuning: examples/vlm_chart_finetune.md
      - Embedding Drift & Active Learning: examples/embedding_drift.md
      - Edge Inference & Serving: examples/edge_inference.md
      - Robustness & Safety Guard: examples/robustness_guard.md
      - Video / Temporal Reasoning: examples/vlm_video_temporal.md
  - Concepts:
      - LoRA Adaptation: concepts/lora.md
      - Drift Detection: concepts/drift.md
      - Evaluation Metrics: concepts/metrics.md
      - OOD & Robustness: concepts/robustness.md
  - Benchmark Results: benchmark_report.md
  - Citations: citations.md
  - API Reference: api.md
  - Contributing: contributing.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: google
            merge_init_into_class: true
            filters: ["!^_"]

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - attr_list
  - def_list
  - footnotes
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Mattral/production-vlm-engineering
  version:
    provider: mike

extra_css:
  - assets/extra.css