Restructured
Hav removed suggestions for now, have added dataset gathering and evaluation.
This commit is contained in:
30
README.md
30
README.md
@@ -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.
|
||||
|
Reference in New Issue
Block a user