Upload README.md

README.md

@@ -1,3 +1,102 @@
----
-license: apache-2.0
----
+---
+license: cc-by-sa-4.0
+inference: false
+---
+
+# SLIM-SUMMARY
+
+<!-- Provide a quick summary of what the model is/does. -->
+
+**slim-summary** is a small, specialized model finetuned for summarize function-calls, generating output consisting of a python list of distinct summary points.  
+
+As an experimental feature in the model, there is an optional list size that can be passed with the parameters in invoking the model to guide the model to a specific number of response elements.  
+
+Input is a text passage, and output is a list of the form:  
+
+&nbsp;&nbsp;&nbsp;&nbsp;`['summary_point1', 'summary_point2', 'summary_point3']`
+
+This model is 2.7B parameters, small enough to run on a CPU, and is fine-tuned on top of [**llmware/bling-stable-lm-3b-4e1t-v0**](https://huggingface.co/llmware/bling-stable-lm-3b-4e1t-v0), which in turn, is a fine-tune of stabilityai/stablelm-3b-4elt.
+
+For fast inference use of this model, we would recommend using the 'quantized tool' version, e.g.,  [**'slim-summary-tool'**](https://huggingface.co/llmware/slim-summary-tool).  
+
+## Usage Tips  
+
+-- Automatic (ast.literal_eval) conversion of the llm output to a python list is often complicated by the presence of '"' (ascii 34 double quotes) and "'" (ascii 39 single quote).  We have provided a straightforward string remediation handler in [llmware](https://www.github.com/llmware-ai/llmware.git) that automatically remediates and provides a well-formed Python list.  We have tried multiple ways to handle 34/39 in training - and each has a set of trade-offs - we will continue to look for ways to better automate in future releases of the model.  
+
+-- If you are looking for a single output point, try the params: "brief description (1)"  
+
+-- If the document has a lot of financial points, try the params "financial data points" or "financial data points (5)"  
+
+-- Param counts are an experimental feature, but work reasonably well to guide the scope of the model's output length.  At times, the model's attempt to match the target number of output points will result in some repetitive points.  
+
+
+## Prompt format:
+
+`function = "summarize"`  
+`params = "key points (3)"`  
+`prompt = "<human> " + {text} + "\n" + `  
+&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; &nbsp; &nbsp; &nbsp;`"<{function}> " + {params} + "</{function}>" + "\n<bot>:"`  
+
+
+<details>
+<summary>Transformers Script </summary>
+
+    model = AutoModelForCausalLM.from_pretrained("llmware/slim-summary")
+    tokenizer = AutoTokenizer.from_pretrained("llmware/slim-summary")
+
+    function = "summarize"
+    params = "key points (3)"
+
+    text = "Tesla stock declined yesterday 8% in premarket trading after a poorly-received event in San Francisco yesterday, in which the company indicated a likely shortfall in revenue."  
+    
+    prompt = "<human>: " + text + "\n" + f"<{function}> {params} </{function}>\n<bot>:"
+
+    inputs = tokenizer(prompt, return_tensors="pt")
+    start_of_input = len(inputs.input_ids[0])
+
+    outputs = model.generate(
+        inputs.input_ids.to('cpu'),
+        eos_token_id=tokenizer.eos_token_id,
+        pad_token_id=tokenizer.eos_token_id,
+        do_sample=True,
+        temperature=0.3,
+        max_new_tokens=100
+    )
+
+    output_only = tokenizer.decode(outputs[0][start_of_input:], skip_special_tokens=True)
+
+    print("output only: ", output_only)  
+
+    # here's the fun part
+    try:
+        output_only = ast.literal_eval(llm_string_output)
+        print("success - converted to python dictionary automatically")
+    except:
+        # note: rules-based conversion may be required - see comment above - and remediation script @ https://www.github.com/llmware-ai/llmware/blobs/main/llmware/models.py - ModelCatalog.remediate_function_call_string()
+        # for good example of post-processing conversion script
+        
+        print("fail - could not convert to python dictionary automatically - ", llm_string_output)
+     
+   </details>  
+ 
+<details>  
+
+
+
+    
+<summary>Using as Function Call in LLMWare</summary>
+
+    from llmware.models import ModelCatalog
+    slim_model = ModelCatalog().load_model("llmware/slim-summary")
+    response = slim_model.function_call(text,params=["key points (3)], function="summarize")
+
+    print("llmware - llm_response: ", response)
+
+</details>  
+
+    
+## Model Card Contact
+
+Darren Oberst & llmware team  
+
+[Join us on Discord](https://discord.gg/MhZn5Nc39h)