Upload model README

README.md

@@ -1,81 +1,104 @@
-# SM Coder 1.5B
-
-SM Coder is a fine-tuned coding assistant focused on SuperMongo (SM) macro development for scientific plotting workflows.
-
-This README is intended as the public model card for Hugging Face uploads.
+---
+language:
+  - en
+license: apache-2.0
+base_model: Qwen/Qwen2.5-Coder-1.5B-Instruct
+base_model_relation: finetune
+tags:
+  - supermongo
+  - astronomy
+  - code-generation
+  - scientific-plotting
+pipeline_tag: text-generation
+library_name: gguf
+---
+
+# SM Coder 1.5B — GGUF
+
+A fine-tuned coding assistant for **SuperMongo (SM)** macro development,
+packaged as a quantized GGUF file for use with [Ollama](https://ollama.com)
+or [llama.cpp](https://github.com/ggerganov/llama.cpp).
+
+| File | Quant | Size |
+|------|-------|------|
+| `sm-coder-1.5b-q4_k_m.gguf` | Q4_K_M | ~1 GB |
+
+## Quick Start (Ollama)
+
+```bash
+# create the model from the bundled Modelfile
+ollama create sm-coder -f Modelfile.finetuned
+
+# chat
+ollama run sm-coder "Write an SM macro to overplot error bars"
+```
 
-## Model Repositories
+## Base Model
 
-- GGUF (Ollama / llama.cpp): https://huggingface.co/xpol555/sm-coder-gguf
-- MLC (WebLLM / browser deployment): https://huggingface.co/xpol555/sm-coder-mlc
+[Qwen/Qwen2.5-Coder-1.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-Coder-1.5B-Instruct),
+fine-tuned on a curated dataset of SM macros and related examples collected
+over ~20 years of real scientific usage.
 
 ## What Is SuperMongo
 
-SuperMongo is a plotting and data-analysis environment widely used in astronomy and scientific workflows.
-
-Reference:
-- https://www.astro.princeton.edu/~rhl/sm/
-
-## Dataset and Scope
+SuperMongo is a plotting and data-analysis environment widely used in
+astronomy and scientific workflows.
 
-This model was developed on a curated dataset of SM macros and related examples collected and evolved over about 20 years of real usage.
-
-The training data emphasizes:
-- reusable plotting macros
-- parameterized workflow helpers
-- practical data visualization patterns used in long-running scientific analysis
+Reference: <https://www.astro.princeton.edu/~rhl/sm/>
 
 ## Intended Use
 
-- writing and refactoring SuperMongo macros
-- translating plotting requests into SM macro skeletons
-- helping document and modernize legacy macro collections
+- Writing and refactoring SuperMongo macros.
+- Translating plotting requests into SM macro skeletons.
+- Helping document and modernize legacy macro collections.
 
-## Not Intended As
+## Limitations
 
-- a general-purpose chatbot
-- an authoritative source on non-SM domains
-- a replacement for validation/testing of scientific plots
+- Not a general-purpose chatbot.
+- Not an authoritative source on non-SM domains.
+- Always validate generated macros against your SM version and local macro
+  library before use.
 
 ## Example Prompts
 
-- "Write an SM macro to draw concentric circles with configurable center and step."
-- "Create an SM macro that computes min/max from two vectors and sets plotting limits."
-- "Refactor this old SM macro into smaller parameterized helpers."
+- *"Write an SM macro that draws concentric circles given a center, starting
+  radius, step, and count."*
+- *"Write an SM macro that reads two columns from a file and plots them with
+  auto-scaled limits."*
+- *"Refactor this SM macro into smaller reusable helpers."*
 
-## Example Macro Ideas
+## Example Output
 
-The model can propose macro structures like these (adapt names and details to your local SM setup):
+The model produces macros in standard SM syntax (positional `$1 $2 …`
+parameters, `set` for vectors, `define` for scalars):
 
-```sm
-define draw_circle (xc,yc,r,npt) {
-	set _th = 2*3.14159265*indgen(npt)/npt
-	set _x = xc + r*cos(_th)
-	set _y = yc + r*sin(_th)
-	connect _x _y
-}
+```
+draw_circle 4   ## draw a circle centred at ($1,$2) radius $3 with $4 points
+        set _th = 2*PI*indgen($4)/$4
+        set _cx = $1 + $3*COS(_th)
+        set _cy = $2 + $3*SIN(_th)
+        connect _cx _cy
+```
 
-define draw_concentric (xc,yc,r0,dr,nr,npt) {
-	do i = 0, nr-1 {
-		set _r = r0 + i*dr
-		draw_circle(xc,yc,_r,npt)
-	}
-}
+```
+quickplot 1     ## read two-column file $1, auto-scale, and plot
+        data $1
+        read {x 1 y 2}
+        limits x y
+        erase
+        box
+        connect x y
+        xlabel Column 1
+        ylabel Column 2
 ```
 
-```sm
-define autoscale_xy (xv,yv,pad) {
-	set _xmin = min(xv)
-	set _xmax = max(xv)
-	set _ymin = min(yv)
-	set _ymax = max(yv)
-	limits (_xmin-pad) (_xmax+pad) (_ymin-pad) (_ymax+pad)
-	box
-}
+```
+oploterr 4      ## overplot error bars on current axes for x=$1 y=$2 ey=$3
+        set _ylo = $2 - $3
+        set _yhi = $2 + $3
+        error_y $1 $2 _ylo _yhi
 ```
 
-## Notes
+## Other Formats
 
-- Validate generated macros against your SM version and local macro library.
-- For browser usage, prefer the MLC repository.
-- For local inference with Ollama/llama.cpp, prefer the GGUF repository.
+- **MLC (WebLLM / browser):** <https://huggingface.co/xpol555/sm-coder-mlc>