Update README.md

README.md

@@ -5,6 +5,71 @@ tags:
 license: other
 ---
 
-This model has been pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration:
-- Library: [More Information Needed]
-- Docs: [More Information Needed]
+# Model Overview
+
+## Description:
+FineTune-Guard is a deep-learning classification model that helps identify LLM poisoning attacks in datasets.
+It is trained on an instruction:response dataset and LLM poisoning attacks of such data.
+Note that optimal use for FineTune-Guard is for instruction:response datasets.
+
+### License/Terms of Use:
+[NVIDIA Open Model License Agreement](https://developer.download.nvidia.com/licenses/nvidia-open-model-license-agreement-june-2024.pdf)
+
+## Reference:
+The Internal State of an LLM Knows When It's Lying: https://arxiv.org/pdf/2304.13734 <br> 
+
+## Model Architecture:
+**Architecture Type:** FeedForward MLP <br>
+**Network Architecture:** 4 Layer MLP <br>
+
+## Input:
+**Input Type(s):** Text Embeddings <br>
+**Input Format(s):** Numerical Vectors <br>
+**Input Parameters:** 1D Vectors <br>
+**Other Properties Related to Input:** The text embeddings are generated from the [Aegis Defensive Model](https://huggingface.co/nvidia/Aegis-AI-Content-Safety-LlamaGuard-Defensive-1.0). The length of the vectors is 4096. <br>
+
+## Output:
+**Output Type(s):** Classification Scores <br>
+**Output Format:** Array of shape 1 <br>
+**Output Parameters:** 1D <br>
+**Other Properties Related to Output:** Classification scores represent the confidence that the input data is poisoned or not. <br> 
+
+## Software Integration:
+**Runtime Engine(s):** 
+* NeMo Curator: https://github.com/NVIDIA/NeMo-Curator <br>
+* Aegis: https://huggingface.co/nvidia/Aegis-AI-Content-Safety-LlamaGuard-Defensive-1.0 <br>
+
+**Supported Hardware Microarchitecture Compatibility:** <br>
+* NVIDIA GPU <br>
+* Volta™ or higher ([compute capability 7.0+](https://developer.nvidia.com/cuda-gpus)) <br>
+* CUDA 12 (or above)
+
+**Preferred Operating System(s):** Ubuntu 22.04/20.04 <br>
+
+## Model Version(s):
+v1.0  <br>
+
+# Training, Testing, and Evaluation Datasets:
+
+The data used to train this model contained synthetically-generated LLM poisoning attacks. <br>
+
+## Evaluation Benchmarks:
+FineTune-Guard is evaluated based on two overarching criteria: <br>
+* Success on identifying LLM poisoning attacks, after the model was trained on examples of the attacks. <br>
+* Success on identifying LLM poisoning attacks, but without training on examples of those attacks, at all. <br>
+
+Success is defined as having an acceptable catch rate (recall scores for each attack) over a high specificity score (ex. 95%). Acceptable catch rates need to be high enough to identify at least several poisoned records in the attack. <br>
+
+## Inference:
+**Engine:** NeMo Curator and Aegis <br>
+**Test Hardware:** <br>
+* A100 80GB GPU <br>
+
+## How to Use in NeMo Curator:
+The inference code is available on [NeMo Curator's GitHub repository](https://github.com/NVIDIA/NeMo-Curator). <br>
+Check out [this example notebook](https://github.com/NVIDIA/NeMo-Curator/tree/main/tutorials/distributed_data_classification) to get started.
+
+## Ethical Considerations:
+NVIDIA believes Trustworthy AI is a shared responsibility and we have established policies and practices to enable development for a wide array of AI applications.  When downloaded or used in accordance with our terms of service, developers should work with their internal model team to ensure this model meets requirements for the relevant industry and use case and addresses unforeseen product misuse.  
+
+Please report security vulnerabilities or NVIDIA AI Concerns [here](https://www.nvidia.com/en-us/support/submit-security-vulnerability/).