Create README.md

README.md

@@ -0,0 +1,85 @@
+---
+license: mit
+arxiv: 2205.12424
+datasets:
+- VulDeePecker
+pipeline_tag: fill-mask
+tags:
+- defect detection
+- code
+---
+
+# VulBERTa Pretrained
+## VulBERTa: Simplified Source Code Pre-Training for Vulnerability Detection
+
+![VulBERTa architecture](https://raw.githubusercontent.com/ICL-ml4csec/VulBERTa/main/VB.png)
+
+## Overview
+This model is the unofficial HuggingFace version of "[VulBERTa](https://github.com/ICL-ml4csec/VulBERTa/tree/main)" with just the masked language modeling head for pretraining. I simplified the tokenization process by adding the cleaning (comment removal) step to the tokenizer and added the simplified tokenizer to this model repo as an AutoClass, allowing everyone to load this model without manually pulling any repos (with the caveat of `trust_remote_code`).
+
+> This paper presents presents VulBERTa, a deep learning approach to detect security vulnerabilities in source code. Our approach pre-trains a RoBERTa model with a custom tokenisation pipeline on real-world code from open-source C/C++ projects. The model learns a deep knowledge representation of the code syntax and semantics, which we leverage to train vulnerability detection classifiers. We evaluate our approach on binary and multi-class vulnerability detection tasks across several datasets (Vuldeepecker, Draper, REVEAL and muVuldeepecker) and benchmarks (CodeXGLUE and D2A). The evaluation results show that VulBERTa achieves state-of-the-art performance and outperforms existing approaches across different datasets, despite its conceptual simplicity, and limited cost in terms of size of training data and number of model parameters.
+
+## Usage
+**You must install libclang for tokenization.**
+
+```bash
+pip install libclang
+```
+
+Note that due to the custom tokenizer, you must pass `trust_remote_code=True` when instantiating the model.
+Example:
+```
+from transformers import pipeline
+pipe = pipeline("fill-mask", model="claudios/VulBERTa-mlm", trust_remote_code=True, return_all_scores=True)
+```
+
+***
+
+## Data
+We provide all data required by VulBERTa.  
+This includes:
+ - Tokenizer training data
+ - Pre-training data
+ - Fine-tuning data
+
+Please refer to the [data](https://github.com/ICL-ml4csec/VulBERTa/tree/main/data "data") directory for further instructions and details.
+
+## Models
+We provide all models pre-trained and fine-tuned by VulBERTa.  
+This includes:
+ - Trained tokenisers
+ - Pre-trained VulBERTa model (core representation knowledge)
+ - Fine-tuned VulBERTa-MLP and VulBERTa-CNN models
+
+Please refer to the [models](https://github.com/ICL-ml4csec/VulBERTa/tree/main/models "models") directory for further instructions and details.
+
+## How to use
+
+In our project, we uses Jupyterlab notebook to run experiments.  
+Therefore, we separate each task into different notebook:
+
+ - [Pretraining_VulBERTa.ipynb](https://github.com/ICL-ml4csec/VulBERTa/blob/main/Pretraining_VulBERTa.ipynb "Pretraining_VulBERTa.ipynb") - Pre-trains the core VulBERTa knowledge representation model using DrapGH dataset.
+ - [Finetuning_VulBERTa-MLP.ipynb](https://github.com/ICL-ml4csec/VulBERTa/blob/main/Finetuning_VulBERTa-MLP.ipynb "Finetuning_VulBERTa-MLP.ipynb") - Fine-tunes the VulBERTa-MLP model on a specific vulnerability detection dataset.
+ - [Evaluation_VulBERTa-MLP.ipynb](https://github.com/ICL-ml4csec/VulBERTa/blob/main/Evaluation_VulBERTa-MLP.ipynb "Evaluation_VulBERTa-MLP.ipynb") - Evaluates the fine-tuned VulBERTa-MLP models on testing set of a specific vulnerability detection dataset.
+ - [Finetuning+evaluation_VulBERTa-CNN](https://github.com/ICL-ml4csec/VulBERTa/blob/main/Finetuning%2Bevaluation_VulBERTa-CNN.ipynb "Finetuning+evaluation_VulBERTa-CNN.ipynb") - Fine-tunes VulBERTa-CNN models and evaluates it on a testing set of a specific vulnerability detection dataset.
+
+
+## Citation
+
+Accepted as conference paper (oral presentation) at the International Joint Conference on Neural Networks (IJCNN) 2022.  
+Link to paper: https://ieeexplore.ieee.org/document/9892280  
+
+
+```bibtex
+@INPROCEEDINGS{hanif2022vulberta,
+  author={Hanif, Hazim and Maffeis, Sergio},
+  booktitle={2022 International Joint Conference on Neural Networks (IJCNN)}, 
+  title={VulBERTa: Simplified Source Code Pre-Training for Vulnerability Detection}, 
+  year={2022},
+  volume={},
+  number={},
+  pages={1-8},
+  doi={10.1109/IJCNN55064.2022.9892280}
+  
+}
+```