# llm-benchmark (ollama-benchmark)
LLM Benchmark for Throughput via Ollama (Local LLMs)
## Installation Steps
```bash
pip install llm-benchmark
```
## Usage for general users directly
```bash
llm_benchmark run
```
## Installation and Usage in Video format
It's tested on Python 3.9 and above.
## ollama installation with the following models installed
7B model can be run on machines with 8GB of RAM
13B model can be run on machines with 16GB of RAM
## Usage explaination
On Windows, Linux, and macOS, it will detect memory RAM size to first download required LLM models.
When memory RAM size is greater than or equal to 4GB, but less than 7GB, it will check if gemma:2b exist. The program implicitly pull the model.
```bash
ollama pull gemma:2b
```
When memory RAM size is greater than 7GB, but less than 15GB, it will check if these models exist. The program implicitly pull these models
```bash
ollama pull gemma:2b
ollama pull gemma:7b
ollama pull mistral:7b
ollama pull llama2:7b
ollama pull llava:7b
```
When memory RAM siz is greater than 15GB, it will check if these models exist. The program implicitly pull these models
```bash
ollama pull gemma:2b
ollama pull gemma:7b
ollama pull mistral:7b
ollama pull llama2:7b
ollama pull llama2:13b
ollama pull llava:7b
ollama pull llava:13b
```
## Python Poetry manually(advanced) installation
<https://python-poetry.org/docs/#installing-manually>
## For developers to develop new features on Windows Powershell or on Ubuntu Linux or macOS
```bash
python3 -m venv .venv
. ./.venv/bin/activate
pip install -U pip setuptools
pip install poetry
```
## Usage in Python virtual environment
```bash
poetry shell
poetry install
llm_benchmark hello jason
```
### Example #1 send systeminfo and benchmark results to a remote server
```bash
llm_benchmark run
```
### Example #2 Do not send systeminfo and benchmark results to a remote server
```bash
llm_benchmark run --no-sendinfo
```
### Example #3 Benchmark run on explicitly given the path to the ollama executable (When you built your own developer version of ollama)
```bash
llm_benchmark run --ollamabin=~/code/ollama/ollama
```
## Reference
[Ollama](https://ollama.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/aidatatools/ollama-benchmark/",
"name": "llm-benchmark",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "benchmark, llama, ollama, llms, local",
"author": "Jason Chuang",
"author_email": "chuangtcee@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d5/2c/66f351a5f38761584adfe7dc3be818b26e40061d96382055af1bb23b0562/llm_benchmark-0.3.18.tar.gz",
"platform": null,
"description": "# llm-benchmark (ollama-benchmark)\n\nLLM Benchmark for Throughput via Ollama (Local LLMs)\n\n## Installation Steps\n\n```bash\npip install llm-benchmark\n```\n\n## Usage for general users directly\n\n```bash\nllm_benchmark run\n```\n\n## Installation and Usage in Video format\n\n\n\nIt's tested on Python 3.9 and above.\n\n## ollama installation with the following models installed\n\n7B model can be run on machines with 8GB of RAM\n\n13B model can be run on machines with 16GB of RAM\n\n## Usage explaination\n\nOn Windows, Linux, and macOS, it will detect memory RAM size to first download required LLM models.\n\nWhen memory RAM size is greater than or equal to 4GB, but less than 7GB, it will check if gemma:2b exist. The program implicitly pull the model.\n\n```bash\nollama pull gemma:2b\n```\n\nWhen memory RAM size is greater than 7GB, but less than 15GB, it will check if these models exist. The program implicitly pull these models\n\n```bash\nollama pull gemma:2b\nollama pull gemma:7b\nollama pull mistral:7b\nollama pull llama2:7b\nollama pull llava:7b\n```\n\nWhen memory RAM siz is greater than 15GB, it will check if these models exist. The program implicitly pull these models\n\n```bash\nollama pull gemma:2b\nollama pull gemma:7b\nollama pull mistral:7b\nollama pull llama2:7b\nollama pull llama2:13b\nollama pull llava:7b\nollama pull llava:13b\n```\n\n## Python Poetry manually(advanced) installation\n\n<https://python-poetry.org/docs/#installing-manually>\n\n## For developers to develop new features on Windows Powershell or on Ubuntu Linux or macOS\n\n```bash\npython3 -m venv .venv\n. ./.venv/bin/activate\npip install -U pip setuptools\npip install poetry\n```\n\n## Usage in Python virtual environment\n\n```bash\npoetry shell\npoetry install\nllm_benchmark hello jason\n```\n\n### Example #1 send systeminfo and benchmark results to a remote server\n\n```bash\nllm_benchmark run\n```\n\n### Example #2 Do not send systeminfo and benchmark results to a remote server\n\n```bash\nllm_benchmark run --no-sendinfo\n```\n\n### Example #3 Benchmark run on explicitly given the path to the ollama executable (When you built your own developer version of ollama)\n\n```bash\nllm_benchmark run --ollamabin=~/code/ollama/ollama\n```\n\n## Reference\n\n[Ollama](https://ollama.com)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "LLM Benchmark for Throughputs via Ollama",
"version": "0.3.18",
"project_urls": {
"Homepage": "https://github.com/aidatatools/ollama-benchmark/"
},
"split_keywords": [
"benchmark",
" llama",
" ollama",
" llms",
" local"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc593e2112efcd8a97b337ef0f5f606ccff43977f016ebf9769ebd58a398b7fc",
"md5": "eb0f5e70c16881c45773193fc52de0df",
"sha256": "62b5408dcc59a45cecbb77faf07438641c4dd5387c55ee0cfea01bec26015787"
},
"downloads": -1,
"filename": "llm_benchmark-0.3.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb0f5e70c16881c45773193fc52de0df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 2130318,
"upload_time": "2024-05-01T07:49:29",
"upload_time_iso_8601": "2024-05-01T07:49:29.885800Z",
"url": "https://files.pythonhosted.org/packages/fc/59/3e2112efcd8a97b337ef0f5f606ccff43977f016ebf9769ebd58a398b7fc/llm_benchmark-0.3.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d52c66f351a5f38761584adfe7dc3be818b26e40061d96382055af1bb23b0562",
"md5": "2bbb2cc0b3cb750288f395321e314613",
"sha256": "ed7e9384aed6f700a7701f11919ee726e9a75628dcee3d362296f95a47c73230"
},
"downloads": -1,
"filename": "llm_benchmark-0.3.18.tar.gz",
"has_sig": false,
"md5_digest": "2bbb2cc0b3cb750288f395321e314613",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 2127593,
"upload_time": "2024-05-01T07:49:32",
"upload_time_iso_8601": "2024-05-01T07:49:32.014181Z",
"url": "https://files.pythonhosted.org/packages/d5/2c/66f351a5f38761584adfe7dc3be818b26e40061d96382055af1bb23b0562/llm_benchmark-0.3.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 07:49:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aidatatools",
"github_project": "ollama-benchmark",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "anyio",
"specs": [
[
"==",
"4.3.0"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.2.2"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "cli-exit-tools",
"specs": [
[
"==",
"1.2.6"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "exceptiongroup",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "fake-winreg",
"specs": [
[
"==",
"1.6.3"
]
]
},
{
"name": "GPUtil",
"specs": [
[
"==",
"1.4.0"
]
]
},
{
"name": "h11",
"specs": [
[
"==",
"0.14.0"
]
]
},
{
"name": "httpcore",
"specs": [
[
"==",
"1.0.5"
]
]
},
{
"name": "httpx",
"specs": [
[
"==",
"0.27.0"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.6"
]
]
},
{
"name": "lib-detect-testenv",
"specs": [
[
"==",
"2.0.8"
]
]
},
{
"name": "lib-platform",
"specs": [
[
"==",
"1.2.10"
]
]
},
{
"name": "lib-registry",
"specs": [
[
"==",
"2.0.10"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "ollama",
"specs": [
[
"==",
"0.1.8"
]
]
},
{
"name": "psutil",
"specs": [
[
"==",
"5.9.8"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.17.2"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0.1"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"13.7.1"
]
]
},
{
"name": "shellingham",
"specs": [
[
"==",
"1.5.4"
]
]
},
{
"name": "sniffio",
"specs": [
[
"==",
"1.3.1"
]
]
},
{
"name": "typer",
"specs": [
[
"==",
"0.9.4"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.10.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.1"
]
]
},
{
"name": "wrapt",
"specs": [
[
"==",
"1.16.0"
]
]
}
],
"lcname": "llm-benchmark"
}
JSON
