Create README.md

README.md

@@ -0,0 +1,37 @@
+---
+pipeline_tag: text-generation
+inference: false
+license: apache-2.0
+library_name: transformers
+tags:
+- granite-3.3
+- guardian
+- gguf
+base_model:
+- ibm-granite/granite-guardian-3.3-8b
+---
+
+> [!NOTE]
+> This repository contains models that have been converted to the GGUF format with various quantizations from an IBM Granite base model.
+>
+> Please reference the base model's full model card here:
+> https://huggingface.co/ibm-granite/granite-guardian-3.3-8b
+
+# granite-guardian-3.3-8b-GGUF
+
+**Model Summary:** Granite Guardian 3.3 8b is a specialized Granite 3.3 8B model designed to judge if the input prompts and the output responses of an LLM based system meet specified criteria.  The model comes pre-baked with certain criteria including but not limited to: jailbreak attempts, profanity, and hallucinations related to tool calls and retrieval augmented generation in agent-based systems. Additionally, the model also allows users to bring their own criteria and tailor the judging behavior to specific use-cases.
+
+This version of Granite Guardian is a hybrid thinking model that allows the user to operate in thinking or non-thinking model.
+In thinking mode, the model produces detailed reasoning traces though ```<think> ... </think> ```and ```<score> ... </score>``` tags.
+In non-thinking mode, the model only produces the judgement score though the ```<score> ... </score>``` tags.
+
+It is trained on unique data comprising human annotations and synthetic data informed by internal red-teaming. 
+It outperforms other open-source models in the same space on standard benchmarks.
+
+- **Developers:** IBM Research
+- **GitHub Repository:** [ibm-granite/granite-guardian](https://github.com/ibm-granite/granite-guardian)
+- **Cookbook:** [Granite Guardian Recipes](https://github.com/ibm-granite/granite-guardian/tree/main/cookbooks/granite-guardian-3.3)
+- **Website**: [Granite Guardian Docs](https://www.ibm.com/granite/docs/models/guardian/)
+- **Paper:** [Granite Guardian](https://arxiv.org/abs/2412.07724)
+- **Release Date**: August 1, 2025
+- **License:** [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)