Update README.md
Browse files
README.md
CHANGED
|
@@ -33,6 +33,21 @@ pip install -r requirements.txt
|
|
| 33 |
python _script_for_eval.py
|
| 34 |
```
|
| 35 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 36 |
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.
|
| 37 |
|
| 38 |
```
|
|
|
|
| 33 |
python _script_for_eval.py
|
| 34 |
```
|
| 35 |
|
| 36 |
+
For all supported options, run with `--help`:
|
| 37 |
+
|
| 38 |
+
```
|
| 39 |
+
usage: _script_for_eval.py [-h] [--model MODEL] [--cache] [--n_shot N_SHOT] [--use_similarity]
|
| 40 |
+
|
| 41 |
+
Run Static Analysis Evaluation
|
| 42 |
+
|
| 43 |
+
options:
|
| 44 |
+
-h, --help show this help message and exit
|
| 45 |
+
--model MODEL OpenAI model to use
|
| 46 |
+
--cache Enable caching of results
|
| 47 |
+
--n_shot N_SHOT Number of examples to use for few-shot learning
|
| 48 |
+
--use_similarity Use similarity for fetching dataset examples
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
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.
|
| 52 |
|
| 53 |
```
|