SAP/password-model

1---2language:3- en4 5---6# Model Card for Password-Model7 8 9# Model Details10 11## Model Description12 13 14The Password Model is intended to be used with [Credential Digger](https://github.com/SAP/credential-digger) in order to automatically filter false positive password discoveries.15 16- **Developed by:** SAP OSS17- **Shared by [Optional]:** Hugging Face18- **Model type:** Text Classification19- **Language(s) (NLP):** en20- **License:** MIT21- **Related Models:** 22  - **Parent Model:** RoBERTa23- **Resources for more information:**24  - [GitHub Repo](https://github.com/SAP/credential-digger) 25  - [Associated Paper](https://www.scitepress.org/Papers/2021/102381/102381.pdf) 26 27# Uses28 29 30## Direct Use31The model is directly integrated into [Credential Digger]((https://github.com/SAP/credential-digger) and can be used to filter the false positive password discoveries of a scan.32 33 34## Out-of-Scope Use35 36The model should not be used to intentionally create hostile or alienating environments for people. 37 38 39# Training Details40 41## Training Data42 43[CodeBERT-base-mlm](https://huggingface.co/microsoft/codebert-base-mlm) fine-tuned on a dataset for leak detection.44 45 46## Training Procedure47 48 49### Preprocessing50 51More information needed52 53### Speeds, Sizes, Times54 55More information needed56 57# Evaluation58 59More information needed60 61## Testing Data, Factors & Metrics62 63### Testing Data64 65More information needed66 67### Factors68 69More information needed70 71### Metrics72 73More information needed74 75## Results 76 77More information needed78 79 80# Model Examination81More information needed82 83# Environmental Impact84 85Carbon 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).86 87- **Hardware Type:** More information needed88- **Hours used:** More information needed89- **Cloud Provider:** More information needed90- **Compute Region:** More information needed91- **Carbon Emitted:** More information needed92 93# Technical Specifications [optional]94 95## Model Architecture and Objective96 97More information needed98 99## Compute Infrastructure100More information needed101 102### Hardware103 104More information needed105 106### Software107 108More information needed109 110 111# Citation112 113**BibTeX:**114 115```116TBD117```118 119# Model Card Authors [optional]120 121SAP OSS in collaboration with Ezi Ozoani and the Hugging Face team.122 123# Model Card Contact124 125More information needed126 127# How to Get Started with the Model128 129The model is directly integrated into Credential Digger and can be used to filter the false positive discoveries of a scan130 131<details>132<summary> Click to expand </summary>133 134```python135from transformers import AutoTokenizer, AutoModelForSequenceClassification136 137tokenizer = AutoTokenizer.from_pretrained("SAPOSS/password-model")138 139model = AutoModelForSequenceClassification.from_pretrained("SAPOSS/password-model")140 141 ```142</details>143