Started working on docs

Author: x-tabdeveloping

docs/late_interaction.md

@@ -0,0 +1,31 @@
+
+| Topic ID | Highest Ranking |
+| - | - |
+| -1 | nasa, nasa gov, space exploration, space science, spaceflight, astronomy space, spacecraft, national space, space program, sci space |
+| 225 | astronomical, astronomers, astronomy, astronomy space, sci astro, interplanetary, galactic, celestial bbs, gamma ray, astro |
+| 240 | satellites, nasa, telescope, astronomy space, satellite, observatory, spacecraft, nasa gov, astronomical, astronomy |
+| 242 | shuttle program, shuttle mission, space shuttle, shuttle launch, shuttle elements, space program, spaceflight, shuttle, shuttle elements documentation, space exploration |
+| 243 | nasa gov, nasa, space exploration, national space, commercial space, spaceflight, space station, space science, sci space, space news |
+| 244 | astronomy space, nasa, space science, sci astro, sci space, nasa gov, spacecraft, astronomical, space news, space program |
+
+
+## API Reference 
+
+### Encoder
+
+::: turftopic.late.LateSentenceTransformer
+
+### Wrapper
+
+::: turftopic.late.LateWrapper
+
+### Utility functions
+
+::: turftopic.late.flatten_repr
+
+::: turftopic.late.unflatten_repr
+
+::: turftopic.late.pool_flat
+
+::: turftopic.late.get_document_chunks
+

docs/stylesheets/extra.css

@@ -0,0 +1,11 @@
+.md-tabs__item {
+    height: 70px; 
+    align-items: center;
+    display: flex;
+}
+.md-tabs__link {
+    text-align: center;
+}
+.subtext {
+    font-size: small;
+}

mkdocs.yml

@@ -11,8 +11,9 @@ nav:
     - Online Topic Modeling: online.md
     - Hierarchical Topic Modeling: hierarchical.md
     - Cross-Lingual Topic Modeling: cross_lingual.md
-    - Multimodal Modeling (BETA): multimodal.md
-    - Concept Induction (BETA): concept_induction.md
+    - Late Interaction Models (Experimental): late_interaction.md
+    - Multimodal Modeling (Experimental): multimodal.md
+    - Concept Induction: concept_induction.md
     - Modifying and Finetuning Models: finetuning.md
     - Saving and Loading: persistence.md
     - Using TopicData: topic_data.md
@@ -23,7 +24,7 @@ nav:
      - Discourse Analysis on Morality and Religion: tutorials/religious.md
      - Discovering a Data-driven Political Compass: tutorials/ideologies.md
      - Customer Dissatisfaction Analysis: tutorials/reviews.md
-  - Topic Models (Overview and Performance):
+  - <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
@@ -34,10 +35,10 @@ nav:
     - Clustering Models (BERTopic & Top2Vec): clustering.md
     - Autoencoding Models (ZeroShotTM & CombinedTM): ctm.md
     - FASTopic: FASTopic.md
-  - Other Models (e.g. Sentiment Analysis):
+  - <span>Other Models<span> <br> <i class="subtext">(e.g. Sentiment Analysis)</i>:
     - Concept Vector Projection (Continuous Sentiment Scoring): cvp.md
   - Embedding Models: encoders.md
-  - Vectorizers (Term extraction): vectorizers.md
+  - <span>Vectorizers<span> <br> <i class="subtext">(Term extraction)</i>: vectorizers.md
   - Topic Analysis and Naming with LLMs: analyzers.md
 theme:
   name: material
@@ -79,6 +80,9 @@ theme:
       - toc.follow
       - content.code.copy
 
+extra_css:
+  - stylesheets/extra.css
+
 plugins:
 - search
 - mkdocstrings: