|
1 | 1 | # Lemonade Server Installer |
2 | 2 |
|
3 | | -The `lemonade` server is available as a standalone tool with a one-click Windows installer `.exe`. Check out the [server spec](https://github.com/onnx/turnkeyml/blob/main/docs/lemonade/server_spec.md) to learn more about the functionality. |
| 3 | +The Lemonade Server is available as a standalone tool with a one-click Windows installer `.exe`. Check out the [server spec](https://github.com/onnx/turnkeyml/blob/main/docs/lemonade/server_spec.md) to learn more about the functionality. |
4 | 4 |
|
5 | | -## GUI Installation and Usage |
| 5 | +## GUI Installation |
6 | 6 |
|
7 | 7 | > *Note:* you may need to give your browser or OS permission to download or install the .exe. |
8 | 8 |
|
9 | 9 | 1. Navigate to the [latest release](https://github.com/onnx/turnkeyml/releases/latest). |
10 | 10 | 1. Scroll to the bottom and click `Lemonade_Server_Installer.exe` to download. |
11 | 11 | 1. Double-click the `Lemonade_Server_Installer.exe` and follow the instructions. |
12 | 12 |
|
13 | | -Now that you have the server installed, you can double click the desktop shortcut to run the server process. From there, you can connect it to applications that are compatible with the OpenAI completions API. |
| 13 | +## Usage |
14 | 14 |
|
15 | | -## Silent Installation and Command Line Usage |
| 15 | +Now that you have the server installed, you can double click the desktop shortcut to run the server process. |
16 | 16 |
|
17 | | -Silent installation and command line usage are useful if you want to fully integrate `lemonade` server into your own application. This guide provides fully automated steps for downloading, installing, and running `lemonade` server so that your users don't have to install `lemonade` separately. |
| 17 | +From there, you can connect it to applications that are compatible with the OpenAI completions API. The Lemonade Server [examples folder](https://github.com/onnx/turnkeyml/tree/main/examples/lemonade/server) has guides for how to use Lemonade Server with a collection of applications that we have tested. |
18 | 18 |
|
19 | | -Definitions: |
20 | | -- "Silent installation" refers to an automatic command for installing `lemonade` server without running any GUI or prompting the user for any questions. It does assume that the end-user fully accepts the license terms, so be sure that your own application makes this clear to the user. |
21 | | -- Command line usage allows the server process to be launched programmatically, so that your application can manage starting and stopping the server process on your user's behalf. |
| 19 | +## Developing with Lemonade Server |
22 | 20 |
|
23 | | -### Download |
24 | | - |
25 | | -Follow these instructions to download a copy of `Lemonade_Server_Installer.exe`. |
26 | | - |
27 | | -#### cURL Download |
28 | | - |
29 | | -In a `bash` terminal, such as `git bash`: |
30 | | - |
31 | | -Download the latest version: |
32 | | - |
33 | | -```bash |
34 | | -curl -L -o ".\Lemonade_Server_Installer.exe" https://github.com/onnx/turnkeyml/releases/latest/download/Lemonade_Server_Installer.exe |
35 | | -``` |
36 | | - |
37 | | -Download a specific version: |
38 | | - |
39 | | -```bash |
40 | | -curl -L -o ".\Lemonade_Server_Installer.exe" https://github.com/onnx/turnkeyml/releases/download/v6.0.0/Lemonade_Server_Installer.exe |
41 | | -``` |
42 | | - |
43 | | -#### PowerShell Download |
44 | | - |
45 | | -In a powershell terminal: |
46 | | - |
47 | | -Download the latest version: |
48 | | - |
49 | | -```powershell |
50 | | -Invoke-WebRequest -Uri "https://github.com/onnx/turnkeyml/releases/latest/download/Lemonade_Server_Installer.exe" -OutFile "Lemonade_Server_Installer.exe" |
51 | | -``` |
52 | | - |
53 | | -Download a specific version: |
54 | | - |
55 | | -```powershell |
56 | | -Invoke-WebRequest -Uri "https://github.com/onnx/turnkeyml/releases/download/v6.0.0/Lemonade_Server_Installer.exe" -OutFile "Lemonade_Server_Installer.exe" |
57 | | -``` |
58 | | - |
59 | | -### Silent Installation |
60 | | - |
61 | | -Silent installation runs `Lemonade_Server_Installer.exe` without a GUI and automatically accepts all prompts. |
62 | | - |
63 | | -In a `cmd.exe` terminal: |
64 | | - |
65 | | -Install *with* Ryzen AI hybrid support: |
66 | | - |
67 | | -```bash |
68 | | -Lemonade_Server_Installer.exe /S /Extras=hybrid |
69 | | -``` |
70 | | - |
71 | | -Install *without* Ryzen AI hybrid support: |
72 | | - |
73 | | -```bash |
74 | | -Lemonade_Server_Installer.exe /S |
75 | | -``` |
76 | | - |
77 | | -The install directory can also be changed from the default by using `/D` as the last argument. |
78 | | - |
79 | | -For example: |
80 | | - |
81 | | -```bash |
82 | | -Lemonade_Server_Installer.exe /S /Extras=hybrid /D=C:\a\new\path` |
83 | | -``` |
84 | | - |
85 | | -### Command Line Invocation |
86 | | - |
87 | | -Command line invocation starts the `lemonade` server process so that your application can connect to it via REST API endpoints. |
88 | | - |
89 | | -#### Foreground Process |
90 | | - |
91 | | -These steps will open lemonade server in a terminal window that is visible to users. The user can exit the server by closing the window. |
92 | | - |
93 | | -In a `cmd.exe` terminal: |
94 | | - |
95 | | -```bash |
96 | | -conda run --no-capture-output -p INSTALL_DIR\lemonade_server\lemon_env lemonade serve |
97 | | -``` |
98 | | - |
99 | | -Where `INSTALL_DIR` is the installation path of `lemonade_server`. |
100 | | - |
101 | | -For example, if you used the default installation directory and your username is USERNAME: |
102 | | - |
103 | | -```bash |
104 | | -C:\Windows\System32\cmd.exe /C conda run --no-capture-output -p C:\Users\USERNAME\AppData\Local\lemonade_server\lemon_env lemonade serve |
105 | | -``` |
106 | | - |
107 | | -#### Background Process |
108 | | - |
109 | | -This command will open lemonade server without opening a window. Your application needs to manage terminating the process and any child processes it creates. |
110 | | - |
111 | | -In a powershell terminal: |
112 | | - |
113 | | -```powershell |
114 | | -$serverProcess = Start-Process -FilePath "C:\Windows\System32\cmd.exe" -ArgumentList "/C conda run --no-capture-output -p INSTALL_DIR\lemonade_server\lemon_env lemonade serve" -RedirectStandardOutput lemonade_out.txt -RedirectStandardError lemonade_err.txt -PassThru -NoNewWindow |
115 | | -``` |
116 | | - |
117 | | -Where `INSTALL_DIR` is the installation path of `lemonade_server`. |
| 21 | +Interested in integrating Lemonade Server into an application you are developing? Check out the [Lemonade Server integration guide](server_integration.md) to learn more. |
0 commit comments