Merge branch 'master' of https://git.squad51.us/jamie/ucsinfer

README.md

@@ -1,6 +1,6 @@
 # ucsinfer
 
-Universal Category System inference.
+Universal Category System LLM toolkit.
 
 ## Running 
 
@@ -13,19 +13,21 @@ The subcommands available at this time are `gather` and `evaluate`.
 
 ## Functions
 
-* recommend
+* ~recommend~ (in-progress)
 
   Infer a UCS category for a text description.
 
 * gather
 
-  Scan files to capture existing text descriptions and UCS categories and save 
-  as a dataset.
+  Scan files to capture existing text descriptions and UCS categories 
+  and save as a dataset. This function is used to countruct datasets 
+  that `evaluate` can use to test models and finetune can use to 
+  refine them.
 
-* finetune 
+* ~finetune~ (planned)
 
   Fine-tune an existing sentence embedding model with training data.
 
 * evaluate
 
-  Use datasets to evauluate the performance of fine-tuning.
+  Use datasets to evaluate the performance of a model and fine-tuning.