Skip to content

Commit

Permalink
Add to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tjake committed Nov 6, 2023
1 parent 24f2999 commit f50410c
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 5 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,28 @@ Features:
* Supports Q8, Q4, Q5 model quantization


Jlama is built with Java 20 and utilizes the new [Vector API](https://openjdk.org/jeps/448)
Jlama is built with Java 20+ and utilizes the new [Vector API](https://openjdk.org/jeps/448)
for faster inference.

This project is a work in progress.

## Why?
## What is it used for?

Add LLM Inference directly to your Java application.

## Demo

Jlama includes a simple UI if you just want to chat with an llm.

```
./download-hf-model.sh tjake/llama2-7b-chat-hf-jlama-Q4
./run-cli.sh serve models/llama2-7b-chat-hf-jlama-Q4
```
open browser to http://localhost:8080/ui/index.html

<p align="center">
<img src="docs/demo.png" width="300" height="300" alt="Demo chat">
</p>

## How to use
Jlama includes a cli tool to run models via the `run-cli.sh` command.
Before you do that first download one or more models from huggingface.
Expand Down
Binary file added docs/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions jlama-cli/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-jackson2-provider</artifactId>
<version>${resteasy.version}</version>
<exclusions>
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
</exclusion>
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</exclusion>
<exclusion>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.jboss.resteasy</groupId>
Expand Down
2 changes: 1 addition & 1 deletion jlama-cli/src/main/resources/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h1>Chat with Jlama</h1>
</div>
<div id="scroll-wrapper">
<div id="chat-container" class="card">
<div class="text-end">
<div class="text-start">
<button id="delete-chat" class="btn btn-danger" type="button">Delete Chat</button>
<button id="save-chat" class="btn btn-secondary" type="button" data-bs-toggle="modal" data-bs-target="#nameModal">Save Chat</button>
</div>
Expand Down

0 comments on commit f50410c

Please sign in to comment.