turftopic/mkdocs.yml at main · x-tabdeveloping/turftopic · 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
site_name: Turftopic
site_description: 'An all-in-one library for topic modeling with sentence embeddings.'
repo_url: https://github.com/x-tabdeveloping/turftopic
nav:
  - Basic Usage:
    - Getting Started: index.md
    - Defining and Fitting Topic Models: model_definition_and_training.md
    - Interpreting and Visualizing Models: model_interpretation.md
    - Modifying and Finetuning Models: finetuning.md
    - Saving and Loading: persistence.md
    - Using TopicData: topic_data.md
  - Advanced Usage:
    - Seeded Topic Modeling: seeded.md
    - Dynamic Topic Modeling: dynamic.md
    - Online Topic Modeling: online.md
    - Hierarchical Topic Modeling: hierarchical.md
    - Cross-Lingual Topic Modeling: cross_lingual.md
    - Late Interaction (Multi-vector) Topic Models: late_interaction.md
    - Concept Induction: concept_induction.md
    - Multimodal Modeling (Experimental): multimodal.md
    - Model Merging: topic_merging.md
    - Distribution Learning: distribution_learning.md
    - Implement a Wrapper/Custom Model: custom_model.md
  - Examples:
     - Turftopic Example Gallery: tutorials/overview.md
     - Surveying and Filtering Large Training Datasets with SensTopic: tutorials/fineweb_1m.md
     - Analyzing the Landscape of Machine Learning Research: tutorials/arxiv_ml.md
     - Discourse Analysis on Morality and Religion: tutorials/religious.md
     - Discovering a Data-driven Political Compass: tutorials/ideologies.md
     - Customer Dissatisfaction Analysis: tutorials/reviews.md
  - <span>Topic Models<span> <br> <i class="subtext">(Overview and Performance)</i>:
    - Model Overview: model_overview.md
    - Model Leaderboard: benchmark.md
    - Semantic Signal Separation (S³): s3.md
    - SensTopic (BETA): SensTopic.md
    - KeyNMF: KeyNMF.md
    - Topeax: Topeax.md
    - GMM: GMM.md
    - Clustering Models (BERTopic & Top2Vec): clustering.md
    - C-Top2Vec: c_top2vec.md
    - Autoencoding Models (ZeroShotTM & CombinedTM): ctm.md
    - FASTopic: FASTopic.md
  - <span>Other Models<span> <br> <i class="subtext">(e.g. Sentiment Analysis)</i>:
    - Concept Vector Projection (Continuous Sentiment Scoring): cvp.md
  - <span>Embeddings and Encoders <span><br> <i class="subtext">(Transformer Models)</i>: encoders.md
  - <span>Vectorizers<span> <br> <i class="subtext">(Term extraction)</i>: vectorizers.md
  - <span> Automated Topic Analysis<span> <br> <i class="subtext">(Topic names and descriptions)</i>:
     - Analyzers Overview: analyzers.md
     - Wiki Analyzer: wiki.md
theme:
  name: material
  logo: images/logo.svg
  font:
    text: Ubuntu
  navigation_depth: 3
  palette:
    # System preference (auto)
    - media: "(prefers-color-scheme)"
      scheme: default
      primary: '#01034A'
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: '#01034A'
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
      - toc.integrate
      - navigation.tabs
      - navigation.tabs.sticky
      - navigation.sections
      - navigation.expand
      - navigation.path
      - navigation.indexes
      - toc.follow
      - content.code.copy

extra_css:
  - stylesheets/extra.css

plugins:
- search
- mkdocstrings:
    handlers:
      python:
        options:
          annotations_path: brief
          show_root_heading: true
          show_root_toc_entry: false
          show_symbol_type_heading: true
          docstring_style: numpy
          heading_level: 3

markdown_extensions:
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - tables
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      toc_depth: 2
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg


extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js