THETA/mkdocs.yml at main · CodeSoul-co/THETA · 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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# Site Information
site_name: THETA Topic Model
site_url: https://codesoul-co.github.io/THETA/
site_description: Advanced Topic Modeling with Qwen Embeddings
site_author: CodeSoul
docs_dir: doc

# Repository
repo_name: CodeSoul-co/THETA
repo_url: https://github.com/CodeSoul-co/THETA
edit_uri: edit/main/doc/

# Copyright
copyright: Copyright &copy; 2024-2026 CodeSoul

# Theme
theme:
  name: material
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.action.edit

  icon:
    repo: fontawesome/brands/github

  font:
    text: Roboto
    code: Roboto Mono

# Plugins
plugins:
  - search:
      lang:
        - en
        - zh
  - i18n:
      docs_structure: suffix
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true
          nav:
            - 首页: index.md
            - 快速入门:
                - 项目概述: getting-started/overview.md
                - 安装: getting-started/installation.md
                - 快速开始: getting-started/quickstart.md
            - 用户指南:
                - 数据准备: user-guide/data-preparation.md
                - 数据预处理: user-guide/preprocessing.md
                - 训练模型: user-guide/training.md
                - 评估: user-guide/evaluation.md
                - 可视化: user-guide/visualization.md
            - 模型:
                - THETA模型: models/theta.md
                - 基线模型: models/baselines.md
                - 模型比较: models/comparison.md
            - 高级:
                - 自定义数据集: advanced/custom-datasets.md
                - 超参数调优: advanced/hyperparameters.md
                - 中文数据处理: advanced/chinese-data.md
                - 分布式训练: advanced/distributed-training.md
            - API参考:
                - prepare_data.py: api/prepare-data.md
                - run_pipeline.py: api/run-pipeline.md
                - 可视化: api/visualization.md
            - 示例:
                - 英文数据集: examples/english-dataset.md
                - 中文数据集: examples/chinese-dataset.md
                - 有监督学习: examples/supervised-learning.md
            - 故障排除: troubleshooting.md
            - 附录: appendix/faq.md

# Markdown Extensions
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
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - toc:
      permalink: true
      toc_depth: 3

# Navigation
nav:
  - Home: index.md
  - Getting Started:
      - Overview: getting-started/overview.md
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Data Preparation: user-guide/data-preparation.md
      - Preprocessing: user-guide/preprocessing.md
      - Training Models: user-guide/training.md
      - Evaluation: user-guide/evaluation.md
      - Visualization: user-guide/visualization.md
  - Models:
      - THETA Model: models/theta.md
      - Baseline Models: models/baselines.md
      - Model Comparison: models/comparison.md
  - Advanced:
      - Custom Datasets: advanced/custom-datasets.md
      - Hyperparameter Tuning: advanced/hyperparameters.md
      - Chinese Data Processing: advanced/chinese-data.md
      - Distributed Training: advanced/distributed-training.md
  - API Reference:
      - prepare_data.py: api/prepare-data.md
      - run_pipeline.py: api/run-pipeline.md
      - Visualization: api/visualization.md
  - Examples:
      - English Dataset: examples/english-dataset.md
      - Chinese Dataset: examples/chinese-dataset.md
      - Supervised Learning: examples/supervised-learning.md
  - Troubleshooting: troubleshooting.md
  - Appendix: appendix/faq.md

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/CodeSoul-co/THETA
      name: GitHub