refactor: structured project, internationalized code, and relocated data

Author: lifanghen-ux

.env.example

@@ -0,0 +1,94 @@
+# =============================================================================
+# THETA Environment Configuration
+# =============================================================================
+# Copy this file to .env and modify as needed.
+# All paths are relative to PROJECT_ROOT unless specified as absolute paths.
+#
+# Usage:
+#   cp .env.example .env
+#   # Edit .env with your paths
+# =============================================================================
+
+# =============================================================================
+# Core Directories (usually no need to change)
+# =============================================================================
+
+# Project root directory (auto-detected from script location)
+# Uncomment and set only if you need to override auto-detection
+# PROJECT_ROOT=/path/to/THETA
+
+# Source directory (contains models and embedding modules)
+# SRC_DIR=${PROJECT_ROOT}/src
+
+# Models module directory (topic modeling algorithms)
+# MODELS_DIR=${SRC_DIR}/models
+
+# Embedding module directory
+# EMBEDDING_DIR=${SRC_DIR}/embedding
+
+# Agent module directory
+# AGENT_DIR=${PROJECT_ROOT}/agent
+
+# =============================================================================
+# Data Directories
+# =============================================================================
+
+# Workspace directory for user data
+# WORKSPACE_DIR=${PROJECT_ROOT}/workspace
+
+# Data directory (cleaned datasets)
+# DATA_DIR=${WORKSPACE_DIR}/data
+
+# Raw data directory
+# RAW_DATA_DIR=${DATA_DIR}/raw_data
+
+# =============================================================================
+# Output Directories
+# =============================================================================
+
+# Result directory (model outputs, embeddings, BOW matrices, etc.)
+# RESULT_DIR=${PROJECT_ROOT}/result
+
+# HuggingFace cache directory
+# HF_CACHE_DIR=${PROJECT_ROOT}/hf_cache
+
+# =============================================================================
+# Model Directories
+# =============================================================================
+
+# Base directory for embedding models
+# EMBEDDING_MODELS_DIR=${PROJECT_ROOT}/embedding_models
+
+# Qwen embedding model paths (by size)
+# QWEN_MODEL_0_6B=${EMBEDDING_MODELS_DIR}/qwen3_embedding_0.6B
+# QWEN_MODEL_4B=${EMBEDDING_MODELS_DIR}/qwen3_embedding_4B
+# QWEN_MODEL_8B=${EMBEDDING_MODELS_DIR}/qwen3_embedding_8B
+
+# SBERT model path (for baseline models like CTM)
+# SBERT_MODEL_PATH=${ETM_DIR}/model/baselines/sbert/sentence-transformers/all-MiniLM-L6-v2
+
+# =============================================================================
+# Agent Configuration (for LLM-based analysis)
+# =============================================================================
+
+# OpenAI API configuration (for agent features)
+# OPENAI_API_KEY=your-api-key-here
+# OPENAI_API_BASE=https://api.openai.com/v1
+
+# Agent API server configuration
+# API_HOST=0.0.0.0
+# API_PORT=8000
+
+# =============================================================================
+# GPU Configuration
+# =============================================================================
+
+# Default GPU device ID
+# CUDA_VISIBLE_DEVICES=0
+
+# =============================================================================
+# Logging
+# =============================================================================
+
+# Log level: DEBUG, INFO, WARNING, ERROR
+# LOG_LEVEL=INFO

.github/workflows/deploy-docs.yml

@@ -0,0 +1,40 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'doc/**'
+      - 'mkdocs.yml'
+      - 'mkdocs.zh.yml'
+      - 'docs-requirements.txt'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs-requirements.txt') }}
+
+      - name: Install dependencies
+        run: pip install -r docs-requirements.txt
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1,12 @@
+.env
+__pycache__/
+*.py[cod]
+*.class
+workspace/*
+!workspace/.gitkeep
+result/*
+!result/.gitkeep
+data/*
+!data/.gitkeep
+*.log
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CodeSoul.co
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.