Skip to content

Commit 5a496ec

Browse files
authored
Update README.md
Update instructions for version 1.2.
1 parent 334085d commit 5a496ec

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

README.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,33 @@
1919
<table>
2020
<thead>
2121
<tr>
22-
<th>GPU Brand</th>
23-
<th>Windows Support</th>
24-
<th>Linux Support</th>
22+
<th>GPU</th>
23+
<th>Windows</th>
24+
<th>Linux</th>
25+
<th>Requirements</th>
2526
</tr>
2627
</thead>
2728
<tbody>
2829
<tr>
2930
<td>Nvidia</td>
30-
<td>✅ (requires CUDA 11.7 or 11.8)</td>
31-
<td>✅ (requires CUDA 11.7 or 11.8)</td>
31+
<td>✅</td>
32+
<td>✅</td>
33+
<td>CUDA 11.8 or 11.7</td>
3234
</tr>
3335
<tr>
3436
<td>AMD</td>
3537
<td>❌</td>
36-
<td>✅ (requires ROCm 5.4.2)</td>
38+
<td>✅</td>
39+
<td>ROCm 5.4.2</td>
3740
</tr>
3841
<tr>
3942
<td>Apple/Metal</td>
40-
<td colspan="2" align="center"> ✅ (requires "Xcode Command Line Tools")</td>
43+
<td colspan="3" align="center"> ✅ ("Xcode Command Line Tools")</td>
4144
</tr>
4245
</tbody>
4346
</table>
4447
</div>
4548

46-
4749
<!-- Table of Contents -->
4850

4951
<div align="center">
@@ -52,77 +54,75 @@
5254

5355
<div align="center">
5456
<a href="#installation">Installation</a> |
55-
<a href="#usage-guide">Usage</a> |
57+
<a href="#usage">Usage</a> |
5658
<a href="#contact">Contact Me</a>
5759
</div>
5860

5961
## Installation
6062

