croqtile-tutorial/mkdocs.yml at main · LancerLab/croqtile-tutorial · 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
133
134
135
136
137
138
139
140
141
142
143
144
site_name: Croqtile
site_url: https://LancerLab.github.io/croqtile-tutorial/
docs_dir: docs

repo_name: LancerLab/croqtile-tutorial
repo_url: https://github.com/LancerLab/croqtile-tutorial

theme:
  name: material
  favicon: assets/images/favicon.svg
  logo: assets/images/logo-2.png
  features:
    - navigation.top
    - navigation.path
    - navigation.indexes
    - search.highlight
    - search.suggest
    - content.code.annotate
    - content.code.copy
    - toc.follow
  palette:
    - scheme: default
      primary: green
      accent: light green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: light green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/cpp.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/bash.min.js
  - assets/js/hljs-choreo.js
  - assets/js/hljs-init.js

extra_css:
  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css
  - assets/css/custom.css

plugins:
  - search
  - i18n:
      docs_structure: folder
      fallback_to_default: true
      reconfigure_material: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true

markdown_extensions:
  - pymdownx.highlight:
      use_pygments: false
  - toc:
      permalink: true
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - tables
  - attr_list
  - md_in_html

nav:
  - Home: index.md
  - What is Good in CroqTile: documentation/what-is-choreo.md

  - "Part I — Tutorial":
    - Overview: tutorial/index.md
    - "Ch 0: Installing Croqtile": tutorial/ch00-installation.md
    - "Ch 1: Hello Croqtile": tutorial/ch01-hello-croqtile.md
    - "Ch 2: Data Movement": tutorial/ch02-data-movement.md
    - "Ch 3: Parallelism": tutorial/ch03-parallelism.md
    - "Ch 4: Tensor Contraction (MMA)": tutorial/ch04-mma.md
    - "Ch 5: Control Flow": tutorial/ch05-branch-control.md
    - "Ch 6: Synchronization": tutorial/ch06-synchronization.md
    - "Ch 7: Advanced Data Movement": tutorial/ch07-advanced-movement.md
    - "Ch 8: C++ Interop": tutorial/ch08-cpp-interop.md
    - "Ch 9: Debug & Verbose": tutorial/ch09-debug-verbose.md

  - "Part II — Performance Tuning Demos":
    - Overview: optimization/index.md
    - "Profiling Setup": optimization/setup-profiling.md
    - "Dense GEMM FP16 (from naive)": optimization/dense-gemm-fp16-from-naive.md
    - "Sparse GEMM (FP16 + E4M3)": optimization/sparse-gemm.md
    - "Block-Scaled GEMM FP8": optimization/blockscale-gemm-fp8.md
    - "Fused MoE FP8": optimization/fused-moe-fp8.md

  - "Part III — Coding Reference":
    - Home: documentation/index.md
    - "Program Structure":
      - Croqtile-C++ Program Structure: documentation/choreo-program-structure.md
    - "Shaped Data":
      - Shape and MDSpan: documentation/shape-in-choreo.md
      - Integers and I-Tuples: documentation/integer-ituple.md
      - Spanned Data and Buffers: documentation/spanned-data.md
      - Dynamic Shape and Symbolic Dimension: documentation/symbolic-shape.md
    - "Loop and Parallelism":
      - About Parallelism and Iterations: documentation/intro-loop-parallel.md
      - SPMD Parallelism: documentation/parallel-in-choreo.md
      - Loop Control: documentation/within-loops.md
    - "Data Movement":
      - The DMA Statement: documentation/basic-dma.md
      - Tile Data with ChunkAt: documentation/tiling-chunkat.md
      - Advanced Data Movement: documentation/dma-in-advance.md
    - "C++ Embeddings":
      - Inputs and Output: documentation/input-output.md
      - Macro and Preprocessing: documentation/macro-in-choreo.md
    - "MPMD Programming":
      - Thread Masking: documentation/thread-masking.md
      - Events for Async Execution: documentation/events.md
      - More on Async Execution: documentation/general-async.md
    - "Advanced":
      - Experimental Features: documentation/loop-in-advance.md
    - "Optimization Patterns":
      - Tileflow Optimizations: documentation/tileflow-opt.md
      - Async DMA Patterns: documentation/async-dma-patterns.md
      - Multi-buffering Patterns: documentation/multi-buffering-patterns.md
    - Reference Palette: documentation/operator-samples.md
    - "Design Rationales":
      - Syntax Design: documentation/syntax-design-of-choreo.md
      - Why Symbolic Shapes: documentation/why-symbolic-shapes.md
      - Symbolic Evaluation System: documentation/value-numbering.md
      - Dynamism Support: documentation/dynamic-design.md

  - "Part IV — Design Rationales": advanced/index.md