diff --git a/README.md b/README.md index 848c18c..df2a359 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,16 @@ Follow these instructions to set up and run benchmarks on your system. ### Installation +#### Using pip + +Install the package directly using pip using a tool of your choice. + +```bash +pip install git+https://github.com/larryhopecode/ollama-benchmark.git +``` + +#### Local Setup + 1. **Clone the repository** ```bash @@ -78,8 +88,10 @@ Follow these instructions to set up and run benchmarks on your system. 3. **Install dependencies** +Install the package in editable mode, in case you want to modify the code. + ```bash - pip install -r requirements.txt + pip install -e . ``` ## Usage @@ -97,13 +109,13 @@ Follow these instructions to set up and run benchmarks on your system. Basic usage: ```bash - python benchmark.py + ollama-benchmark ``` With options: ```bash - python benchmark.py --verbose --models deepseek-r1:70b --prompts "Write a hello world program" "Explain quantum computing" + ollama-benchmark --verbose --models deepseek-r1:70b --prompts "Write a hello world program" "Explain quantum computing" ``` ### Command Line Options diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..d0ada72 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,14 @@ +[project] +name = "ollama-benchmark" +version = "0.1.0" +description = "Add your description here" +readme = "README.md" +requires-python = ">=3.11" +dependencies = [ + "pydantic", + "ollama" +] +scripts = { "ollama-benchmark" = "benchmark:main" } + +[tool.setuptools] +py-modules = ["benchmark"] diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 95df803..0000000 --- a/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -pydantic -ollama