add LICENSE and README.md

This commit is contained in:
0/0 2022-10-09 20:46:14 -06:00
parent e12122a6ed
commit 41d674e7bd
No known key found for this signature in database
GPG key ID: DE8D5010C0AAA3DC
2 changed files with 65 additions and 0 deletions

41
README.md Normal file
View file

@ -0,0 +1,41 @@
# whisper-rs
Rust bindings to [whisper.cpp](https://github.com/ggerganov/whisper.cpp/)
## Usage
```rust
fn main() {
// load a context and model
let mut ctx = WhisperContext::new("path/to/model").expect("failed to load model");
// create a params object
let mut params = FullParams::new(DecodeStrategy::Greedy { n_past: 0 });
// assume we have a buffer of audio data
// here we'll make a fake one, floating point samples, 32 bit, 16KHz, mono
let audio_data = vec![0_f32; 16000 * 2];
// now we can run the model
ctx.full(params, &audio_data[..])
.expect("failed to run model");
// fetch the results
let num_segments = ctx.full_n_segments();
for i in 0..num_segments {
let segment = ctx.full_get_segment_text(i).expect("failed to get segment");
let start_timestamp = ctx.full_get_segment_t0(i);
let end_timestamp = ctx.full_get_segment_t1(i);
println!("[{} - {}]: {}", start_timestamp, end_timestamp, segment);
}
}
```
See [examples/basic_use.rs](examples/basic_use.rs) for more details.
Lower level bindings are exposed if needed, but the above should be enough for most use cases.
See the docs: https://docs.rs/whisper-rs/ for more details.
## License
[Unlicense](LICENSE)
tl;dr: public domain