Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
11unx0 authored Jun 2, 2024
1 parent c35867c commit 76c3048
Showing 1 changed file with 30 additions and 6 deletions.
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,53 @@

# Transcriptor

Transcript Youtube videos and your own video/audio files.
Transcript Youtube videos and your own video/audio files. Uses Whisper.

Developer: https://github.com/11unx0

## Installation

Install modules with python pip

```bash
cd Transcriptor/
git clone https://github.com/11unx0/Transcriptor
cd /Transcriptor
pip install -r requirements.txt
```

## Usage/Examples

You can change device with --device and also for model change use --model.

Default device is cpu and default model is medium.

```bash
python3 main.py
python3 main.py --device < cpu | cuda > --model < model >
```
You can change this line for another models of whisper.

```python
whisper_model = whisper.load_model("medium")
Example run with cpu & large-v3 model.

```bash
python3 main.py --device cpu --model large-v3
```

```bash
python3 main.py --help

usage: main.py [-h] [--device {cpu,cuda}] [--model {tiny,base,small,medium,large,large-v2,large-v3}]

Transcript Youtube videos and your own video/audio files. Uses Whisper. Developer: https://github.com/11unx0

options:
-h, --help show this help message and exit
--device {cpu,cuda} Device to run Whisper model on. Choices are "cpu" or "cuda". Default is "cpu".
--model {tiny,base,small,medium,large,large-v2,large-v3}
Choose a model for Whisper. Default is "medium". More details for models:
https://github.com/11unx0/Transcriptor
```

## Whisper models.

| Size | Parameters | English-only | Multilingual |
|----------|------------|------------------------------------------------------|-----------------------------------------------------|
| tiny | 39 M | [](https://huggingface.co/openai/whisper-tiny.en) | [](https://huggingface.co/openai/whisper-tiny) |
Expand Down

0 comments on commit 76c3048

Please sign in to comment.