Update README.md

README.md

@@ -18,13 +18,14 @@ dataset_info:
     num_examples: 76
   download_size: 53832
   dataset_size: 87854
+license: apache-2.0
 ---
 # Static Analysis Eval Benchmark
 
 A dataset of 76 Python programs taken from real Python open source projects (top 1000 on GitHub), 
 where each program is a file that has exactly 1 vulnerability as detected by a particular static analyzer (Semgrep).
 
-You can run the `_script_for_eval.py` to check the results.
+You can run the `_script_for_eval.py` script to check the results.
 
 ```
 python3 -m venv .venv
@@ -36,7 +37,7 @@ python _script_for_eval.py
 For all supported options, run with `--help`:
 
 ```
-usage: _script_for_eval.py [-h] [--model MODEL] [--cache] [--n_shot N_SHOT] [--use_similarity]
+usage: _script_for_eval.py  [-h] [--model MODEL] [--cache] [--n_shot N_SHOT] [--use_similarity] [--oracle]
 
 Run Static Analysis Evaluation
 
@@ -46,6 +47,7 @@ options:
   --cache           Enable caching of results
   --n_shot N_SHOT   Number of examples to use for few-shot learning
   --use_similarity  Use similarity for fetching dataset examples
+  --oracle          Run in oracle mode (assume all vulnerabilities are fixed)
 ```
 
 We need to use the logged in version of Semgrep to get access to more rules for vulnerability detection. So, make sure you login before running the eval script.
@@ -57,8 +59,10 @@ API token already exists in /Users/user/.semgrep/settings.yml. To login with a d
 
 After the run, the script will also create a log file which captures the stats for the run and the files that were fixed.
 You can see an example [here](https://huggingface.co/datasets/patched-codes/static-analysis-eval/blob/main/gpt-4o-mini_semgrep_1.85.0_20240818_215254.log).
+Due to the recent versions of Semgrep not detecting a few of the samples in the dataset as vulnerable anymore, the maximum score
+possible on the benchmark is 77.63%. You can see the oracle run log [here](https://huggingface.co/datasets/patched-codes/static-analysis-eval/blob/main/oracle-0-shot_semgrep_1.85.0_20240819_022711.log).
 
-We did some detailed evaluation with gpt-4o-mini recently:
+We did some detailed evaluations recently (19/08/2024):
 
 | Model | Score | Logs |
 |:-----:|:-----:|:----:|
@@ -67,6 +71,14 @@ We did some detailed evaluation with gpt-4o-mini recently:
 | gpt-4o-mini + rag (embedding & reranking) | 72.37 | [link](https://huggingface.co/datasets/patched-codes/static-analysis-eval/blob/main/gpt-4o-mini-1-shot-sim_semgrep_1.85.0_20240819_013810.log) |
 | gpt-4o-mini + fine-tuned with [synth-vuln-fixes](https://huggingface.co/datasets/patched-codes/synth-vuln-fixes) | 77.63 | [link](https://huggingface.co/datasets/patched-codes/static-analysis-eval/blob/main/ft_gpt-4o-mini-2024-07-18_patched_patched_9uUpKXcm_semgrep_1.85.0_20240818_220158.log) |
 
+
+| Model | Score | Logs |
+|:-----:|:-----:|:----:|
+| gpt-4o | 68.42 | [link](https://huggingface.co/datasets/patched-codes/static-analysis-eval/blob/main/gpt-4o-0-shot_semgrep_1.85.0_20240819_015355.log)|
+| gpt-4o + 3-shot prompt | 77.63 | [link](https://huggingface.co/datasets/patched-codes/static-analysis-eval/blob/main/gpt-4o-3-shot_semgrep_1.85.0_20240819_020525.log)| 
+| gpt-4o + rag (embedding & reranking) | 77.63 | [link](https://huggingface.co/datasets/patched-codes/static-analysis-eval/blob/main/gpt-4o-1-shot-sim_semgrep_1.85.0_20240819_023323.log) |
+<!-- | gpt-4o + fine-tuned with [synth-vuln-fixes](https://huggingface.co/datasets/patched-codes/synth-vuln-fixes) | 77.63 | [link]() |
+-->
 # Leaderboard
 
 The top models on the leaderboard are all fine-tuned using the same dataset that we released called [synth vuln fixes](https://huggingface.co/datasets/patched-codes/synth-vuln-fixes).