The LLM-based topic recognition model is complete and adapted to quickly updating Weibo topics.

LLMTopicDetection_TopicGPT/docs/source/conf.py

@@ -0,0 +1,34 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+master_doc = 'index'
+project = 'topicgpt'
+copyright = '2023, ArikReuter'
+author = 'ArikReuter'
+release = '0.0.4'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../src'))
+sys.path.insert(0, os.path.abspath('../src'))

LLMTopicDetection_TopicGPT/docs/source/index.rst

@@ -0,0 +1,22 @@
+.. topicgpt documentation master file, created by
+   sphinx-quickstart on Wed Sep  6 20:34:08 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to topicgpt's documentation!
+====================================
+
+.. include:: ../README.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   topicgpt  
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

LLMTopicDetection_TopicGPT/docs/source/modules.rst

@@ -0,0 +1,7 @@
+topicgpt
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   topicgpt

LLMTopicDetection_TopicGPT/docs/source/topicgpt.rst

@@ -0,0 +1,69 @@
+topicgpt package
+================
+
+Submodules
+----------
+
+topicgpt.Clustering module
+--------------------------
+
+.. automodule:: topicgpt.Clustering
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+topicgpt.ExtractTopWords module
+-------------------------------
+
+.. automodule:: topicgpt.ExtractTopWords
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+topicgpt.GetEmbeddingsOpenAI module
+-----------------------------------
+
+.. automodule:: topicgpt.GetEmbeddingsOpenAI
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+topicgpt.TopicGPT module
+------------------------
+
+.. automodule:: topicgpt.TopicGPT
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+topicgpt.TopicPrompting module
+------------------------------
+
+.. automodule:: topicgpt.TopicPrompting
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+topicgpt.TopicRepresentation module
+-----------------------------------
+
+.. automodule:: topicgpt.TopicRepresentation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+topicgpt.TopwordEnhancement module
+----------------------------------
+
+.. automodule:: topicgpt.TopwordEnhancement
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: topicgpt
+   :members:
+   :undoc-members:
+   :show-inheritance: