sequelbox commited on
Commit
5fbd4fc
·
verified ·
1 Parent(s): f444eed

model card

Browse files
Files changed (1) hide show
  1. README.md +109 -0
README.md ADDED
@@ -0,0 +1,109 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - en
4
+ library_name: transformers
5
+ pipeline_tag: text-generation
6
+ tags:
7
+ - qwen
8
+ - qwen-3
9
+ - qwen-3-14b
10
+ - 14b
11
+ - reasoning
12
+ - uml-generator
13
+ - uml
14
+ - unified-modeling-language
15
+ - modeling
16
+ - xml
17
+ - xmi
18
+ - code
19
+ - architecture
20
+ - devops
21
+ - planning
22
+ - diagrams
23
+ - state-machine
24
+ - design
25
+ - analysis
26
+ - development
27
+ - business-process
28
+ - systems-engineering
29
+ - reverse-engineering
30
+ - data-modeling
31
+ - services
32
+ - cloud
33
+ - problem-solving
34
+ - creative
35
+ - analytical
36
+ - expert
37
+ - rationality
38
+ - conversational
39
+ - chat
40
+ - instruct
41
+ base_model: Qwen/Qwen3-14B
42
+ datasets:
43
+ - sequelbox/UML-Generator-Dataset-DeepSeek-V3.2
44
+ license: apache-2.0
45
+ ---
46
+
47
+
48
+ **[Support our open-source dataset and model releases!](https://huggingface.co/spaces/sequelbox/SupportOpenSource)**
49
+
50
+
51
+ UML Generator: [Qwen3-4B-Thinking-2507](https://huggingface.co/sequelbox/Qwen3-4B-Thinking-2507-UML-Generator), [Qwen3-14B](https://huggingface.co/sequelbox/Qwen3-14B-UML-Generator), [gpt-oss-20b](https://huggingface.co/sequelbox/gpt-oss-20b-UML-Generator), [gpt-oss-120b](https://huggingface.co/sequelbox/gpt-oss-120b-UML-Generator)
52
+
53
+
54
+ **UML Generator is one of our [Experimental Reasoning Models](https://huggingface.co/collections/sequelbox/experimental-reasoning-models) with custom output format**; for standard chat, try [Shining Valiant 3](https://huggingface.co/collections/ValiantLabs/shining-valiant-3) or [Esper 3.1!](https://huggingface.co/collections/ValiantLabs/esper-31)
55
+
56
+
57
+ UML Generator is a specialist code-reasoning assistant, performing situational analysis and reasoning to create **Unified Modeling Language diagrams.**
58
+ - Finetuned on our [UML creation dataset](https://huggingface.co/datasets/sequelbox/UML-Generator-Dataset-DeepSeek-V3.2) data generated with [DeepSeek-V3.2!](https://huggingface.co/deepseek-ai/DeepSeek-V3.2-Exp)
59
+ - Multi-step reasoning reliably identifies diagram structure before a user response of XMI 2.5.1 code containing the UML diagram.
60
+ - UML Generator Format provides a single clear, readable XMI that is ready to load into the UML tools of your choice.
61
+ - Trained in a variety of subjects for flexible analysis: software architecture, software development, business processes, systems engineering, data modeling, microservices, reverse engineering and more!
62
+ - Small model sizes allow running on local desktop and mobile, plus super-fast server inference!
63
+
64
+
65
+ ## Prompting Guide
66
+ UML Generator uses the [Qwen3-14B](https://huggingface.co/Qwen/Qwen3-14B) prompt format to create an XMI 2.5.1 file using [UML Generator Format.](https://huggingface.co/datasets/sequelbox/UML-Generator-Dataset-DeepSeek-V3.2)
67
+
68
+ UML Generator is an **experimental reasoning finetune:**
69
+ - the assistant performs multi-step reasoning during the thinking phase, before producing a user response containing only the XMI code block.
70
+ - request the assistant to "Generate UML" and describe the situation to be analyzed in order to prompt for the [UML Generator Format;](https://huggingface.co/datasets/sequelbox/UML-Generator-Dataset-DeepSeek-V3.2) see the example script below for examples. Focus on clearly articulating your requirements and allow the UML generator to perform analysis and generate your XMI file.
71
+ - structural validation of outputs is strongly recommended for production contexts. the reasoning section contains four reasoning steps and the final user response contains only XMI code.
72
+ - we generally recommend reasoning level high for all chats.
73
+
74
+ Example inference script to get started:
75
+
76
+ ```python
77
+ from transformers import pipeline
78
+ import torch
79
+
80
+ model_id = "sequelbox/Qwen3-14B-UML-Generator"
81
+
82
+ pipe = pipeline(
83
+ "text-generation",
84
+ model=model_id,
85
+ torch_dtype="auto",
86
+ device_map="auto",
87
+ )
88
+
89
+ prompt = "Generate a UML class diagram modeling a feature toggle framework. A FeatureToggleManager provides an isEnabled(featureName) method. The manager's implementation must be designed using the Strategy pattern, where it delegates the actual check to an IFeatureToggleStrategy interface. This allows the framework to support different backends (e.g., ConfigFileStrategy, DatabaseStrategy, CloudConfigStrategy) for storing the toggle states."
90
+ #prompt = "Generate a UML component diagram for a CAN bus interface, clearly separating the hardware and software. Show a Vehicle_Control_App component requiring an I_CAN_Message interface (e.g., sendMessage(id, data)). This interface is provided by a CAN_HAL component. The CAN_HAL component, in turn, requires an I_CAN_Registers interface, which is provided by the <<hardware>>CAN_Controller component. The <<hardware>>CAN_Controller is then connected to a <<device>>CAN_Transceiver."
91
+ #prompt = "Generate a UML composite structure diagram for a HospitalInformationSystem component. This system must show its internal parts (subsystems): PatientAdmissions, ElectronicHealthRecord (EHR), Billing, and Pharmacy. PatientAdmissions must be connected to EHR and Billing. EHR must be connected to Pharmacy and Billing. The EHR part must also expose an external port HL7_Interface for communicating with external lab systems."
92
+ #prompt = "Generate a UML State Machine Diagram for an avionics Flight Mode Annunciator. The FMA must have two orthogonal regions: Autothrottle (States: Off, ARM, N1, SPEED) and Autopilot (States: Off, FD (Flight Director), CMD). The Autopilot region must also be a composite state with nested orthogonal regions for LateralMode (States: LNAV, HDG_SEL) and VerticalMode (States: LVNAV, ALT_HOLD). A TakeoffGoAround (TOGA) event must force-transition all regions to their respective armed/takeoff states."
93
+
94
+ messages = [
95
+ {"role": "user", "content": prompt},
96
+ ]
97
+
98
+ outputs = pipe(
99
+ messages,
100
+ max_new_tokens=16000,
101
+ )
102
+ print(outputs[0]["generated_text"][-1])
103
+
104
+ ```
105
+
106
+
107
+ UML Generator is one of our [experimental reasoning releases;](https://huggingface.co/collections/sequelbox/experimental-reasoning-models) we've got more to come soon!
108
+
109
+ Do as you will.