bradhutchings commited on
Commit
cbeda7f
·
verified ·
1 Parent(s): e37b36a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +65 -3
README.md CHANGED
@@ -1,3 +1,65 @@
1
- ---
2
- license: apache-2.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ ---
4
+ ### Hello
5
+
6
+ Thanks for your interest in the Brads-LLMs packages. These are free for your use. These packages are built with llamafile and run on macOS, Windows, and Linux.
7
+ Smaller models will even run on a Rasberry Pi!
8
+ You should be familiar with running scripts on your computer. If you're not, please get help from someone who is.
9
+
10
+ If you would like paid assistance or need help with AI projects, please email me or start a discussion in the community.
11
+ I do not accept pull requests.
12
+
13
+ -Brad<br/>
14
+ Brad Hutchings<br/>
15
16
+
17
+ <hr/>
18
+
19
+ ### Windows Instructions
20
+
21
+ Video: https://youtu.be/HRqaBoNajCM
22
+
23
+ 1. If you have not used PowerShell on your computer previously, you must enable scripting.
24
+ 1. Run PowerShell as Administrator.
25
+ 2. Paste this command and press the **enter** key:
26
+ ```
27
+ Set-ExecutionPolicy Unrestricted
28
+ ```
29
+ This will allow you to run scripts with permission each time. When you feel comfortable running scripts and, most importantly,
30
+ not running scripts you shouldn't run that might compromise your computer, run this command:
31
+ ```
32
+ Set-ExecutionPolicy Bypass
33
+ ```
34
+ 3. Close the PowerShell window.
35
+ 1. Go to the **Files and versions** tab of this web page.
36
+ 2. Download the file **Brads LLMs (Windows).zip**.
37
+ 3. Once downloaded, move the file to your Desktop and extract there.
38
+ 4. Open that new folder. right-click the **Start-Apple-OpenELM-1.1B-Instruct.ps1**. Choose **Run with PowerShell***.
39
+ - The script will download a `.gguf` model for Apple OpenELM 1.1B Instruct that I have prepared to the `models` sub-folder. This may take a few minutes.
40
+ - The script will launch my `Brads-LLMs-llamafile.exe` executable to run the model.
41
+ - A web browser window will open. Follow instuctions there.
42
+ 5. When you're finished with the model, close the web browser tab and close the PowerShell or Command window.
43
+ <hr/>
44
+ ### macOS, Linux, Raspberry Pi. etc. Instructions
45
+ 1. Go to the **Files and versions** tab of this web page.
46
+ 2. Download the file **Brads LLMs (macOS-Linux).zip**.
47
+ 3. Once downloaded, move the file to your Desktop and extract there.
48
+ 4. Open a Terminal. Type commands:
49
+ ```
50
+ cd ~/Desktop/Brads\ LLMs\ \(macOS-Linux\)
51
+ chmod a+x *
52
+ ls -al
53
+ ```
54
+ (Picture of files with x bits set goes here.)
55
+ 5. Open that new folder. right-click the **Start-Apple-OpenELM-1.1B-Instruct.sh**. There should be a menu item to "run" the script. Choose that.
56
+ - The script will download a `.gguf` model for Apple OpenELM 1.1B Instruct that I have prepared to the `models` sub-folder. This may take a few minutes.
57
+ - The script will launch my `Brads-LLMs-llamafile.exe` executable to run the model.
58
+ - A web browser window will open. Follow instuctions there.
59
+ 6. When you're finished with the model, close the web browser tab and close the PowerShell or Command window.
60
+ #### macOS Users
61
+ - **Note:** When you right-click the `.sh` script file, choose **Open** from the context menu that appears.
62
+ You may get a warning about the script. You can allow the script in the privacy settings:<br/>
63
+ https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unknown-developer-mh40616/mac
64
+ - **Note:** You may be asked to enable Developer Tools or some such when you launch the Terminal app for the first time.
65
+ If this isn't a familiar place for you, please get some basic help from someone who knows their way around the Terminal.