Skip to content

Commit e4c5845

Browse files
danielholandajeremyfowersvgodsoe
authored
Release v6.0.3 (#295)
Co-authored-by: Jeremy Fowers <80718789+jeremyfowers@users.noreply.github.com> Co-authored-by: Victoria Godsoe <victoria.godsoe@amd.com>
1 parent d750f4a commit e4c5845

35 files changed

+736
-410
lines changed

.github/workflows/publish-to-test-pypi.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ on:
77
- v*
88
- RC*
99
pull_request:
10-
branches: ["main", "canary", "refresh"]
10+
branches:
11+
- '**'
1112

1213
jobs:
1314
build-n-publish:

.github/workflows/server_installer_windows_latest.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ on:
66
tags:
77
- v*
88
pull_request:
9-
branches: ["main"]
9+
branches:
10+
- '**'
1011
workflow_dispatch:
1112

1213
jobs:

.github/workflows/test_lemonade.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ on:
77
push:
88
branches: ["main"]
99
pull_request:
10-
branches: ["main"]
10+
branches:
11+
- '**'
1112

1213
permissions:
1314
contents: read

.github/workflows/test_lemonade_oga_cpu.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ on:
77
push:
88
branches: ["main"]
99
pull_request:
10-
branches: ["main"]
10+
branches:
11+
- '**'
1112

1213
permissions:
1314
contents: read

.github/workflows/test_quark.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ on:
77
push:
88
branches: ["main"]
99
pull_request:
10-
branches: ["main"]
10+
branches:
11+
- '**'
1112

1213
permissions:
1314
contents: read

.github/workflows/test_server.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ on:
77
push:
88
branches: ["main"]
99
pull_request:
10-
branches: ["main"]
10+
branches:
11+
- '**'
1112

1213
permissions:
1314
contents: read

docs/contribute.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,8 @@ TurnkeyML is provided as a package on PyPI, the Python Package Index, as [turnke
152152
The following public APIs are available for developers. The maintainers aspire to change these as infrequently as possible, and doing so will require an update to the package's major version number.
153153

154154
- From the top-level `__init__.py`:
155-
- `turnkeycli`: the `main()` function of the `turnkey` CLI
156-
- `evaluate_files()`: the top-level API called by the CLI
157155
- `turnkeyml.version`: The package version number
156+
- `State` class and `load_state`: structure that holds build state between Tools; function to load `State` from disk.
158157
- From the `common.filesystem` module:
159158
- `get_available_builds()`: list the builds in a turnkey cache
160159
- `make_cache_dir()`: create a turnkey cache

docs/lemonade/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ To install `lemonade` from source code:
6060

6161
## From Lemonade_Server_Installer.exe
6262

63-
The `lemonade` server is available as a standalone tool with a one-click Windows installer `.exe`. Check out the [Lemonade_Server_Installer.exe guide](lemonade_server_exe.md) for installation instructions and the [server spec](https://github.com/onnx/turnkeyml/blob/main/docs/lemonade/server_spec.md) to learn more about the functionality.
63+
The Lemonade Server is available as a standalone tool with a one-click Windows installer `.exe`. Check out the [Lemonade_Server_Installer.exe guide](lemonade_server_exe.md) for installation instructions and the [server spec](https://github.com/onnx/turnkeyml/blob/main/docs/lemonade/server_spec.md) to learn more about the functionality.
6464

6565
# CLI Commands
6666

Lines changed: 7 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -1,117 +1,21 @@
11
# Lemonade Server Installer
22

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.
44

5-
## GUI Installation and Usage
5+
## GUI Installation
66

77
> *Note:* you may need to give your browser or OS permission to download or install the .exe.
88
99
1. Navigate to the [latest release](https://github.com/onnx/turnkeyml/releases/latest).
1010
1. Scroll to the bottom and click `Lemonade_Server_Installer.exe` to download.
1111
1. Double-click the `Lemonade_Server_Installer.exe` and follow the instructions.
1212

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
1414

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.
1616

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.
1818

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
2220

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.

docs/lemonade/mmlu_accuracy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,4 @@ Use the syntax provided in the table to run that test subject with the `accuracy
9999
| Sociology | Culture | sociology |
100100
| US Foreign Policy | Politics | us_foreign_policy |
101101
| Virology | Health | virology |
102-
| World Religions | Philosophy | world_religions |
102+
| World Religions | Philosophy | world_religions |

0 commit comments

Comments
 (0)