update readme

README.md

@@ -9,7 +9,6 @@ tags:
 - ontology
 - cybersecurity
 annotations_creators:
-- crowdsourced
 - expert-generated
 pretty_name: D3FEND
 size_categories:
@@ -33,35 +32,73 @@ dataset_info:
 viewer: false
 ---
 
-# D3FEND 
+# D3FEND
+A knowledge graph of cybersecurity countermeasures
 
-Branch: https://github.com/d3fend/d3fend-ontology/tree/release/0.13.0-BETA-1
+### Overview
+D3FEND encodes a countermeasure knowledge base in the form of a
+knowledge graph. It meticulously organizes key concepts and relations
+in the cybersecurity countermeasure domain, linking each to pertinent
+references in the cybersecurity literature. This robust representation
+offers a detailed insight into the complexities of cybersecurity
+countermeasures. 
 
-Commit: 3dcc495879bb62cee5c4109e9b784dd4a2de3c9d
+### Use-cases
+Researchers can leverage this dataset to develop graph-based learning
+models, fine-tune language models for cybersecurity knowledge graph
+completion, or explore the intricate realm of ontologies in
+cybersecurity, gaining insights into the complexities and nuances of
+cybersecurity countermeasures and their implications with their own
+datasets.
 
-CWE extension:
-https://github.com/d3fend/d3fend-ontology/tree/release/0.13.0-BETA-1/extensions/cwe
+### Preprocessing
 
-After building d3fend-full.owl I imported the ontology into Protege
-version 5.6.1 with the Pellet reasoner plug-in. First I use the Debug
-Ontology plugin to check the ontology for consistency and
-coherency. If it all checks out, I move onto exporting the inferences.
+### Source:
+- [Dataset Repository - 0.13.0-BETA-1](https://github.com/d3fend/d3fend-ontology/tree/release/0.13.0-BETA-1)
+- [Commit Details](https://github.com/d3fend/d3fend-ontology/commit/3dcc495879bb62cee5c4109e9b784dd4a2de3c9d)
+- [CWE Extension](https://github.com/d3fend/d3fend-ontology/tree/release/0.13.0-BETA-1/extensions/cwe)
 
-In Protege navigate to File>Export Inferred Axioms as ontology and
-make sure to check all of the checkboxes including asserted axioms and
-annotations. See this blog post for more
-information: https://www.michaeldebellis.com/post/export-inferred-axioms.
+#### Building and Verification:
+1. **Construction**: The ontology, denoted as `d3fend-full.owl`, was
+   built from the beta version of the D3FEND ontology referenced
+   above using documented README in d3fend-ontology. This includes the
+   CWE extensions. 
+2. **Importation and Reasoning**: Imported into Protege version 5.6.1,
+   utilizing the Pellet reasoner plugin for logical reasoning and
+   verification.
+3. **Coherence Check**: Utilized the Debug Ontology plugin in Protege
+   to ensure the ontology's coherence and consistency.
 
-Once you have the materialized ontology you can filter it with
-d3fend.sparql. 
+#### Exporting, Transformation, and Compression:
+1. **Exporting Inferred Axioms**: Post-verification, I exported
+   inferred axioms along with asserted axioms and
+   annotations. [Detailed
+   Process](https://www.michaeldebellis.com/post/export-inferred-axioms)
+2. **Filtering**: The materialized ontology was filtered using
+   `d3fend.rq` to retain relevant triples.
+3. **Format Transformation**: Subsequently transformed to Turtle and
+   N-Triples formats for diverse usability.
+   ```shell
+   arq --query=d3fend.rq --data=d3fend.owl --results=turtle > d3fend.ttl
+   riot --output=nt d3fend.ttl > d3fend.nt
+   ```
+4. **Compression**: Compressed the resulting ontology files using
+   gzip.
 
-``` shell
-arq --query=d3fend.rq --data=d3fend.owl --results=turtle > d3fend.ttl
-```
+### How to Load the Dataset:
+
+You can load this dataset using the Hugging Face Datasets library with
+the following Python code:
 
-``` shell
-riot --output=nt d3fend.ttl > d3fend.nt
+```python
+from datasets import load_dataset
+dataset = load_dataset('wikipunk/d3fend', split='train')
 ```
 
-The d3fend.owl and d3fend.nt files then are compressed using gzip.
+### Acknowledgements
+This ontology is developed by MITRE Corporation and is licensed under
+the MIT license. I would like to thank the authors for their work
+which has opened my eyes to a new world of cybersecurity modeling.
 
+If you are a cybersecurity expert please consider [contributing to
+D3FEND](https://d3fend.mitre.org/contribute/).

requirements.txt

@@ -0,0 +1 @@
+rdflib>=6.0.0