# cjm-transcription-plugin-voxtral-hf
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Install
``` bash
pip install cjm_transcription_plugin_voxtral_hf
```
## Project Structure
nbs/
└── plugin.ipynb # Plugin implementation for Mistral Voxtral transcription through Hugging Face Transformers
Total: 1 notebook
## Module Dependencies
``` mermaid
graph LR
plugin[plugin<br/>Voxtral HF Plugin]
```
No cross-module dependencies detected.
## CLI Reference
No CLI commands found in this project.
## Module Overview
Detailed documentation for each module in the project:
### Voxtral HF Plugin (`plugin.ipynb`)
> Plugin implementation for Mistral Voxtral transcription through
> Hugging Face Transformers
#### Import
``` python
from cjm_transcription_plugin_voxtral_hf.plugin import (
VoxtralHFPlugin
)
```
#### Functions
``` python
@patch
def supports_streaming(
self:VoxtralHFPlugin
) -> bool
"Check if this plugin supports streaming transcription."
```
``` python
@patch
def execute_stream(
self:VoxtralHFPlugin,
audio: Union[AudioData, str, Path], # Audio data or path to audio file
**kwargs # Additional plugin-specific parameters
) -> Generator[str, None, TranscriptionResult]: # Yields text chunks, returns final result
"Stream transcription results chunk by chunk."
```
#### Classes
``` python
class VoxtralHFPlugin:
def __init__(self):
"""Initialize the Voxtral HF plugin with default configuration."""
self.logger = logging.getLogger(f"{__name__}.{type(self).__name__}")
self.config = {}
self.model = None
self.processor = None
self.device = None
self.dtype = None
@property
def name(
self
) -> str: # Returns the plugin name
"Mistral Voxtral transcription plugin via Hugging Face Transformers."
def __init__(self):
"""Initialize the Voxtral HF plugin with default configuration."""
self.logger = logging.getLogger(f"{__name__}.{type(self).__name__}")
self.config = {}
self.model = None
self.processor = None
self.device = None
self.dtype = None
@property
def name(
self
) -> str: # Returns the plugin name
"Initialize the Voxtral HF plugin with default configuration."
def name(
self
) -> str: # Returns the plugin name
"Get the plugin name identifier."
def version(
self
) -> str: # Returns the plugin version
"Get the plugin version string."
def supported_formats(
self
) -> List[str]: # Returns list of supported audio formats
"Get the list of supported audio file formats."
def get_config_schema(
) -> Dict[str, Any]: # Returns the configuration schema dictionary
"Return configuration schema for Voxtral HF."
def get_current_config(
self
) -> Dict[str, Any]: # Returns the current configuration dictionary
"Return current configuration."
def initialize(
self,
config: Optional[Dict[str, Any]] = None # Configuration dictionary to initialize the plugin
) -> None
"Initialize the plugin with configuration."
def execute(
self,
audio: Union[AudioData, str, Path], # Audio data or path to audio file to transcribe
**kwargs # Additional arguments to override config
) -> TranscriptionResult: # Returns transcription result with text and metadata
"Transcribe audio using Voxtral."
def is_available(
self
) -> bool: # Returns True if Voxtral and its dependencies are available
"Check if Voxtral is available."
def cleanup(
self
) -> None
"Clean up resources with aggressive memory management."
```
Raw data
{
"_id": null,
"home_page": "https://github.com/cj-mills/cjm-transcription-plugin-voxtral-hf",
"name": "cjm-transcription-plugin-voxtral-hf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "Christian J. Mills",
"author_email": "9126128+cj-mills@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/1d/8c/14159953ff926d882055af7e008680ddbfdfe8a795876b77874af9d2d1eb/cjm_transcription_plugin_voxtral_hf-0.0.6.tar.gz",
"platform": null,
"description": "# cjm-transcription-plugin-voxtral-hf\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Install\n\n``` bash\npip install cjm_transcription_plugin_voxtral_hf\n```\n\n## Project Structure\n\n nbs/\n \u2514\u2500\u2500 plugin.ipynb # Plugin implementation for Mistral Voxtral transcription through Hugging Face Transformers\n\nTotal: 1 notebook\n\n## Module Dependencies\n\n``` mermaid\ngraph LR\n plugin[plugin<br/>Voxtral HF Plugin]\n```\n\nNo cross-module dependencies detected.\n\n## CLI Reference\n\nNo CLI commands found in this project.\n\n## Module Overview\n\nDetailed documentation for each module in the project:\n\n### Voxtral HF Plugin (`plugin.ipynb`)\n\n> Plugin implementation for Mistral Voxtral transcription through\n> Hugging Face Transformers\n\n#### Import\n\n``` python\nfrom cjm_transcription_plugin_voxtral_hf.plugin import (\n VoxtralHFPlugin\n)\n```\n\n#### Functions\n\n``` python\n@patch\ndef supports_streaming(\n self:VoxtralHFPlugin\n) -> bool\n \"Check if this plugin supports streaming transcription.\"\n```\n\n``` python\n@patch\ndef execute_stream(\n self:VoxtralHFPlugin,\n audio: Union[AudioData, str, Path], # Audio data or path to audio file\n **kwargs # Additional plugin-specific parameters\n) -> Generator[str, None, TranscriptionResult]: # Yields text chunks, returns final result\n \"Stream transcription results chunk by chunk.\"\n```\n\n#### Classes\n\n``` python\nclass VoxtralHFPlugin:\n def __init__(self):\n \"\"\"Initialize the Voxtral HF plugin with default configuration.\"\"\"\n self.logger = logging.getLogger(f\"{__name__}.{type(self).__name__}\")\n self.config = {}\n self.model = None\n self.processor = None\n self.device = None\n self.dtype = None\n \n @property\n def name(\n self\n ) -> str: # Returns the plugin name\n \"Mistral Voxtral transcription plugin via Hugging Face Transformers.\"\n \n def __init__(self):\n \"\"\"Initialize the Voxtral HF plugin with default configuration.\"\"\"\n self.logger = logging.getLogger(f\"{__name__}.{type(self).__name__}\")\n self.config = {}\n self.model = None\n self.processor = None\n self.device = None\n self.dtype = None\n \n @property\n def name(\n self\n ) -> str: # Returns the plugin name\n \"Initialize the Voxtral HF plugin with default configuration.\"\n \n def name(\n self\n ) -> str: # Returns the plugin name\n \"Get the plugin name identifier.\"\n \n def version(\n self\n ) -> str: # Returns the plugin version\n \"Get the plugin version string.\"\n \n def supported_formats(\n self\n ) -> List[str]: # Returns list of supported audio formats\n \"Get the list of supported audio file formats.\"\n \n def get_config_schema(\n ) -> Dict[str, Any]: # Returns the configuration schema dictionary\n \"Return configuration schema for Voxtral HF.\"\n \n def get_current_config(\n self\n ) -> Dict[str, Any]: # Returns the current configuration dictionary\n \"Return current configuration.\"\n \n def initialize(\n self,\n config: Optional[Dict[str, Any]] = None # Configuration dictionary to initialize the plugin\n ) -> None\n \"Initialize the plugin with configuration.\"\n \n def execute(\n self,\n audio: Union[AudioData, str, Path], # Audio data or path to audio file to transcribe\n **kwargs # Additional arguments to override config\n ) -> TranscriptionResult: # Returns transcription result with text and metadata\n \"Transcribe audio using Voxtral.\"\n \n def is_available(\n self\n ) -> bool: # Returns True if Voxtral and its dependencies are available\n \"Check if Voxtral is available.\"\n \n def cleanup(\n self\n ) -> None\n \"Clean up resources with aggressive memory management.\"\n```\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Mistral Voxtral plugin for the cjm-transcription-plugin-system library - provides local speech-to-text transcription through \ud83e\udd17 Transformers with configurable model selection and parameter control.",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/cj-mills/cjm-transcription-plugin-voxtral-hf"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3841f97bdbf20ebd2c823b2908b0b21a1e30624df5075d3be578228a77170dfa",
"md5": "bf982b4ef1294b8289c98c5d965db992",
"sha256": "9ad8321a43d263b441ad0d30d83537af6809e90053c3fb2af4efda6d1783f45f"
},
"downloads": -1,
"filename": "cjm_transcription_plugin_voxtral_hf-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf982b4ef1294b8289c98c5d965db992",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 13945,
"upload_time": "2025-10-25T00:48:44",
"upload_time_iso_8601": "2025-10-25T00:48:44.731698Z",
"url": "https://files.pythonhosted.org/packages/38/41/f97bdbf20ebd2c823b2908b0b21a1e30624df5075d3be578228a77170dfa/cjm_transcription_plugin_voxtral_hf-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1d8c14159953ff926d882055af7e008680ddbfdfe8a795876b77874af9d2d1eb",
"md5": "26b9bfe089482bfb2192166ca0df2c38",
"sha256": "9a15857ec65a8f99013afcfcea2fd27032289c7b39b2232289d9e174d8e1fb81"
},
"downloads": -1,
"filename": "cjm_transcription_plugin_voxtral_hf-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "26b9bfe089482bfb2192166ca0df2c38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 14559,
"upload_time": "2025-10-25T00:48:45",
"upload_time_iso_8601": "2025-10-25T00:48:45.946476Z",
"url": "https://files.pythonhosted.org/packages/1d/8c/14159953ff926d882055af7e008680ddbfdfe8a795876b77874af9d2d1eb/cjm_transcription_plugin_voxtral_hf-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-25 00:48:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cj-mills",
"github_project": "cjm-transcription-plugin-voxtral-hf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cjm-transcription-plugin-voxtral-hf"
}
JSON
