From 3133c73bd64995d12df7e2cdd892ff45b264eb20 Mon Sep 17 00:00:00 2001 From: Kevin McKee Date: Thu, 8 May 2025 14:30:16 -0700 Subject: [PATCH 1/3] Doc updates --- README.md | 41 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 37 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2663b1a..0449e08 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,41 @@ The VimAssistant package processes natural language (spoken or typed) to take ac This package utilizes Speech Recognition to transcribe spoken text that gets sent to a CoreML LLM/LAM that will attempt to execute an action on the users behalf. -Some examples of actions include (but not limited to): +Some examples of categorized actions include (but not limited to): -* `"Isolate all HVAC components."` -* `"Create a section box around level 1."` -* `"Hide all walls."` +* **ISOLATE**: "Isolate furniture", "Only show me the network jacks", "Filter everything but the curtain panels" +* **HIDE**: "Conceal all ceiling systems", "Hide air terminals", "Remove all walls" +* **QUANTIFY**: "Count all doors", "What are the total number of access doors?", "How many transformers are there?" + +### Label Scheme +The base model was created with the OntoNotes 5.0 NER annotations which includes: + +* **PERSON**: Individual names (e.g., Barack Obama). +* **ORGANIZATION**: Company or institution names (e.g., Apple). +* **LOCATION**: Geographical places (e.g., Tokyo). +* **DATE**: Dates (e.g., May 8, 2025). +* **TIME**: Times (e.g., 10:00 AM). +* **EVENT**: Names of events (e.g., World Series). +* **WORK\_OF\_ART**: Names of works of art (e.g., "Hamlet"). +* **FAC**: Buildings or facilities (e.g., White House). +* **GPE**: Geo-political entities (e.g., United States). +* **LANGUAGE**: Names of languages (e.g., English). +* **LAW**: Legal names (e.g., The Constitution). +* **NORP**: National/religious/political group (e.g., Democrats). +* **CARDINAL**: Cardinal numbers (e.g., 1, 2, 3). + +The trained model provides provided Construction NER annotations: + +* **CON-BIM-CATG**: BIM Category - a high-level classification for families and elements, grouping them based on their functional type. +* **CON-BIM-FAML**: BIM Family - a collection of elements that share common properties, behaviors, and physical characteristics. +* **CON-BIM-TYPE**: BIM Type - a specific instantiation of a family that defines a unique set of parameters, essentially a variation within a family. Think of it as a specific size, material, or configuration of a particular family, such as a 3' x 6' door within a door family. +* **CON-BIM-INST**: BIM Instance - a single, unique occurrence of a family type placed within a model. +* **CON-BIM-LEVL**: BIM Level - a horizontal plane used to define the vertical position of elements like walls, floors, and ceilings. +* **CON-BIM-VIEW**: BIM View - represents a specific way of looking at the model, whether it's a 2D plan, elevation, section, or 3D view. + + + +| Component | Labels | +| -------- | ------- | +| named entities | CARDINAL, DATE, EVENT, FAC, GPE, LANGUAGE, LAW, LOC, MONEY, NORP, ORDINAL, ORG, PERCENT, PERSON, PRODUCT, QUANTITY, TIME, WORK_OF_ART, CON-BIM-CATG, CON-BIM-FAML, CON-BIM-TYPE, CON-BIM-INST, CON-BIM-LEVL, CON-BIM-VIEW | +| categories | ISOLATE, HIDE, QUANTIFY | From ebcabe3e006ff04b94c25388c5e3f8f35fc090a6 Mon Sep 17 00:00:00 2001 From: Code Fiesta <17772633+codefiesta@users.noreply.github.com> Date: Thu, 8 May 2025 14:33:10 -0700 Subject: [PATCH 2/3] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0449e08..33aa041 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ # VimAssistant VimAssistant is a AI powered productivity assistant to [VimKit](https://github.com/codefiesta/VimKit) that helps users complete tasks more efficiently. +assistant ## Overview The VimAssistant package processes natural language (spoken or typed) to take action on a VIM model. From 871ec0ea7433a51efdf0ab890e20f7e1396aad4b Mon Sep 17 00:00:00 2001 From: Code Fiesta <17772633+codefiesta@users.noreply.github.com> Date: Thu, 8 May 2025 14:34:09 -0700 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 33aa041..ec3bb77 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ The base model was created with the OntoNotes 5.0 NER annotations which includes * **NORP**: National/religious/political group (e.g., Democrats). * **CARDINAL**: Cardinal numbers (e.g., 1, 2, 3). -The trained model provides provided Construction NER annotations: +The trained model provides Construction NER annotations: * **CON-BIM-CATG**: BIM Category - a high-level classification for families and elements, grouping them based on their functional type. * **CON-BIM-FAML**: BIM Family - a collection of elements that share common properties, behaviors, and physical characteristics.