From f40a336893c59077426c6f813e02ee1d7557e856 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Wed, 27 Aug 2025 00:27:21 +0000 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b3ca746..f5bc9f2 100644 --- a/README.md +++ b/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.