VoiceHubvad_transformers
TransformersVAD¶
Runs a caller-selected Transformers frame classifier with explicit hysteresis and frame output.
Parameter metadata: Not reported: the audited metadata available for the registered default does not provide an exact parameter total.
Resources
Usage¶
Complete the VoiceHub installation once, then run this repository-authored example. Model pages intentionally contain no package-install command.
This example is maintained against VoiceHub's public API; it is not copied from an upstream demo or package README.
Model-specific path: Runs a caller-selected Transformers frame classifier with explicit hysteresis and frame output.
Inputs and controls: The local directory must be compatible with VoiceHub's generic frame-classification adapter.
from pathlib import Path
from voicehub import AutoModelForVoiceActivityDetection
AUDIO_FILE = Path("speech.wav")
if not AUDIO_FILE.is_file():
raise FileNotFoundError(AUDIO_FILE)
model = AutoModelForVoiceActivityDetection.from_pretrained(
'checkpoints/frame-vad',
model_type='vad_transformers',
device="cpu",
lazy_load=True,
)
output = model.detect(
AUDIO_FILE,
onset=0.6,
offset=0.4,
return_frames=True,
)
for segment in output.segments:
print(segment.start, segment.end, segment.score)
Use authorized recordings. Verify hardware needs and pin a revision in production.
Overview¶
vad_transformers is a VoiceHub voice activity detection
integration. This page is generated from its registry contract.
| Property | Value |
|---|---|
| Task | Voice activity detection |
| Architecture | wav2vec2 |
| Runtime | VoiceHub-native |
| Languages | Not text-language conditioned |
| Capabilities | voice-activity-detection, frame-scores, safetensors, fine-tuning, voicehub-native, native-runtime |
| Reusable components | — |
| Normalized output | VADOutput |
Language support¶
The public VAD contract does not select a spoken language; validate checkpoint acoustic coverage on the target languages and recording conditions.
Paper and GitHub¶
- Paper: No dedicated upstream research paper is published for this integration.
- Upstream GitHub: Transformers
- VoiceHub source: VoiceHub model implementation
Configuration¶
Load configuration without constructing the model:
from voicehub import AutoConfig
config = AutoConfig.for_model('vad_transformers')
print(config.model_type)
| Property | Value |
|---|---|
| Canonical model type | vad_transformers |
| Configuration class | TransformersVADConfig |
| Architecture class | TransformersVADForVoiceActivityDetection |
Processing¶
Create the registered processor without allocating model weights:
from voicehub import AutoProcessor
processor = AutoProcessor.from_pretrained(
'checkpoints/frame-vad',
model_type='vad_transformers',
)
print(type(processor).__name__)
Inference¶
The Usage example returns VADOutput through AutoModelForVoiceActivityDetection.
Input and output contract¶
| Property | Value |
|---|---|
| Label boundary | Clip-, frame-, or segment-level labels |
| Required training inputs | — |
Use authorized audio and preserve annotation provenance. See the ASR and VAD data workflow.
Training and optimization¶
Use available_optimization_passes() to discover reversible public passes.
Unsupported runtime or hardware fails closed before mutation.
Training contract¶
| Property | Value |
|---|---|
| Support | native |
| Family | audio-classification |
| Recipe | single-phase |
| Default phase | voice_activity_detection |
| Training checkpoint | owner/model-or-local-directory |
| Native training graph | yes |
| Phase | Kind | Components | Required inputs | Loss keys |
|---|---|---|---|---|
voice_activity_detection |
objective | model |
— | loss |
The integration accepts its declared source or prepared contract directly. Call model.validate_training_support() first, then follow the
training workflow.
Checkpoints, provenance, license, and limitations¶
| Property | Value |
|---|---|
| Default checkpoint | No default; pass a compatible Hub ID or local directory. |
| Hugging Face ID | Not published / not applicable No single repository applies: this generic adapter requires the caller to choose a compatible frame-classification checkpoint or local artifact. |
| Checkpoint status | No registry default; the caller must provide a compatible reviewed frame-classification artifact |
| Optional dependency extra | Core package |
| Hardware and runtime | Usage selects cpu; verify checkpoint-specific requirements |
| Real-checkpoint evidence | Release evidence; a registry default alone is not execution evidence |
| Implementation | voicehub.models.vad_transformers.modeling_vad_transformers.TransformersVADForVoiceActivityDetection |
| Configuration | voicehub.models.vad_transformers.configuration_vad_transformers.TransformersVADConfig |
| Source provenance | No integration-specific bundled SOURCE.json is declared for this registry entry. |
| License | Checkpoint-specific |
No VoiceHub-specific license override is registered. Verify the checkpoint and upstream source terms before use.
Confirm the checkpoint revision, access terms, provenance, and license.
Limitations¶
- No integration-specific checkpoint limitation is registered. Verify the selected checkpoint revision and its documented runtime requirements.
- Validate memory, precision, and optional dependencies on the target system.
- Public optimizations fail closed when the runtime or hardware cannot satisfy their validation contract; an unavailable pass is not reported as applied.
- Contract tests do not replace the linked released-checkpoint evidence.
Public API¶
Use the stable configuration, processor, and task-model facades below.
Configuration
TransformersVADConfig¶
Parameters¶
**config_kwargs— Configuration fields validated by TransformersVADConfig.
Model
TransformersVADForVoiceActivityDetection¶
Parameters¶
pretrained_model_name_or_path— Hub ID or compatible local directory.model_type— Canonical model type; use 'vad_transformers'.config— Optional preloaded TransformersVADConfig instance.**model_kwargs— Model-specific loading arguments.
from voicehub import get_model_spec
spec = get_model_spec('vad_transformers')
print(spec.display_name, spec.task.value)
| Purpose | Public object |
|---|---|
| Discover | get_model_spec('vad_transformers') |
| Load and run | AutoModelForVoiceActivityDetection |
| Configure | TransformersVADConfig |
| Process | AutoProcessor |
| Model implementation | TransformersVADForVoiceActivityDetection |
| Normalized output | VADOutput |
| Training contract | get_training_spec('vad_transformers') |
| Optimization lifecycle | available_optimization_passes, apply_optimization_plan, optimization_manifest, restore_optimization_plan |
See all model guides, inference, and the training matrix.