Repository navigation
Add description and author metadata to backends for display in the CLI and GUI #4010
jeremyfowers
started this conversation in
Request for Comment (RFC)
Replies: 1 comment 3 replies
|
makes sense! I think a separate CLI command for that is quite redundant, since looking up backends one by one seems cumbersome. If anything, it should be added to lists. |
3 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment

Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Proposal size
Minor feature (a single PR)
Updates
User story
Users of Lemonade are confronted with a marketplace of 20 backends, and they find this confusing. The only information we provide for each backend is the name, version number, and a link to a github release page, which does not help the user understand what the backend is, who originally authored it.
I propose that we add the following metadata into the backend spec for each backend, and then we can display it in the CLI and GUI.
High-level design
New fields:
description: 1-2 sentences of what the intent of this backend is. For example, onllamacpp:vulkan: Cross-platform GPU runtime.llamacpp:rocm: GPU runtime specialized for AMD GPUs.author: the original author of the backend, which can differ from the github release link. For example,llamacpp:vulkanalready comes from the original author, which isggml-org.llamacpp:rocmcomes fromlemonade-sdkorg, since we do our own builds, but the original author isggml-org. This is important for trust and traceability as we add toolbox backends.license: software license for the backend, with a link to the license file.We can display this information in the CLI with a new subcommand.
lemonade backends-> already lists the backends. Include a "Uselemonade backends info ENGINE:BACKEND to learn moretip at the bottom.lemonade backends info ENGINE:BACKEND-> pretty print all the metadata we have for that backendlemonade backends install ENGINE:BACKENDsubcommand we already have.On the GUI, we would simply display the author and description next to the existing info. Looks like this right now:
New layout:
Breaking changes
None
Maintenance plan
The initial PR would add data for all existing backends. A lint rule would ensure all future backends included the data.
Risks
Need to make sure people are happy with the descriptions.
All reactions