harald/wyoming-whisper-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a quick entrypoint to the root docs

Browse source
This commit is contained in:
Niko 2025-08-13 01:42:49 -07:00
parent 68fabfc95d
commit 96bbf7b89b
No known key found for this signature in database
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/lib.rs
View file

@ -1,6 +1,11 @@
#![allow(clippy::uninlined_format_args)] #![allow(clippy::uninlined_format_args)]
#![cfg_attr(test, feature(test))] #![cfg_attr(test, feature(test))]
//! Most users will be looking for nothing more than [`WhisperState::full`] to run a full transcription pipeline.
//!
//! You can get a [`WhisperState`] by first creating a [`WhisperContext`] using [`WhisperContext::new_with_params`],
//! and then calling [`WhisperContext::create_state`].
#[cfg(feature = "vulkan")] #[cfg(feature = "vulkan")]
pub mod vulkan; pub mod vulkan;