61-
* **Step 1**: Install the appropriate software if you intend to use GPU-acceleration:
62-
63+
* **Step 1** ➜ Install the appropriate software if you intend to use GPU-acceleration:
6364
* **For NVIDIA GPUs** ➜ install [CUDA 11.8](https://developer.nvidia.com/cuda-11-8-0-download-archive) or [CUDA 11.7](https://developer.nvidia.com/cuda-11-7-0-download-archive) for your specific operating system.
6465
* **For AMD GPUs** ➜ install ROCm version 5.4.2; instructions are [HERE](https://rocmdocs.amd.com/en/latest/deploy/linux/quick_start.html) and [HERE](https://rocmdocs.amd.com/en/latest/deploy/linux/index.html).
6566
* Unfortunately, gpu-accleration will [only work on Linux systems](https://github.com/RadeonOpenCompute/ROCm/blob/develop/docs/rocm.md).
6667
* **For Apple/Metal/MPS** ➜ install [Xcode Command Line Tools](https://www.makeuseof.com/install-xcode-command-line-tools/).
67-
* **Step 2**: Download or clone this repository to a directory on your computer.
68-
* **Step 3**: Open a command prompt from within the directory and create a virtual environment:
68+
* **Step 2** Download or clone this repository to a directory on your computer.
69+
* **Step 3** Open a command prompt from within the directory and create a virtual environment:
6970
```
7071
python -m venv .
7172
```
72-
* **Step 4**: Activate the virtual environment:
73+
* **Step 4** Activate the virtual environment:
7374
```
7475
.\Scripts\activate
7576
```
76-
* **Step 5**: Update [PIP](https://pip.pypa.io/en/stable/index.html):
77+
* **Step 5** Update [PIP](https://pip.pypa.io/en/stable/index.html):
7778
```
7879
python -m pip install --upgrade pip
7980
```
80-
* **Step 6**: Install PyTorch with the appropriate "build:"
81-
82-
* **Windows/CUDA 11.8:** ```pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118```
83-
* **Windows/CUDA 11.7:** ```pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117```
84-
* **Windows/CPU-only:** ```pip install torch torchvision torchaudio```
85-
* **Linux/CUDA 11.8:** ```pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118```
86-
* **Linux/CUDA 11.7:** ```pip install torch torchvision torchaudio```
87-
* **Linux/ROCm 5.4.2:** ```install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm5.4.2```
88-
* **Linux/CPU-only:** ```pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu```
89-
* **Apple/Metal/MPS:** ```pip pip install torch torchvision torchaudio```
81+
* **Step 6** Install PyTorch with the appropriate "build:"
82+
83+
* **Windows/CUDA 11.8** ```pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118```
84+
* **Windows/CUDA 11.7** ```pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117```
85+
* **Windows/CPU-only** ```pip install torch torchvision torchaudio```
86+
* **Linux/CUDA 11.8** ```pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118```
87+
* **Linux/CUDA 11.7** ```pip install torch torchvision torchaudio```
88+
* **Linux/ROCm 5.4.2** ```install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm5.4.2```
89+
* **Linux/CPU-only** ```pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu```
90+
* **Apple/Metal/MPS** ```pip pip install torch torchvision torchaudio```
9091
* **Metal/MPS** [speedup comparison](https://explosion.ai/blog/metal-performance-shaders) to a 5950x and RTX 3090.
9192

92-
* **Step 7:** Doublecheck that you installed gpu-acceleration properly:
93+
* **Step 7** Doublecheck that you installed gpu-acceleration properly:
9394
```
9495
python check_gpu.py
9596
```
9697

97-
* **Step 8**: Install the dependencies listed in [requirements.txt](https://github.com/MicrosoftDocs/visualstudio-docs/blob/main/docs/python/managing-required-packages-with-requirements-txt.md):
98+
* **Step 8** Install the dependencies listed in [requirements.txt](https://github.com/MicrosoftDocs/visualstudio-docs/blob/main/docs/python/managing-required-packages-with-requirements-txt.md):
9899
```
99100
pip install -r requirements.txt
100101
```
101-
* **Step 9**:
102-
* Lastly, you must install the appropriate version of Git (https://git-scm.com/downloads).
102+
* **Step 9** ➜ Lastly, you must install the appropriate version of Git (https://git-scm.com/downloads).
103103

104104
[Back to top](#top)
105105

106-
## Usage Guide
106+
## Usage
107107

108108
* **Step 1**: Open a command prompt in the directory of my scripts, activate the virtual environment, and run:
109109
```
110110
python gui.py
111111
```
112-
* **Step 2**: Click "Download Embedding Model" and download a model. The GUI will hang. Wait. Proceed to the next step.
113-
* **Step 3**: Click "Select Embedding Model Directory" and select the DIRECTORY containing the model you want to use.
114-
* **Step 4**: Click "Choose Documents for Database" and choose one or more PDF files to put in the database.
112+
* **Step 2** Click "Download Embedding Model" and download a model. The GUI will hang. Wait. Proceed to the next step.
113+
* **Step 3** Click "Select Embedding Model Directory" and select the DIRECTORY containing the model you want to use.
114+
* **Step 4** Click "Choose Documents for Database" and choose one or more PDF files to put in the database.
115115
* Must have had OCR done on them or have text in them already. If you can select the text when viewing it, you're good.
116-
* **Step 5**: Click "Create Vector Database." The GUI will hang. Watch "CUDA" usage. When CUDA drops to zero, proceed to the next step.
117-
* **Step 6**: Open up LM Studio and load a model (only Llama2-based models currently work).
118-
* **Step 7**: Click "Start Server" within LM Studio, enter your question, and click "Submit Question."
116+
* **Step 5** Click "Create Vector Database." The GUI will hang. Watch "CUDA" usage. When CUDA drops to zero, proceed to the next step.
117+
* **Step 6** Open up LM Studio and load a model (only Llama2-based models currently work).
118+
* **Step 7** Click "Start Server" within LM Studio, enter your question, and click "Submit Question."
119119

120120

121121
[Back to top](#top)
122122

123123
## Contact
124124

125-
All suggestions (positive and negative) are welcome. I can be reached at "bbc@chintellalaw.com" or feel free to message me on the [LM Studio Discord Server](https://discord.gg/aPQfnNkxGC).
125+
All suggestions (positive and negative) are welcome. "bbc@chintellalaw.com" or feel free to message me on the [LM Studio Discord Server](https://discord.gg/aPQfnNkxGC).
126126

127127
[Back to top](#top)
128128

0 commit comments

Comments
 (0)