From 105491e482dd7740aea4df238c715338263b12f8 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Wed, 27 Aug 2025 20:20:16 +0000 Subject: [PATCH 1/4] Update README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index f5bc9f2..cdb0540 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,30 @@ Universal Category System LLM toolkit. +## Install + +Since this project is still experimental and not for production, it's not +packaged on PyPi. You should cloen the project to your local machine and +do an [editable install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs) +in a [virtual environment](https://docs.python.org/3/library/venv.html). + +```sh +git clone https://git.squad51.us/jamie/ucsinfer.git +git submodule sync +python -m venv .venv +source .venv/bin/activate # or whatever command is approprate for your shell +pip install -e . +``` + +Or alternately, this module is packaged with the [poetry][py-poetry] dependency +manager and can be run within a poetry virtualenv. + +```sh +poetry run python -m ucsinfer +``` + +[py-poetry]: https://python-poetry.org/docs/1.8/cli/#run$0 + ## Running ```sh From 75dae280209de222f36cf7e49766947397fe9b21 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Wed, 27 Aug 2025 20:20:40 +0000 Subject: [PATCH 2/4] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cdb0540..fd7bada 100644 --- a/README.md +++ b/README.md @@ -10,18 +10,18 @@ do an [editable install](https://pip.pypa.io/en/stable/topics/local-project-inst in a [virtual environment](https://docs.python.org/3/library/venv.html). ```sh -git clone https://git.squad51.us/jamie/ucsinfer.git -git submodule sync -python -m venv .venv -source .venv/bin/activate # or whatever command is approprate for your shell -pip install -e . +$ git clone https://git.squad51.us/jamie/ucsinfer.git +$ git submodule sync +$ python -m venv .venv +$ source .venv/bin/activate # or whatever command is approprate for your shell +$ pip install -e . ``` Or alternately, this module is packaged with the [poetry][py-poetry] dependency manager and can be run within a poetry virtualenv. ```sh -poetry run python -m ucsinfer +$ poetry run python -m ucsinfer ``` [py-poetry]: https://python-poetry.org/docs/1.8/cli/#run$0 From a7dafaa941d0f07145151aad1c30097b13e41e11 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Wed, 27 Aug 2025 20:21:34 +0000 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fd7bada..5d4765c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Universal Category System LLM toolkit. ## Install Since this project is still experimental and not for production, it's not -packaged on PyPi. You should cloen the project to your local machine and +packaged on PyPi. You should clone the project to your local machine and do an [editable install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs) in a [virtual environment](https://docs.python.org/3/library/venv.html). From 1ff95542e029e3b98f6605dd15468f2bf1159765 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Wed, 27 Aug 2025 20:22:06 +0000 Subject: [PATCH 4/4] Update ucsinfer/__main__.py Spelling --- ucsinfer/__main__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ucsinfer/__main__.py b/ucsinfer/__main__.py index 1b3433b..a6c9061 100644 --- a/ucsinfer/__main__.py +++ b/ucsinfer/__main__.py @@ -77,7 +77,7 @@ def finetune(): default='dataset.csv') def evaluate(dataset, offset, limit, model, no_foley): """ - Use datasets to evauluate model performance + Use datasets to evaluate model performance """ m = SentenceTransformer(model) ctx = InferenceContext(m, model)