Update README.md

README.md

@@ -1,199 +1,209 @@
 ---
+license: apache-2.0
+base_model:
+- Qwen/Qwen3.5-0.8B
+base_model_relation: finetune
+language:
+- en
+- zh
+pipeline_tag: text-generation
+tags:
+- code
+- spatial
+- SQL
+- GIS
+- PostGIS
 library_name: transformers
-tags: []
 ---
 
-# Model Card for Model ID
+### Model Information
 
-<!-- Provide a quick summary of what the model is/does. -->
+This model, Qwen-3.5-0.8B-Spatial-SQL-1.1, is an 0.8B, narrow use case, text to spatial SQL, lightly fine-tuned model. In general, its primary use case
+is the Natural Language command adaptation of particular geographic spatial functions as normally defined in pure SQL. Data input should be a combination of an English prefix in the form of a question, and a coordinate prompt injection, likely from an active mapping system application coordinate list. Output is PostGIS spatial SQL.
 
+There are five primary geographic functions released in version 1.1.
 
+**Model developer**: Mark Rodrigo
 
-## Model Details
+**Github**: https://github.com/mprodrigo/spatialsql
 
-### Model Description
+**Model Architecture**: The model is a QLoRA / Supervised Fine Tuning (SFT)
 
-<!-- Provide a longer summary of what this model is. -->
+### Model Input / Output Overview:
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+Input: Text plus coordinate prompt injection.
+</br>
+Output: **PostGIS spatial SQL**
+</br>
+NOTE: Inputs and outputs are in meters and or geographic decimal degrees WGS 84 coordinates.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+| Function  |  Question Input  | Geo Input | SQL Execution Output      |
+|:---------:|:----------------:|:---------:|:-------------------------:|
+| Area      |  Area question   | Polygon   | Number - Area sq meters   |
+| Centroid  |  Center question | Polygon   | Point                     |
+| Buffer    |  Buffer distance | Point     | Polygon                   |
+| Length    |  Length question | Line      | Number - Length in meters |
 
-### Model Sources [optional]
+</br>
 
-<!-- Provide the basic links for the model. -->
+| Function  |  Question Input  | Geo Input 1             |  Geo Input 2            |               SQL Execution Output             |
+|:---------:|:----------------:|:-----------------------:|:-----------------------:|:-----------------------------------------------|
+| Distance  | Distance question| Point, Line, or Polygon | Point, Line, or Polygon | Number - Distance between geometries in meters |
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+### Example Prompt / Prompt File
 
-## Uses
+<|begin_of_text|><|start_header_id|>system<|end_header_id|>
+<p></p>
+You are a helpful assistant. You are an expert at PostGIS and Postgresql and SQL and psql.
+<p></p>
+<|eot_id|><|start_header_id|>user<|end_header_id|>
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+\### Instruction: Write a PostGIS SQL statement for the following.
+<p></p>
 
-### Direct Use
+\### Input:
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+<p></p>
+{input}
 
-[More Information Needed]
+<p></p>
 
-### Downstream Use [optional]
+\### Response:
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+<|eot_id|><|start_header_id|>assistant<|end_header_id|>
 
-[More Information Needed]
 
-### Out-of-Scope Use
+### Examples
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+AREA
+<p></p>
 
-## Bias, Risks, and Limitations
+\### Input: What is the area for the polygon? : 'Polygon ((-3.7515154 40.3855551, -3.7514972 40.3856581, -3.7507005 40.3855767, -3.7507167 40.3854722, -3.7515154 40.3855551))'
+<p></p>
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+\### Response: SELECT ST_Area(geog) As area FROM (select 'Polygon ((-3.7515154 40.3855551, -3.7514972 40.3856581, -3.7507005 40.3855767, -3.7507167 40.3854722, -3.7515154 40.3855551))' :: geography geog) subquery;
+<p></p>
 
-[More Information Needed]
+CENTROID
+<p></p>
 
-### Recommendations
+\### Input: What is the centroid for the polygon? : 'Polygon ((-3.6934636 40.4808785, -3.6933352 40.4811486, -3.6930125 40.4810598, -3.693141 40.4807897, -3.6934636 40.4808785))'
+<p></p>
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+\### Response: SELECT ST_AsText(ST_Centroid(geog)) As centroid FROM (select 'Polygon ((-3.6934636 40.4808785, -3.6933352 40.4811486, -3.6930125 40.4810598, -3.693141 40.4807897, -3.6934636 40.4808785))' :: geography geog) subquery;
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+BUFFER
+<p></p>
 
