lattifai 0.1.5__py3-none-any.whl → 0.2.2__py3-none-any.whl

lattifai-0.1.5.dist-info/METADATA

@@ -1,444 +0,0 @@
-Metadata-Version: 2.4
-Name: lattifai
-Version: 0.1.5
-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/README.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.md
-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
-Requires-Dist: pysubs2
-Requires-Dist: praatio
-Requires-Dist: tgt
-Requires-Dist: onnxruntime
-Requires-Dist: resampy
-Requires-Dist: g2p-phonemizer>=0.1.1
-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
-
-<!-- <p align="center">
-  <a href="https://badge.fury.io/py/lattifai"><img src="https://badge.fury.io/py/lattifai.svg" alt="PyPI version"></a>
-</p> -->
-
-[![PyPI version](https://badge.fury.io/py/lattifai.svg)](https://badge.fury.io/py/lattifai)
-
-<p align="center">
-   &nbsp&nbsp 🖥️ <a href="https://github.com/lattifai/lattifai-python">GitHub</a> &nbsp&nbsp  | &nbsp&nbsp🤗 <a href="https://huggingface.co/Lattifai/Lattice-1-Alpha">Lattifai/Lattice-1-Alpha</a>&nbsp&nbsp | &nbsp&nbsp 📑 <a href="https://lattifai.com/blogs">Blog</a> &nbsp&nbsp |  &nbsp&nbsp <a href="https://discord.gg/gTZqdaBJ"><img src="https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white" alt="Discord" style="vertical-align: middle;"></a>&nbsp&nbsp
-</p>
-
-The official Python library for the LattifAI API - Advanced forced alignment and subtitle generation powered by `[Lattifai/Lattice-1-Alpha](https://huggingface.co/Lattifai/Lattice-1-Alpha)` model.
-
-## Installation
-
-```bash
-pip install lattifai
-
-install-k2  # Required: This step must be executed to install k2 dependencies
-```
-
-> **⚠️ Important**: After installing `lattifai`, you **must** run `install-k2` to install the required k2 library. The library will not function properly without this step.
-
-## GPU Support Status
-
-> **🚧 GPU Support Coming Soon**: The current version supports CPU-only processing. NVIDIA GPU and Apple Silicon acceleration will be available in an upcoming release, providing significant performance improvements for large audio files.
-
-## Quick Start
-
-### Command Line Interface
-
-The library provides powerful command-line tools for batch processing and automation.
-
-#### 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
-```
-
-### 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
-    model_name_or_path='Lattifai/Lattice-1-Alpha',
-    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}")
-```
-
-
-#### 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)
-    device: str = 'cpu',                     # Device for processing (currently only 'cpu' supported)
-)
-```
-
-> **Note**: The `device` parameter currently only supports `'cpu'`. GPU support 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
-
-## Configuration
-
-### Environment Variables
-
-- `LATTIFAI_API_KEY`: Your LattifAI API key (required)
-
-### Performance Tuning
-
-For better performance with large files:
-
-```python
-client = LattifAI(
-    device='cpu',         # Currently only CPU is supported, cuda/mps will be supported in upcoming releases.
-)
-```
-
-> **GPU Acceleration**: CUDA and Apple Silicon(MPS) 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](https://huggingface.co/Lattifai/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)
-  - k2 (audio computation)
-  - 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/ scripts/
-
-# Run linter
-ruff check src/ tests/ scripts/
-
-# Run formatter
-ruff format src/ tests/ scripts/
-
-# Fix issues automatically
-ruff check --fix src/ tests/ scripts/
-```
-
-### Running Tests
-
-```bash
-# Install test dependencies first
-pip install -e ".[test]"
-
-# 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/README.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.md)

lattifai-0.1.5.dist-info/RECORD

@@ -1,24 +0,0 @@
-lattifai/__init__.py,sha256=wPE3D03AK8Ktu2WFXqJ6rx6jvPVWKstFQgyPq0tndUU,2324
-lattifai/base_client.py,sha256=ktFtATjL9pLSJUD-VqeJKA1FHkrsGHX7Uq_x00H7gO8,3322
-lattifai/client.py,sha256=p9mFkyOINKBGB87TE6P4y6Z3fPOPSqi6HAyz00TMuag,4520
-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=SfRi1KIMpmaao6OVmR1h_I_3QU-vrE6D5bh72Afg5XM,1759
-lattifai/tokenizers/tokenizer.py,sha256=u4lgS6-jN9cLuMNIojA4Swfsqb1EcyI7Bh_iw7tuL-s,5818
-lattifai/workers/__init__.py,sha256=s6YfkIq4FDIAzY9sPjRpXnJfszj2repqnMTqydRM5Zw,83
-lattifai/workers/lattice1_alpha.py,sha256=5OJ6APnFpWvi1azKlkbJqF85e2n5JyZ_m8L1XQ2r3qg,4862
-lattifai-0.1.5.dist-info/licenses/LICENSE,sha256=LNuoH5jpXXNKgjQ3XLwztFq8D3O7kZI-LSg81o4ym2M,1065
-scripts/__init__.py,sha256=4nwVNeJeEuGiWGBACgySViLlm5DrqcvFOWpo7Ds8MUA,49
-scripts/install_k2.py,sha256=iGdy_VZrwaBJfdKy5EDvPX0x5V4dH_lm3f8DEiVWcOQ,21166
-lattifai-0.1.5.dist-info/METADATA,sha256=LsJCRZPTmnuF279cKjO6jtK1ZzG8JrL0sEnOfjvoNxk,13644
-lattifai-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-lattifai-0.1.5.dist-info/entry_points.txt,sha256=CwTI2NbJvF9msIHboAfTA99cmDr_HOWoODjS8R64JOw,131
-lattifai-0.1.5.dist-info/top_level.txt,sha256=-OVWZ68YYFcTN13ARkLasp2OUappe9wEVq-CKes7jM4,17
-lattifai-0.1.5.dist-info/RECORD,,

scripts/__init__.py

@@ -1 +0,0 @@
-"""Scripts for lattifai package installation."""