lattifai 0.1.4__py3-none-any.whl

lattifai-0.1.4.dist-info/METADATA

@@ -0,0 +1,467 @@
+Metadata-Version: 2.4
+Name: lattifai
+Version: 0.1.4
+Summary: Lattifai Python SDK: Seamless Integration with Lattifai's Speech and Video AI Services
+Author-email: Lattifai Technologies <tech@lattifai.com>
+Maintainer-email: Lattice <tech@lattifai.com>
+License: MIT License
+        
+        Copyright (c) 2025 Lattifai.
+        
+        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.
+Project-URL: Homepage, https://github.com/lattifai/lattifai-python
+Project-URL: Documentation, https://github.com/lattifai/lattifai-python/api.md
+Project-URL: Bug Tracker, https://github.com/lattifai/lattifai-python/issues
+Project-URL: Discussions, https://github.com/lattifai/lattifai-python/discussions
+Project-URL: Changelog, https://github.com/lattifai/lattifai-python/CHANGELOG
+Keywords: lattifai,speech recognition,video analysis,ai,sdk,api client
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx
+Requires-Dist: python-dotenv
+Requires-Dist: lhotse>=1.26.0
+Requires-Dist: colorful>=0.5.6
+Requires-Dist: lattifai-core>=0.1.4
+Provides-Extra: numpy
+Requires-Dist: numpy; extra == "numpy"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Requires-Dist: numpy; extra == "test"
+Provides-Extra: all
+Requires-Dist: numpy; extra == "all"
+Requires-Dist: pytest; extra == "all"
+Requires-Dist: pytest-cov; extra == "all"
+Requires-Dist: ruff; extra == "all"
+Dynamic: license-file
+
+# LattifAI Python
+
+> ⚠️ **Under Active Development** - Official release scheduled for October 18, 2025
+
+[![PyPI version](https://badge.fury.io/py/lattifai.svg)](https://badge.fury.io/py/lattifai)
+
+The official Python library for the LattifAI API - Advanced forced alignment and subtitle generation powered by `Lattice-1-Alpha` model.
+
+## Installation
+
+```bash
+pip install lattifai
+```
+
+## GPU Support Status
+
+> **🚧 GPU Support Coming Soon**: CUDA/GPU acceleration is currently under active development. The current version supports CPU-only processing. GPU support will be available in an upcoming release, providing significant performance improvements for large audio files.
+
+## Quick Start
+
+### Python API
+
+```python
+import os
+from lattifai import LattifAI
+
+# Initialize client
+client = LattifAI(
+    api_key=os.environ.get("LATTIFAI_API_KEY"),  # Optional if set in environment
+    device='cpu',  # Currently only CPU is supported, GPU support coming soon
+)
+
+# Perform alignment
+result = client.alignment(
+    audio="path/to/audio.wav",
+    subtitle="path/to/subtitle.srt",  # or .txt, .vtt, .ass
+    format="srt",  # auto-detect if not specified
+    output_subtitle_path="output.srt"
+)
+
+print(f"Alignment complete! Output saved to: {result}")
+```
+
+### Command Line Interface
+
+The library provides powerful command-line tools for batch processing and automation.
+
+#### Basic Alignment
+
+```bash
+# Align audio with subtitle file
+lattifai-align input_audio.wav input_subtitle.srt output_aligned.srt
+
+# Specify input format explicitly
+lattifai-align -F srt input_audio.wav transcript.txt output.srt
+
+# Auto-detect input format (default)
+lattifai-align input_audio.wav subtitle_file.vtt output.vtt
+```
+
+#### Using the Main CLI
+
+```bash
+# Show available commands
+lattifai --help
+
+# Perform alignment (same as lattifai-align)
+lattifai align input_audio.wav input_subtitle.srt output.srt
+
+# Subtitle format conversion
+lattifai subtitle convert input.srt output.vtt
+```
+
+#### Supported Input Formats
+
+- **SRT**: SubRip Subtitle format (`.srt`)
+- **VTT**: WebVTT format (`.vtt`)
+- **ASS**: Advanced SubStation Alpha format (`.ass`)
+- **TXT**: Plain text format (`.txt`)
+- **AUTO**: Automatic format detection (default)
+
+#### Command Line Options
+
+- `-F, --input_format`: Specify input subtitle format (`srt`, `vtt`, `ass`, `txt`, `auto`)
+- `--help`: Show help message and available options
+
+## API Reference
+
+### LattifAI Class
+
+#### Constructor Parameters
+
+```python
+LattifAI(
+    api_key: Optional[str] = None,           # API key (or set LATTIFAI_API_KEY env var)
+    base_url: Optional[str] = None,          # API base URL (or set LATTIFAI_BASE_URL env var)
+    device: str = 'cpu',                     # Device for processing (currently only 'cpu' supported)
+)
+```
+
+> **Note**: The `device` parameter currently only supports `'cpu'`. GPU support (`'cuda'`) is under active development and will be available in future releases.
+
+#### Methods
+
+##### `alignment()`
+
+Perform forced alignment between audio and text/subtitles.
+
+```python
+def alignment(
+    audio: Pathlike,                         # Path to audio file
+    subtitle: Pathlike,                      # Path to subtitle/text file
+    format: Optional[SubtitleFormat] = None, # Input format (auto-detect if None)
+    output_subtitle_path: Optional[Pathlike] = None  # Output file path
+) -> str:
+```
+
+**Parameters:**
+- `audio`: Path to the audio file (WAV, MP3, etc.)
+- `subtitle`: Path to subtitle or text file
+- `format`: Input format (`'srt'`, `'vtt'`, `'ass'`, `'txt'`, or `None` for auto-detection)
+- `output_subtitle_path`: Path where aligned subtitle will be saved
+
+**Returns:**
+- Path to output file (if `output_subtitle_path` specified) or alignment results
+
+**Example:**
+```python
+# Basic usage
+result = client.alignment("audio.wav", "subtitle.srt")
+
+# With explicit format and output path
+result = client.alignment(
+    audio="interview.mp3",
+    subtitle="transcript.txt",
+    format="txt",
+    output_subtitle_path="aligned_interview.srt"
+)
+```
+
+
+## Configuration
+
+### Environment Variables
+
+- `LATTIFAI_API_KEY`: Your LattifAI API key (required)
+- `LATTIFAI_BASE_URL`: Base URL for the API (default: `https://api.lattifai.com/v1`)
+
+### Device Configuration
+
+> **Note**: GPU/CUDA support is currently under development and will be available in a future release. Currently, only CPU processing is supported.
+
+The library is designed to support both CPU and GPU processing:
+
+```python
+# CPU processing (currently supported)
+client = LattifAI(device='cpu')
+
+# GPU processing (coming soon)
+# client = LattifAI(device='cuda')  # Will be available in future releases
+```
+
+### Performance Tuning
+
+For better performance with large files:
+
+```python
+client = LattifAI(
+    device='cpu',         # Currently only CPU is supported
+)
+```
+
+> **GPU Acceleration**: CUDA support is in active development and will significantly improve processing speed for large audio files. Expected in upcoming releases.
+
+## Examples
+
+### Basic Text Alignment
+
+```python
+from lattifai import LattifAI
+
+client = LattifAI()
+
+# Align plain text with audio
+result = client.alignment(
+    audio="speech.wav",
+    subtitle="Hello world. This is a test.",
+    format="txt",
+    output_subtitle_path="aligned.srt"
+)
+```
+
+### Subtitle Refinement
+
+```python
+# Improve existing subtitle timing
+result = client.alignment(
+    audio="movie.mp4",
+    subtitle="rough_subtitles.srt",
+    output_subtitle_path="precise_subtitles.srt"
+)
+```
+
+### Batch Processing
+
+```python
+import os
+from pathlib import Path
+
+client = LattifAI()
+
+# Process multiple files
+audio_dir = Path("audio_files")
+subtitle_dir = Path("subtitles")
+output_dir = Path("aligned_output")
+
+for audio_file in audio_dir.glob("*.wav"):
+    subtitle_file = subtitle_dir / f"{audio_file.stem}.srt"
+    output_file = output_dir / f"{audio_file.stem}_aligned.srt"
+
+    if subtitle_file.exists():
+        client.alignment(
+            audio=audio_file,
+            subtitle=subtitle_file,
+            output_subtitle_path=output_file
+        )
+```
+
+## Supported Formats
+
+### Audio Formats
+- **WAV**: Recommended for best quality
+- **MP3**: Widely supported compressed format
+- **FLAC**: Lossless compression
+- **M4A**: Apple audio format
+- **OGG**: Open source audio format
+
+### Subtitle Formats
+- **SRT**: SubRip Subtitle format (most common)
+- **VTT**: WebVTT format (web standard)
+- **ASS**: Advanced SubStation Alpha format (advanced styling)
+- **TXT**: Plain text format (one sentence per line)
+
+## Error Handling
+
+```python
+from lattifai import LattifAI, LattifAIError
+
+try:
+    client = LattifAI()
+    result = client.alignment(
+        audio="audio.wav",
+        subtitle="subtitle.srt"
+    )
+except LattifAIError as e:
+    print(f"LattifAI error: {e}")
+except FileNotFoundError as e:
+    print(f"File not found: {e}")
+except Exception as e:
+    print(f"Unexpected error: {e}")
+```
+
+### Common Error Scenarios
+
+- **Missing API Key**: Set `LATTIFAI_API_KEY` environment variable
+- **File Not Found**: Verify input file paths exist
+- **Unsupported Format**: Check supported audio/subtitle formats
+- **Network Issues**: Check internet connection and API endpoint
+- **Device Configuration**: Currently only `device='cpu'` is supported (GPU support coming soon)
+
+## Model Information
+
+This library uses the **Lattice-1-Alpha** model for high-quality forced alignment and subtitle generation.
+
+### Model Features
+- **High Accuracy**: State-of-the-art alignment precision
+- **Multi-language Support**: Supports various languages and accents
+- **Robust Processing**: Handles noisy audio and imperfect transcripts
+- **Fast Processing**: Optimized for both CPU and GPU execution
+
+### Model Requirements
+- **Minimum Python**: 3.9+
+- **Memory**: 4GB RAM recommended
+- **Storage**: ~2GB for model files
+- **GPU**: CUDA support coming soon (currently CPU-only)
+
+## Requirements
+
+- **Python**: 3.9-3.13
+- **Core Dependencies**:
+  - httpx (HTTP client)
+  - lhotse (audio processing)
+  - colorful (colored output)
+  - python-dotenv (environment management)
+  - click (command line interface)
+
+## Development
+
+### Setting Up Development Environment
+
+1. **Clone the repository:**
+```bash
+git clone https://github.com/lattifai/lattifai-python.git
+cd lattifai-python
+```
+
+2. **Install development dependencies:**
+```bash
+pip install -e ".[test]"
+```
+
+3. **Install Git hooks (recommended):**
+```bash
+./scripts/install-hooks.sh
+```
+
+This will install pre-commit hooks that automatically run `isort` and `ruff` checks before each commit to ensure code quality.
+
+### Code Quality Tools
+
+We use the following tools to maintain code quality:
+
+- **isort**: Automatically sorts and organizes imports
+- **ruff**: Fast Python linter and formatter
+
+To manually run these tools:
+
+```bash
+# Sort imports
+isort src/ tests/
+
+# Run linter
+ruff check src/ tests/
+
+# Run formatter
+ruff format src/ tests/
+
+# Fix issues automatically
+ruff check --fix src/ tests/
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=src --cov-report=html
+
+# Run specific test file
+pytest tests/test_basic.py -v
+```
+
+### Building and Testing Locally
+
+```bash
+# Build package
+python -m build
+
+# Install locally
+pip install -e .
+
+# Test CLI commands
+lattifai --help
+lattifai-align --help
+```
+
+### Contributing
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature-name`
+3. Make your changes and add tests
+4. Run the test suite: `pytest`
+5. Run code quality checks: `ruff check src/ tests/`
+6. Commit your changes: `git commit -am 'Add some feature'`
+7. Push to the branch: `git push origin feature-name`
+8. Submit a pull request
+
+### Bypassing Pre-commit Hooks
+
+If you need to commit without running the hooks (not recommended):
+
+```bash
+git commit --no-verify
+```
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+- **Documentation**: [API Documentation](https://github.com/lattifai/lattifai-python/api.md)
+- **Issues**: [GitHub Issues](https://github.com/lattifai/lattifai-python/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/lattifai/lattifai-python/discussions)
+- **Changelog**: [CHANGELOG.md](https://github.com/lattifai/lattifai-python/CHANGELOG)

lattifai-0.1.4.dist-info/RECORD

@@ -0,0 +1,22 @@
+lattifai/__init__.py,sha256=8vZF9_yObaoDZ6sUaJBuQqUp5mGBRfD4z0SdTY_8BcQ,672
+lattifai/base_client.py,sha256=ktFtATjL9pLSJUD-VqeJKA1FHkrsGHX7Uq_x00H7gO8,3322
+lattifai/client.py,sha256=szz9aT_GTa5JKA2ZGsd7XHr56aG_H-nf83yqRcPUVxs,4664
+lattifai/bin/__init__.py,sha256=7YhmtEM8kbxJtz2-KIskvpLKBZAvkMSceVx8z4fkgQ4,61
+lattifai/bin/align.py,sha256=uX8VaATzn8CgdHUtry1ZGhXiz0Jr89ELdfRK6GWC1t8,989
+lattifai/bin/cli_base.py,sha256=4xlN4cnJZh54ErhHUHgJpyVsrcB-ftwniFzRQL_7SlU,289
+lattifai/bin/subtitle.py,sha256=bUWImAHpvyY59Vskqb5loQiD5ytQOxR8lTQRiQ4LyNA,647
+lattifai/io/__init__.py,sha256=vHWRN7MvAch-GUeFqqO-gM57SM-4YOpGUjIxFJdjfPA,671
+lattifai/io/reader.py,sha256=ErPnPMUvYQpjZ7Vd86EsHUkOcEfKdoI8iM3yKHRzSOQ,2576
+lattifai/io/supervision.py,sha256=5UfSsgBhXoDU3-6drDtoD7y8HIiA4xRKZnbOKgeejwM,354
+lattifai/io/writer.py,sha256=1eAEFLlL8kricxRDPFBtVmeC4IiFyFnjbWXvw0VU-q4,2036
+lattifai/tokenizers/__init__.py,sha256=aqv44PDtq6g3oFFKW_l4HSR5ywT5W8eP1dHHywIvBfs,72
+lattifai/tokenizers/phonemizer.py,sha256=Q5Z-4rbT3AjAPLNPnyvWGcEaJuKXRudgeIK6tUhVsJs,1741
+lattifai/tokenizers/tokenizer.py,sha256=Qqg12zihl192Tlax6plVyxthrnzBciGLSRuzFQRgOdc,5663
+lattifai/workers/__init__.py,sha256=s6YfkIq4FDIAzY9sPjRpXnJfszj2repqnMTqydRM5Zw,83
+lattifai/workers/lattice1_alpha.py,sha256=kR5wNLMn1qN14PvRA6RlWjQUGblYrJ636ILC-XkvS0s,4770
+lattifai-0.1.4.dist-info/licenses/LICENSE,sha256=LNuoH5jpXXNKgjQ3XLwztFq8D3O7kZI-LSg81o4ym2M,1065
+lattifai-0.1.4.dist-info/METADATA,sha256=HEsoKRRfjRoeNwUff7Cx44sYP9trid_bdtX3j5WqK6o,13628
+lattifai-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+lattifai-0.1.4.dist-info/entry_points.txt,sha256=BaixG8HYzE3Ff0QDAmsbX8cjsxZSLwUv5u4cnIpunr0,88
+lattifai-0.1.4.dist-info/top_level.txt,sha256=tHSoXF26r-IGfbIP_JoYATqbmf14h5NrnNJGH4j5reI,9
+lattifai-0.1.4.dist-info/RECORD,,

lattifai-0.1.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

lattifai-0.1.4.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+lattifai = lattifai.bin:cli
+lattifai-align = lattifai.bin.align:align

lattifai-0.1.4.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lattifai.
+
+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.

lattifai-0.1.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+lattifai