Intel
/

business_safety_logistic_regression_classifier

Joblib

Model card Files Files and versions Community

houminmin commited on Jul 12, 2024

Commit

4b2df98

verified ·

1 Parent(s): 2c36f62

update readme

Browse files

Files changed (1) hide show

README.md +41 -142

README.md CHANGED Viewed

@@ -2,154 +2,53 @@
 license: apache-2.0
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is a logistic regression model that is intended to use with an embedding model to classify if a piece of text contains business sensitive information (1 means yes, 0 means no).
-Please refer to the Training details section below to learn how the model was trained.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-This model is intended to be used in the BusinessSafetyClassifier of the OPEA Guardrail. TODO--> ADD LINK
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-This model is trained and tested with a public dataset (Patronus EnterprisePII). It may not have good accuracy on other datasets. Users of this model should test the performance of this model on their own datasets.
-## How to Get Started with the Model
-Refer to the instructions in OPEA Gaurdrail. --> TODO: add link.
 ## Training Details
-1. Dataset: Patronus EnterprisePII dataset, preprocessed to get the text and golden labels.
-2. Embedding model: nomic-ai/nomic-embed-text-v1
-3. Training process: split the dataset into train/test sets (test is about 10% of the total data). Embed the text with the embedding model. Feed the embeddings into logistic regresstion classifier. Use the golden labels in the dataset to train the classifier.
-TODO: link to training recipe???
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 ## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 license: apache-2.0
 ---
+# Business Safety Classifier - for demo purpose only
+Please read carefully the [disclaimers](#important-notices-and-disclaimers) below before downloading and using this model!
+## Model Description
+This is a logistic regression model that was developed by Intel to demonstrate possibility of training such a light-weight model to classify if a piece of text contains business sensitive information or not. You can refer to the [OPEA guardrail microservice webpage](https://github.com/opea-project/GenAIComps/tree/main/comps/guardrails/pii_detection) to learn more about the demo deployment of such a model in a guardrail microservice as part of a GenAI application.
+- **Developed by:** Intel
+- **Model type:** logistic regression classifier in pickled format
+- **License:** [To be discussed with BU Legal]
 ## Training Details
+1. Dataset: [Patronus EnterprisePII dataset](https://www.patronus.ai/announcements/patronus-ai-launches-enterprisepii-the-industrys-first-llm-dataset-for-detecting-business-sensitive-information),
+2. Dataset preprocessing: get the text and golden labels from the orginal dataset.
+3. Embedding model: [nomic-ai/nomic-embed-text-v1](https://huggingface.co/nomic-ai/nomic-embed-text-v1). The embedding model was used as-is without any fine-tuning.
+4. Annotation LLM: [mistralai/Mixtral-8x7B-Instruct-v0.1](https://huggingface.co/mistralai/Mixtral-8x7B-Instruct-v0.1). The LLM was used as-is without any fine tuning.
+5. Dataset annotation: used Annotation LLM to generate labels for the samples in the dataset. The label is 1 if LLM denotes that the text contains business sensitive info, else label is 0.
+6. The LLM annotation accuracy with respect to the golden labels is shown in the Evaluation section below. The reason for LLM annotation is that we want to demo the feasibility of using LLMs to generate high-quality labels in potentail use cases where there is no labeled text for training. **Note**: the LLM annotations have not been validated by human experts, instead we compared the LLM-annotated labels with the golden labels provided by the original dataset and observed good precision/recall.
+7. Training process: 1) split the dataset into train/test sets (test is about 10% of the total data). 2) Embed the training data with the embedding model. 3) Feed the embeddings into the logistic regresstion (LR) classifier. Use the LLM-annotated labels in the dataset to train the LR classifier from scratch.
 ## Evaluation
+### LLM annotation accuracy (entire dataset)
+The LLM annotation accuracy was evaluated on the entire Patronus EnterprisePII dataset. We calculated annotation accuracy with respect to the golden labels in the dataset. Below are the metrics that we collected when we conducted the annotation runs.
+| Metric    | Value |
+|-----------|-------|
+| Accuracy  | 0.909 |
+| Precision | 0.883 |
+| Recall    | 0.940 |
+### LR classifier accuracy (test split)
+We evaluated the LR classifier accuracy on our test split of the Patronus EnterprisePII dataset, which has no overlap with the training split. The metrics on the test set are shown below. Interestingly, although the classifier was trained with LLM-annotated labels, the classifier performed perfectly on the 300 test samples when using the golden labels in the original dataset as the reference, while it achieves slighlty lower but still very good accuracy (around 0.9) when using the LLM annotations (which the classifier was trained on) as reference. This shows that the LR classifier did not overfit to the LLM-annotated labels.
+| |Accuracy|Precision|Recall|
+|--|-------|---------|------|
+|Compared to golden labels|1.0|1.0|1.0|
+|Compared to LLM annotated labels|0.903|0.927|0.886|
+## Important Notices and Disclaimers
+1. The accuracy, precision, and recall metrics obtained for this reference implementation should not be seen as a goal or threshold for applied implementations, or as a judgement for what adequate performance ought to be. Each applied implementation ought to determine its own performance thresholds prior to deployment.
+2. The types of sensitive information contained the Patronus EnterprisePII dataset are not exhaustive and may not container certain types of sensitive information that are important for your applications. Therefore, the LR classifier trained with Patronus EnterprisePII dataset may not give satisfactory detection accuracy/precision/recall for your applications.
+3. The model does not support any language other than English.
+4. This model is served as a demo model for further testing and developing classifiers to detect the presence of business sensitive information, including personally identifying information (PII).
+5. This model is intended to allow users to examine and evaluate the model and the associated Intel Confidential performance of Intel technology solutions. The accuracy of computer models is a function of the relation between the data used to train them and the data that the models encounter after eployment. This model has been tested using datasets that may or may not be sufficient for use in production applications. Accordingly, while the model may serve as a strong foundation, Intel recommends and requests that this model be tested against data.
+the model is likely to encounter in specific deployments.
+6. There is no publicly available fairness metrics for the models and datasets that served as inputs for this model.  Further testing is needed to demonstrate whether there are disparities in whether PII is equally successfully identified across different demographic groups.
+7. This model should not be used without further testing, or without human oversight and review of the outputs to ensure PII and other sensitive items are fully removed. This model should not be used in situations where the consequences of inaccuracy are high. It is not appropriate to use this model as part of any investigation of employee conduct.
+8. Human Rights Disclaimer: Intel is committed to respecting human rights and avoiding causing or directly contributing to adverse impacts on human rights. See Intel’s [Global Human Rights Policy](https://www.intel.com/content/www/us/en/policy/policy-human-rights.html). The [software or model] licensed from Intel is intended for socially responsible applications and should not be used to cause or contribute to a violation of internationally recognized human rights.