kgreenewald commited on
Commit
cb04941
1 Parent(s): 77cf713

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +1 -0
README.md CHANGED
@@ -29,6 +29,7 @@ which adds hallucination detection and citation generation capability, in additi
29
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
30
 
31
  ### Intended use
 
32
  **Granite RAG 3.0 8b** is a LoRA adaptor for [ibm-granite/granite-3.0-8b-instruct](https://huggingface.co/ibm-granite/granite-3.0-8b-instruct). This is a RAG specific adaptor which gives the ability to generate an output, detect whether hallucinations exist in the generated output and generate citations for the generate output. The output is generated as a json object, which contains output sentences, hallucination detections and citations.
33
 
34
  **Model input**: The input to the model is a list of conversational turns converted to a string using `apply_chat_template` function. The first turn of the conversation is a `system` turn, the `content` field of which contains a json structure (converted to string). The json structure includes:
 
29
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
30
 
31
  ### Intended use
32
+ This is an experimental LoRA testing new functionality being developed for IBM's Granite LLM family. We are welcoming the community to test it out and give us feedback, but we are NOT recommending this model be used for real deployments at this time. Stay tuned for more updates on the Granite roadmap.
33
  **Granite RAG 3.0 8b** is a LoRA adaptor for [ibm-granite/granite-3.0-8b-instruct](https://huggingface.co/ibm-granite/granite-3.0-8b-instruct). This is a RAG specific adaptor which gives the ability to generate an output, detect whether hallucinations exist in the generated output and generate citations for the generate output. The output is generated as a json object, which contains output sentences, hallucination detections and citations.
34
 
35
  **Model input**: The input to the model is a list of conversational turns converted to a string using `apply_chat_template` function. The first turn of the conversation is a `system` turn, the `content` field of which contains a json structure (converted to string). The json structure includes: