diffusion-rl-survey/mkdocs.yml at master · AndyZhou952/diffusion-rl-survey · 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
site_name: Diffusion-RL Survey
site_description: A survey of reinforcement learning algorithms for multimodal (image/video) generative models, aligned with the VeRL-Omni ubiquitous language.
repo_url: https://github.com/AndyZhou952/diffusion-rl-survey
repo_name: diffusion-rl-survey

# The markdown lives at the repository root (README.md, papers/, …). The `same-dir`
# plugin lets docs_dir be the repo root without the site_dir-inside-docs_dir conflict.
docs_dir: .
site_dir: site

plugins:
  - search
  - same-dir

theme:
  name: material
  font:
    text: Newsreader        # editorial body serif; harmonizes with KaTeX math
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - navigation.top
    - navigation.prune      # keep DOM light; render the active sub-tree only
    - toc.follow
    - search.suggest
    - content.code.copy

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - admonition
  - tables
  - toc:
      permalink: true

extra_javascript:
  - docs/javascripts/katex.js
  - docs/javascripts/paradigm.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
  - docs/stylesheets/extra.css

# Keep build output clean: ignore everything that is not part of the survey.
exclude_docs: |
  .github/
  site/
  node_modules/
  scratchpad/
  requirements-docs.txt

nav:
  - Home: README.md
  - Reading Guide: papers/READING_GUIDE.md
  - Prerequisites:
      - Multimodal models: papers/prerequisites/multimodal_basics.md
      - Flow matching: papers/prerequisites/flow_matching_basics.md
      - GRPO / PPO: papers/prerequisites/grpo_basics.md
  - Policy Gradient:
      - FlowGRPO: papers/policy_gradient/flow_grpo.md
      - DanceGRPO: papers/policy_gradient/dance_grpo.md
      - MixGRPO: papers/policy_gradient/mix_grpo.md
      - FlowGRPO-CPS: papers/policy_gradient/cps.md
      - GRPO-Guard: papers/policy_gradient/grpo_guard.md
      - UniGRPO: papers/policy_gradient/uni_grpo.md
      - FlowDPPO: papers/policy_gradient/flow_dppo.md
  - Direct Preference:
      - Diffusion-DPO: papers/direct_preference/diffusion_dpo.md
      - SRPO: papers/direct_preference/srpo.md
      - DiffusionNFT: papers/direct_preference/diffusion_nft.md
      - AWM: papers/direct_preference/awm.md
      - DGPO: papers/direct_preference/dgpo.md
  - Academia (long tail): papers/academia.md
  - Industry Models: models.md
  - Reference:
      - Paper Index: papers/INDEX.md
      - Notation: papers/NOTATION.md
      - Integration Guide: INTEGRATION_GUIDE.md