Update README & Javadocs

eoctet · Oct 8, 2023 · 269f71a · 269f71a
1 parent 101f746
commit 269f71a
Show file tree

Hide file tree

Showing 109 changed files with 998 additions and 1,567 deletions.
diff --git a/README.Zh_CN.md b/README.Zh_CN.md
@@ -8,8 +8,9 @@
 - 🚀 基于 Llama.cpp 构建，更多细节请关注 **@ggerganov's** [`llama.cpp`](https://github.com/ggerganov/llama.cpp)。
 - 🚀 使用JNI开发本地库，~~而不是JNA~~，测试的性能上与其他库无异。
 - 🚀 新增:
-  - [X] 对话历史记忆。
+  - [X] 连续生成和对话。
   - [X] Llama 语法解析。
+  - [X] 并行批处理解码。
 
 ## 快速开始
 
@@ -19,7 +20,7 @@
 <dependency>
     <groupId>chat.octet</groupId>
     <artifactId>llama-java-core</artifactId>
-    <version>1.1.5</version>
+    <version>1.1.6</version>
 </dependency>
 ```
 
@@ -163,7 +164,7 @@ GenerateParameter generateParams = GenerateParameter.builder()
 
 使用JNI开发，开放与原项目相同的接口并优化JVM Native性能。
 
-> `LlamaService.sampling(...)` 对采样进行了优化，以减少JVM Native之间数据传递带来的性能损失。
+> `LlamaService` 对API进行了优化，以减少JVM Native之间数据传递带来的性能损失。
 >
 >
 > 完整的文档请参考 [API docs](docs%2Fapidocs%2Findex.html)。

diff --git a/README.md b/README.md
@@ -8,9 +8,9 @@ Another simple Java bindings for 🦙 [**llama.cpp**](https://github.com/ggergan
 - 🚀 Built based on Llama.cpp, For more details, please follow **@ggerganov's** [`llama.cpp`](https://github.com/ggerganov/llama.cpp).
 - 🚀 Developed using JNI, ~~NOT JNA~~.
 - 🚀 News:
-  - [X] Conversation memory.
+  - [X] Continuous generation and chat.
   - [X] Llama grammar.
-
+  - [X] Parallel batch decode.
 
 ## Quick start
 
@@ -20,7 +20,7 @@ Another simple Java bindings for 🦙 [**llama.cpp**](https://github.com/ggergan
 <dependency>
     <groupId>chat.octet</groupId>
     <artifactId>llama-java-core</artifactId>
-    <version>1.1.5</version>
+    <version>1.1.6</version>
 </dependency>
 ```
 
@@ -167,7 +167,7 @@ Develop using JNI:
 - Same interface as the original project.
 - Optimize JVM Native performance.
 
-> `LlamaService.sampling(...)` sampling has been optimized to reduce performance losses caused by data transfer between JVM Native.
+> `LlamaService` has been optimized to reduce performance losses caused by data transfer between JVM Native.
 >
 >
 > More information: [API docs](docs%2Fapidocs%2Findex.html)

diff --git a/docs/apidocs/allclasses-frame.html b/docs/apidocs/allclasses-frame.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (1.8.0_381) on Fri Oct 06 19:53:03 CST 2023 -->
+<!-- Generated by javadoc (1.8.0_381) on Sun Oct 08 15:09:39 CST 2023 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>所有类 (llama-java-core 1.1.5 API)</title>
-<meta name="date" content="2023-10-06">
+<title>所有类 (llama-java-core 1.1.6 API)</title>
+<meta name="date" content="2023-10-08">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -15,10 +15,9 @@ <h1 class="bar">所有类</h1>
 <ul>
 <li><a href="chat/octet/model/beans/ChatMessage.html" title="chat.octet.model.beans中的类" target="classFrame">ChatMessage</a></li>
 <li><a href="chat/octet/model/beans/ChatMessage.ChatRole.html" title="chat.octet.model.beans中的枚举" target="classFrame">ChatMessage.ChatRole</a></li>
-<li><a href="chat/octet/model/ChatSession.html" title="chat.octet.model中的类" target="classFrame">ChatSession</a></li>
-<li><a href="chat/octet/model/ChatSessionManager.html" title="chat.octet.model中的类" target="classFrame">ChatSessionManager</a></li>
 <li><a href="chat/octet/model/beans/CompletionResult.html" title="chat.octet.model.beans中的类" target="classFrame">CompletionResult</a></li>
 <li><a href="chat/octet/model/components/processor/impl/CustomBiasLogitsProcessor.html" title="chat.octet.model.components.processor.impl中的类" target="classFrame">CustomBiasLogitsProcessor</a></li>
+<li><a href="chat/octet/model/exceptions/DecodeException.html" title="chat.octet.model.exceptions中的类" target="classFrame">DecodeException</a></li>
 <li><a href="chat/octet/model/beans/FinishReason.html" title="chat.octet.model.beans中的枚举" target="classFrame">FinishReason</a></li>
 <li><a href="chat/octet/model/parameters/GenerateParameter.html" title="chat.octet.model.parameters中的类" target="classFrame">GenerateParameter</a></li>
 <li><a href="chat/octet/model/parameters/GenerateParameter.MirostatMode.html" title="chat.octet.model.parameters中的枚举" target="classFrame">GenerateParameter.MirostatMode</a></li>

diff --git a/docs/apidocs/allclasses-noframe.html b/docs/apidocs/allclasses-noframe.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="zh">
 <head>
-<!-- Generated by javadoc (1.8.0_381) on Fri Oct 06 19:53:03 CST 2023 -->
+<!-- Generated by javadoc (1.8.0_381) on Sun Oct 08 15:09:39 CST 2023 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>所有类 (llama-java-core 1.1.5 API)</title>
-<meta name="date" content="2023-10-06">
+<title>所有类 (llama-java-core 1.1.6 API)</title>
+<meta name="date" content="2023-10-08">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -15,10 +15,9 @@ <h1 class="bar">所有类</h1>
 <ul>
 <li><a href="chat/octet/model/beans/ChatMessage.html" title="chat.octet.model.beans中的类">ChatMessage</a></li>
 <li><a href="chat/octet/model/beans/ChatMessage.ChatRole.html" title="chat.octet.model.beans中的枚举">ChatMessage.ChatRole</a></li>
-<li><a href="chat/octet/model/ChatSession.html" title="chat.octet.model中的类">ChatSession</a></li>
-<li><a href="chat/octet/model/ChatSessionManager.html" title="chat.octet.model中的类">ChatSessionManager</a></li>
 <li><a href="chat/octet/model/beans/CompletionResult.html" title="chat.octet.model.beans中的类">CompletionResult</a></li>
 <li><a href="chat/octet/model/components/processor/impl/CustomBiasLogitsProcessor.html" title="chat.octet.model.components.processor.impl中的类">CustomBiasLogitsProcessor</a></li>
+<li><a href="chat/octet/model/exceptions/DecodeException.html" title="chat.octet.model.exceptions中的类">DecodeException</a></li>
 <li><a href="chat/octet/model/beans/FinishReason.html" title="chat.octet.model.beans中的枚举">FinishReason</a></li>
 <li><a href="chat/octet/model/parameters/GenerateParameter.html" title="chat.octet.model.parameters中的类">GenerateParameter</a></li>
 <li><a href="chat/octet/model/parameters/GenerateParameter.MirostatMode.html" title="chat.octet.model.parameters中的枚举">GenerateParameter.MirostatMode</a></li>