diff --git a/README.md b/README.md index f5bc9f2..5d4765c 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 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). + +```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 diff --git a/ucsinfer/__main__.py b/ucsinfer/__main__.py index eb12650..de27a56 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)