Restructured

Hav removed suggestions for now, have added dataset
gathering and evaluation.
This commit is contained in:
Jamie Hardt
2025-08-26 16:47:35 -07:00
parent ec541458aa
commit 275d1341ab
5 changed files with 215 additions and 186 deletions

View File

@@ -1,3 +1,31 @@
# ucsinfer
Universal Category System inference.
Universal Category System inference.
## Running
```sh
python -m ucsinfer [command]
```
Pass `--help` to see a summary of subcommands and options.
The subcommands available at this time are `gather` and `evaluate`.
## Functions
* recommend
Infer a UCS category for a text description.
* gather
Scan files to capture existing text descriptions and UCS categories and save
as a dataset.
* finetune
Fine-tune an existing sentence embedding model with training data.
* evaluate
Use datasets to evauluate the performance of fine-tuning.