API Reference¶

This section provides detailed documentation for all the modules, classes, functions, and methods in the TSG Ecosystem.

Overview¶

The TSG Ecosystem is organized into several main modules:

Module Installation¶

Each module can be installed separately:

# Install core functionality
pip install tsgeco-core

# Install visualization module
pip install tsgeco-viz

# Install analytics module
pip install tsgeco-analytics

# Install converter utilities
pip install tsgeco-converter

# Or install everything at once
pip install tsgeco[all]

Import Structure¶

The TSG Ecosystem uses a hierarchical import structure:

# Core components
from tsgeco import TSGraph, TSSegment, TSConnection

# Submodules
from tsgeco.visualizer import TSGVisualizer, TSGDashboard
from tsgeco.analytics import basic_stats, semantic_analysis, topic_modeling
from tsgeco.converter import import_from_srt, export_to_json

API Stability¶

Our API follows Semantic Versioning:

• Stable APIs: All public classes and functions documented in this reference are considered stable within a major version.
• Experimental APIs: Some newer features may be marked as experimental with a warning in their documentation.
• Internal APIs: Functions and classes with names starting with an underscore (_) are considered internal and may change without notice.

Version Compatibility¶

Quick Links¶

• Getting Started
• Basic Usage Examples
• Advanced Features
• Contribution Guidelines