-## How to Get Started with the Model
+\### Input: What is the thousand meter buffer for the following point? : 'Point(-8.7522658 41.3862664)'
+<p></p>
 
-Use the code below to get started with the model.
+\### Response: SELECT ST_AsText(ST_Buffer(geog, 1000)) as buffer FROM (select 'Point(-8.7522658 41.3862664)' :: geography geog) subquery;
 
-[More Information Needed]
+<p></p>
+LENGTH
+<p></p>
 
-## Training Details
+\### Input: How long is the line? : 'LINESTRING (-3.6976693 40.4263178, -3.6986082 40.4258729)'
+<p></p>
 
-### Training Data
+\### Response: SELECT ST_Length(geog) As length FROM (select 'LINESTRING (-3.6976693 40.4263178, -3.6986082 40.4258729)' :: geography geog) subquery;
+<p></p>
+DISTANCE
+<p></p>
 
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
+\### INPUT: How far apart is the point and line? : 'Point(-109.87549823 38.60574249)' 'LineString(-109.24324628 38.76349931, -109.4821773 38.6875815)'
+<p></p>
 
-[More Information Needed]
+\### Response: SELECT ST_Distance(gg1, gg2) As distance FROM (select 'Point(-109.87549823 38.60574249)' :: geography gg1, 'LineString(-109.24324628 38.76349931, -109.4821773 38.6875815)' :: geography gg2) subquery;
+<p></p>
 
-### Training Procedure
+### A Few Known Question Variation Examples
 
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+<p></p>
+AREA
+<p></p>
+What is the area for the geometry?
+<p></p>
+What is the area for this polygon?
+<p></p>
+CENTROID
+<p></p>
+What is the centroid for the geometry?
+<p></p>
+What is the center point of the polygon?
+<p></p>
+BUFFER
+<p></p>
+What is the 100 meter buffer for the following point?
+<p></p>
+Buffer the following point a thousand meters.
+<p></p>
+What is the 1000 meter buffer for the following point? 
+<p></p>
+LENGTH
+<p></p>
+What is the length of the line?
+<p></p>
+How long is this line?
+<p></p>
+DISTANCE
+<p></p>
+The distance between the polygon and the line is?
+<p></p>
+What is the distance between the points?
+<p></p>
+How far apart are the two lines?
 
-#### Preprocessing [optional]
+### llama.cpp / Hyperparameter Recommendations For Inference
+max context ~ 262,000
+<p></p>
+top k ~ 100
+<p></p>
+temp ~ .4-.5 or lower
 
-[More Information Needed]
+### Agent Considerations
+Agents are being considered as a separate project. Agents would mostly be related to pulling the coordinates from a mapping UI, and executing the SQL from responses against a PostGIS database.
 
+### Further Reference - link this
+https://postgis.net/docs/manual-3.3/PostGIS_Special_Functions_Index.html#PostGIS_GeographyFunctions
 
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+### Evaluation data
+More information needed
+
+### Training data
+Custom synthetic
+
+### Training hyperparameters
+
+The following hyperparameters were used during training:
+- learning_rate: 1e-4
+- distributed_type: multi-GPU
+- num_devices: 2
+- optimizer: Adam 8bit
+- lr_scheduler_type: linear
+
+### Training results
+
+| Training Loss | Step | Validation Loss |
+|:-------------:|:----:|:---------------:|
+| 1.1339        |  10  |   0.9006        |
+| 0.8021        |  20  |   0.7433        |
+| 0.7347        |  30  |   0.6840        |
+| 0.6844        |  40  |   0.6384        |
+| 0.6200        |  50  |   0.5959        |
+| 0.5957        |  60  |   0.5635        |
+| 0.5564        |  70  |   0.5511        |
+
+
+
+
+### Framework versions
+
+- transformers 5.14.1
+- torch 2.13.0
+- peft 0.20.0
+- bitsandbytes 0.50.0
+- datasets 5.0.1
+- tokenizers 0.23.1