mirror of
https://github.com/amithkoujalgi/ollama4j.git
synced 2025-10-31 16:40:41 +01:00
Merge pull request #156 from ollama4j/amithkoujalgi-patch-2
Amithkoujalgi patch 2
This commit is contained in:
Amith Koujalgi
9
CITATION.cff
Normal file
9
CITATION.cff
Normal file
@@ -0,0 +1,9 @@
|
||||
cff-version: 1.2.0
|
||||
message: "If you use this software, please cite it as below."
|
||||
authors:
|
||||
- family-names: "Koujalgi"
|
||||
given-names: "Amith"
|
||||
title: "Ollama4j: A Java Library (Wrapper/Binding) for Ollama Server"
|
||||
version: "1.1.0"
|
||||
date-released: 2023-12-19
|
||||
url: "https://github.com/ollama4j/ollama4j"
|
||||
118
README.md
118
README.md
@@ -1,26 +1,30 @@
|
||||
### Ollama4j
|
||||
|
||||
<p align="center">
|
||||
<div align="center">
|
||||
<img src='https://raw.githubusercontent.com/ollama4j/ollama4j/65a9d526150da8fcd98e2af6a164f055572bf722/ollama4j.jpeg' width='100' alt="ollama4j-icon">
|
||||
</p>
|
||||
<div style="font-weight: bold; font-size: 25px; ">Ollama4j</div>
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
A Java library (wrapper/binding) for Ollama server.
|
||||
|
||||
Find more details on the [website](https://ollama4j.github.io/ollama4j/).
|
||||
_Find more details on the **[website](https://ollama4j.github.io/ollama4j/)**._
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[](https://github.com/ollama4j/ollama4j/actions/workflows/run-tests.yml)
|
||||
|
||||
[](https://codecov.io/gh/ollama4j/ollama4j)
|
||||
</div>
|
||||
|
||||
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
|
||||
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
@@ -29,16 +33,6 @@ Find more details on the [website](https://ollama4j.github.io/ollama4j/).
|
||||
|
||||
[//]: # ()
|
||||
|
||||
|
||||
[](https://codecov.io/gh/ollama4j/ollama4j)
|
||||
|
||||
[](https://github.com/ollama4j/ollama4j/actions/workflows/run-tests.yml)
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
[//]: # ()
|
||||
|
||||
[//]: # ()
|
||||
@@ -55,7 +49,7 @@ Find more details on the [website](https://ollama4j.github.io/ollama4j/).
|
||||
- [Contributions](#get-involved)
|
||||
- [References](#references)
|
||||
|
||||
#### How does it work?
|
||||
## How does it work?
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
@@ -69,14 +63,14 @@ Find more details on the [website](https://ollama4j.github.io/ollama4j/).
|
||||
end
|
||||
```
|
||||
|
||||
#### Requirements
|
||||
## Requirements
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://ollama.com/" target="_blank">
|
||||
<img src="https://img.shields.io/badge/v0.3.0-green.svg?style=for-the-badge&labelColor=gray&label=Ollama&color=blue" alt=""/>
|
||||
</a>
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/Java-11%2B-green.svg?style=for-the-badge&labelColor=gray&label=Java&color=orange" alt="Java"/>
|
||||
<a href="https://ollama.com/" target="_blank">
|
||||
<img src="https://img.shields.io/badge/Ollama-0.3.0-blue.svg?style=for-the-badge&labelColor=gray&label=Ollama&color=blue" alt="Ollama"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -192,7 +186,12 @@ dependencies {
|
||||
> [!TIP]
|
||||
> Find the full API specifications on the [website](https://ollama4j.github.io/ollama4j/).
|
||||
|
||||
### Development
|
||||
## Examples
|
||||
|
||||
For practical examples and usage patterns of the Ollama4j library, check out
|
||||
the [ollama4j-examples](https://github.com/ollama4j/ollama4j-examples) repository.
|
||||
|
||||
## Development
|
||||
|
||||
Make sure you have `pre-commit` installed.
|
||||
|
||||
@@ -244,14 +243,24 @@ make integration-tests
|
||||
|
||||
Newer artifacts are published via GitHub Actions CI workflow when a new release is created from `main` branch.
|
||||
|
||||
## Examples
|
||||
## Get Involved
|
||||
|
||||
The `ollama4j-examples` repository contains examples for using the Ollama4j library. You can explore
|
||||
it [here](https://github.com/ollama4j/ollama4j-examples).
|
||||
<div align="center">
|
||||
|
||||
## ⭐ Give us a Star!
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
|
||||
If you like or are using this project to build your own, please give us a star. It's a free way to show your support.
|
||||
</div>
|
||||
|
||||
Contributions are most welcome! Whether it's reporting a bug, proposing an enhancement, or helping
|
||||
with code - any sort of contribution is much appreciated.
|
||||
|
||||
<div style="font-size: 15px; font-weight: bold; padding-top: 10px; padding-bottom: 10px; border: 1px solid" align="center">
|
||||
If you like or are use this project, please give us a ⭐. It's a free way to show your support.
|
||||
</div>
|
||||
|
||||
## Who's using Ollama4j?
|
||||
|
||||
@@ -270,22 +279,16 @@ If you like or are using this project to build your own, please give us a star.
|
||||
| 11 | Research Article | Article: `Large language model based mutations in genetic improvement` - published on National Library of Medicine (National Center for Biotechnology Information) | [Website](https://pmc.ncbi.nlm.nih.gov/articles/PMC11750896/) |
|
||||
| 12 | renaime | A LLaVa powered tool that automatically renames image files having messy file names. | [Website](https://devpost.com/software/renaime) |
|
||||
|
||||
## Traction
|
||||
|
||||
[](https://star-history.com/#ollama4j/ollama4j&Date)
|
||||
|
||||
## Get Involved
|
||||
|
||||
<div align="center">
|
||||
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
<a href=""></a>
|
||||
|
||||
</div>
|
||||
## Growth
|
||||
|
||||
<p align="center">
|
||||
<a href="https://star-history.com/#ollama4j/ollama4j&Date" target="_blank" rel="noopener noreferrer">
|
||||
<img
|
||||
src="https://api.star-history.com/svg?repos=ollama4j/ollama4j&type=Date"
|
||||
alt="Star History Chart"
|
||||
/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
[//]: # ()
|
||||
|
||||
@@ -297,27 +300,6 @@ If you like or are using this project to build your own, please give us a star.
|
||||
|
||||
[//]: # ()
|
||||
|
||||
|
||||
Contributions are most welcome! Whether it's reporting a bug, proposing an enhancement, or helping
|
||||
with code - any sort
|
||||
of contribution is much appreciated.
|
||||
|
||||
## 🏷️ License and Citation
|
||||
|
||||
The code is available under [MIT License](./LICENSE).
|
||||
|
||||
If you find this project helpful in your research, please cite this work at
|
||||
|
||||
```
|
||||
@misc{ollama4j2024,
|
||||
author = {Amith Koujalgi},
|
||||
title = {Ollama4j: A Java Library (Wrapper/Binding) for Ollama Server},
|
||||
year = {2024},
|
||||
month = {January},
|
||||
url = {https://github.com/ollama4j/ollama4j}
|
||||
}
|
||||
```
|
||||
|
||||
### References
|
||||
|
||||
- [Ollama REST APIs](https://github.com/jmorganca/ollama/blob/main/docs/api.md)
|
||||
@@ -331,7 +313,7 @@ project.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/ollama4j/ollama4j/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=ollama4j/ollama4j" alt=""/>
|
||||
<img src="https://contrib.rocks/image?repo=ollama4j/ollama4j" alt=""/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user