Update README.md

README.md

@@ -2,8 +2,40 @@
 language: en
 widget:
 - text: "translate English to SQL: feel good story since yesterday"
-inference:
-  parameters:
-    max_new_tokens: 250
 license: apache-2.0
 ---
+
+# T5-small finedtuned to generate txtai SQL
+
+[T5 small](https://huggingface.co/t5-small) fine-tuned to generate [txtai](https://github.co/neuml/txtai) SQL. This model takes natural language queries and builds txtai-compatible SQL statements.
+
+txtai supports both natural language queries
+
+```
+Tell me a feel good story
+Show me stories about wildlife
+Sports stories about hockey
+```
+
+and SQL statements
+
+```
+select * from txtai where similar("Tell me a feel good story") and entry >= date('now()', '-1 day')
+```
+
+This model bridges the gap between the two and enables natural language queries with filters.
+
+```
+Tell me a feel good story since yesterday
+Show me sports stories since yesterday with team name as Red Sox
+Latest news summarized
+Latest news translated to fr
+```
+
+## Custom query syntax
+
+This model is an example of creating a custom query syntax that can be translated into SQL txtai can understand. Any query syntax can be created. This one supports English but a similar strategy can be deployed to support other languages. Natural language can be translated to functions, query clauses, column selection and more. 
+
+## Model training
+
+This model was trained using scripts that can be found here: https://github.com/neuml/txtai/tree/master/models/txtsql