Update README.md
This commit is contained in:
24
README.md
24
README.md
@@ -2,6 +2,30 @@
|
|||||||
|
|
||||||
Universal Category System LLM toolkit.
|
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
|
## Running
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
Reference in New Issue
Block a user