Skip to content

Commit eca8a99

Browse files
Noah-JaffeNoah-Jaffe
committed
update formatting and cuda instructions
1 parent 4867fbb commit eca8a99

File tree

1 file changed

+62
-62
lines changed

1 file changed

+62
-62
lines changed

‎README.md‎

Lines changed: 62 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@
7979
1. **CUDA**
8080
- If you can, use CUDA to increase performance when running the AI.
8181
- __NOTE: You will probably need a NVIDIA GPU for this.__
82-
- See here to install: [https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/)
82+
- [Install CUDA](https://docs.nvidia.com/cuda/cuda-quick-start-guide/)
83+
- If this sounds like gibberish to you, it is safe to skip this step. Your AI models will run off of just your CPU.
8384

8485
1. **Python's tkinter** needs to be installed
8586
- If you installed python with the installer and selected the tk/tcl and IDLE options, you should have this step completed already.
@@ -96,67 +97,66 @@
9697
![Follow these steps](docs/readme_add_symlinks.png)
9798

9899
1. **The Transcriber**:
99-
- Now that you have all of the requirements installed we will install the Transcriber from git
100-
1. Open your choice terminal window
101-
- Reccomended to use `Powershell` or `git bash` on windows, use default terminal on Mac/linux
102-
1. use "cd" to change directory to where you want to install the transcriber
103-
example: to your Documents folder:
104-
`cd ~/Documents`
105-
1. Clone the Transcriber repo:
106-
`git clone https://github.com/Noah-Jaffe/Transcriber.git`
107-
_NOTE: If you get the error: `fatal: destination path 'Transcriber' already exists and is not an empty directory.`, you will need to either delete the existing Transcriber folder, or rename the existing one. Or install to a custom directory by replacing NEW_FOLDER_NAME in the following command: `git clone https://github.com/Noah-Jaffe/Transcriber.git NEW_FOLDER_NAME`._
108-
1. Enter the Transcriber directory in the terminal
109-
`cd Transcriber` or `cd ~/Documents/Transcriber`
110-
1. Setup a python virtual environment if you want, skip this step if you are unfamiliar.
111-
`python -m venv .venv`
112-
- <a id="start-activate-venv"></a>Start/Activate your virtual python environment with
113-
- Windows
114-
- Powershell `./.venv/Scripts/activate`
115-
- git bash `source ./.venv/Scripts/activate`
116-
- MacOS/Linux
117-
- `source ./.venv/bin/activate`
118-
119-
1. <a id="pip install"></a>`pip install -r requirements.txt`
120-
- if the pip install fails try `pip install -r explicit_requirements.txt --no-cache`
121-
- if that fails, [report the issue to the maintainer or your point of contact](https://github.com/Noah-Jaffe/Transcriber/issues)
122-
- The only requirements not in the txt files are `torch` `torchaudio` and `torchvision`
123-
1. Install requirements not in requirements.txt
124-
125-
- If you have a CUDA compatible GPU:
126-
- [Install CUDA](https://docs.nvidia.com/cuda/cuda-quick-start-guide/) if you have not done so already.
127-
- You may need to `pip uninstall torch torchaudio torchvision` before doing this next step.
128-
- [Reinstall `torch` `torchaudio` and `torchvision` with your appropriate build](https://pytorch.org/get-started/locally/)
129-
- Example for if you have a CUDA compatible device for 12.6 you would run: `pip install torch torchvision torchaudio --no-cache -U --index-url https://download.pytorch.org/whl/cu126`
130-
- Otherwise if you dont have a CUDA compatible GPU or dont know what that means then run the next line:
131-
- `pip install torch torchaudio torchvision`
132-
1. Put your [Huggingface token](https://huggingface.co/docs/hub/en/security-tokens) in a file named `.hftoken`.
133-
- `.hftoken` only, `.hftoken.txt` will not work
134-
![Your directory should look something like this](docs/hftoken.png)
135-
- Generating the token:
136-
- You may need to create an account, you can skip all the optional steps except for verifying your email.
137-
- You can name the token anything, just save the token to a file called `.hftoken` to your machine.
138-
- The token does not need any special permissions, you can deselect all of the options.
139-
140-
1. If you want to make a one click startup script, you could do so now.
141-
- Example for windows:
142-
Save anywhere as "`Transcribe.ps1`"
143-
```sh
144-
cd ~/Documents/Transcriber
145-
# if you used a virtual environment uncomment the next line (remove the #)
146-
#./venv/Scripts/activate
147-
python main.py
148-
```
149-
- Example for Mac/Linux
150-
Save anywhere as "`Transcribe.sh`"
151-
```
152-
#!/bin/bash
153-
cd ~/Documents/Transcriber
154-
# if you used a virtual environment uncomment the next line (remove the #)
155-
# source .venv/bin/activate
156-
python main.py
157-
```
158-
_You may need to run `chmod +x Transcriber.sh` on the new .sh file to give it permissions to execute_
159-
- _NOTE: You might need to do some additional research for how to do this properly for your machine._
100+
Now that you have all of the requirements installed we will install the Transcriber from git
101+
1. Open your choice terminal window
102+
- Reccomended to use `Powershell` or `git bash` on windows, use default terminal on Mac/linux
103+
1. use "cd" to change directory to where you want to install the transcriber
104+
example: to your Documents folder:
105+
`cd ~/Documents`
106+
1. Clone the Transcriber repo:
107+
`git clone https://github.com/Noah-Jaffe/Transcriber.git`
108+
_NOTE: If you get the error: `fatal: destination path 'Transcriber' already exists and is not an empty directory.`, you will need to either delete the existing Transcriber folder, or rename the existing one. Or install to a custom directory by replacing NEW_FOLDER_NAME in the following command: `git clone https://github.com/Noah-Jaffe/Transcriber.git NEW_FOLDER_NAME`._
109+
1. Enter the Transcriber directory in the terminal
110+
`cd Transcriber` or `cd ~/Documents/Transcriber`
111+
1. Setup a python virtual environment if you want, skip this step if you are unfamiliar.
112+
`python -m venv .venv`
113+
- <a id="start-activate-venv"></a>Start/Activate your virtual python environment with
114+
- Windows
115+
- Powershell `./.venv/Scripts/activate`
116+
- git bash `source ./.venv/Scripts/activate`
117+
- MacOS/Linux
118+
- `source ./.venv/bin/activate`
119+
120+
1. <a id="pip install"></a>`pip install -r requirements.txt`
121+
- if the pip install fails try `pip install -r explicit_requirements.txt --no-cache`
122+
- if that fails, [report the issue to the maintainer or your point of contact](https://github.com/Noah-Jaffe/Transcriber/issues)
123+
- The only requirements not in the txt files are `torch` `torchaudio` and `torchvision`
124+
1. Install requirements not in requirements.txt
125+
126+
- If you are using CUDA:
127+
- You may need to `pip uninstall torch torchaudio torchvision` before doing this next step.
128+
- See here to reinstall `torch` `torchaudio` and `torchvision` with your appropriate build: [https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/)
129+
- Example for if you have a CUDA compatible device for 12.6 you would run: `pip install torch torchvision torchaudio --no-cache -U --index-url https://download.pytorch.org/whl/cu126`
130+
- Otherwise if you dont have a CUDA compatible GPU or dont know what that means then run the next line:
131+
- `pip install torch torchaudio torchvision`
132+
1. Put your [Huggingface token](https://huggingface.co/docs/hub/en/security-tokens) in a file named `.hftoken`.
133+
- `.hftoken` only, `.hftoken.txt` will not work
134+
![Your directory should look something like this](docs/hftoken.png)
135+
- Generating the token:
136+
- You may need to create an account, you can skip all the optional steps except for verifying your email.
137+
- You can name the token anything, just save the token to a file called `.hftoken` to your machine.
138+
- The token does not need any special permissions, you can deselect all of the options.
139+
140+
1. If you want to make a one click startup script, you could do so now.
141+
- Example for windows:
142+
Save anywhere as "`Transcribe.ps1`"
143+
```sh
144+
cd ~/Documents/Transcriber
145+
# if you used a virtual environment uncomment the next line (remove the #)
146+
#./venv/Scripts/activate
147+
python main.py
148+
```
149+
- Example for Mac/Linux
150+
Save anywhere as "`Transcribe.sh`"
151+
```
152+
#!/bin/bash
153+
cd ~/Documents/Transcriber
154+
# if you used a virtual environment uncomment the next line (remove the #)
155+
# source .venv/bin/activate
156+
python main.py
157+
```
158+
_You may need to run `chmod +x Transcriber.sh` on the new .sh file to give it permissions to execute_
159+
- _NOTE: You might need to do some additional research for how to do this properly for your machine._
160160
1. Continue to the [using the transcriber](#using-the-transcriber) step.
161161

162162
---

0 commit comments

Comments
 (0)