Update README.md

README.md

@@ -21,4 +21,43 @@ configs:
     path: data/train-*
   - split: test
     path: data/test-*
+license: mit
+task_categories:
+- text-classification
+language:
+- en
+tags:
+- finance
+pretty_name: Severity of Vulnerable Solidity Functions
+size_categories:
+- 1K<n<10K
 ---
+
+---
+license: mit
+configs:
+- config_name: vulnerable-w-explanations
+  data_files: db-vulnerable.csv
+  default: true
+- config_name: verified-functions
+  data_files: db-verified.csv
+language:
+- en
+tags:
+- finance
+pretty_name: Smart Contract Vulnerabilities with Explanations
+size_categories:
+- 1K<n<10K
+---
+
+This dataset combines vulnerable functions scraped from several auditting companies (([Codehawks](https://www.codehawks.com/), [ConsenSys](https://consensys.io/), [Cyfrin](https://www.cyfrin.io/), [Sherlock](https://www.sherlock.xyz/), [Trust Security](https://www.trust-security.xyz/))) and auddited functions with no vulnerabilities (Scraped from [Etherscan](https://etherscan.io))
+
+It's purpose is to train a model to classify code into the 4 classes: `none`, `low`, `medium` and `high` severity.
+
+| Field | Description |
+|-|-|
+| 1. `function` | Raw solidity code                                                                                 |
+| 2. `severity` | Severity of vulnerability ('none', `low`, `medium`, `high`) |
+
+# Additional Info
+- The newline characters are escaped (i.e. `\\n`)