iMeshal commited on
Commit
13d7745
·
verified ·
1 Parent(s): ce6df5e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +46 -90
README.md CHANGED
@@ -1,98 +1,54 @@
1
  ---
2
- license: unknown
3
- language:
4
- - en
 
 
 
 
 
 
 
5
  ---
6
- html
7
- <!DOCTYPE html>
8
- <html lang="en">
9
- <head>
10
- <meta charset="UTF-8">
11
- <title>iMeshal/GRC-ECC-Guide-VDB Dataset Card</title>
12
- <style>
13
- body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; line-height: 1.6; max-width: 800px; margin: auto; padding: 20px; }
14
- h1, h2 { border-bottom: 2px solid #eaecef; padding-bottom: 0.3em; }
15
- table { width: 100%; border-collapse: collapse; margin: 1em 0; }
16
- th, td { border: 1px solid #dfe2e5; padding: 8px; text-align: left; }
17
- th { background-color: #f6f8fa; font-weight: 600; }
18
- .filename { font-family: monospace; background-color: #eee; padding: 2px 4px; border-radius: 3px; }
19
- </style>
20
- </head>
21
- <body>
22
 
23
- <h1>NCA ECC Compliance Vector Database (VDB) Dataset</h1>
24
 
25
- <p>
26
- This repository hosts a high-quality, pre-processed **Vector Database (VDB)**, specifically structured to support
27
- <a href="https://huggingface.co/docs/transformers/model_doc/rag" target="_blank">Retrieval-Augmented Generation (RAG)</a> applications
28
- in the domain of Cybersecurity Governance, Risk, and Compliance (**GRC**).
29
- </p>
30
- <p>
31
- The dataset serves as the foundational knowledge base for the <span class="filename">AI-GRC-Assistant</span> project, providing
32
- authoritative context on official regulatory requirements.
33
- </p>
34
 
35
- <h2>Dataset Overview</h2>
36
- <table>
37
- <thead>
38
- <tr>
39
- <th>Detail</th>
40
- <th>Value</th>
41
- </tr>
42
- </thead>
43
- <tbody>
44
- <tr>
45
- <td>**Dataset Name**</td>
46
- <td>NCA ECC Compliance Vector Database (VDB)</td>
47
- </tr>
48
- <tr>
49
- <td>**VDB Technology**</td>
50
- <td>Chroma DB (Persistent Client)</td>
51
- </tr>
52
- <tr>
53
- <td>**Embedding Model Used**</td>
54
- <td><span class="filename">sentence-transformers</span></td>
55
- </tr>
56
- <tr>
57
- <td>**Data Source**</td>
58
- <td>Guide to Essential Cybersecurity Controls (ECC) Implementation - National Cybersecurity Authority (NCA)</td>
59
- </tr>
60
- <tr>
61
- <td>**File Asset**</td>
62
- <td><span class="filename">chroma_db.zip</span> (Contains all Chroma DB persistent files)</td>
63
- </tr>
64
- <tr>
65
- <td>**Primary Use Case**</td>
66
- <td>RAG-based AI Assistants for GRC compliance checking and advisory.</td>
67
- </tr>
68
- </tbody>
69
- </table>
70
 
71
- <h2>Source Document</h2>
72
- <p>
73
- The vector data was derived exclusively from the following critical regulatory document:
74
- </p>
75
- <ul>
76
- <li>
77
- **Guide to Essential Cybersecurity Controls (ECC) Implementation** (NCA, Saudi Arabia)
78
- </li>
79
- </ul>
80
 
81
- <h2>Contact and Licensing</h2>
82
- <p>
83
- This dataset is provided for public research and development purposes.
84
- </p>
85
- <ul>
86
- <li>
87
- **Author:** Mesh'al Qushaym (MQushaym)
88
- </li>
89
- <li>
90
- **Email:** <a href="mailto:meshalqushim@outlook.com">meshalqushim@outlook.com</a>
91
- </li>
92
- <li>
93
- **License:** This dataset is provided under a permissive license (e.g., MIT, if you plan to formalize it) allowing reuse, modification, and sharing, contingent upon proper attribution of the source material (NCA).
94
- </li>
95
- </ul>
96
 
97
- </body>
98
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: other
3
+ language: en
4
+ tags:
5
+ - cybersecurity
6
+ - grc
7
+ - compliance
8
+ - rag
9
+ - vector-database
10
+ - chroma
11
+ - nca
12
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
+ # NCA ECC Compliance Vector Database (VDB)
15
 
16
+ <p>
17
+ This repository hosts a high-quality, pre-processed **Vector Database (VDB)**, specifically structured to support
18
+ Retrieval-Augmented Generation (RAG) applications in the domain of Cybersecurity Governance, Risk, and Compliance (**GRC**).
19
+ </p>
20
+ <p>
21
+ The VDB serves as the authoritative knowledge base for the **AI-GRC-Assistant** project, providing context on official regulatory requirements.
22
+ </p>
 
 
23
 
24
+ ## 🌟 Dataset Overview
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
 
26
+ | Detail | Value |
27
+ | :--- | :--- |
28
+ | **Dataset Name** | NCA ECC Compliance Vector Database (VDB) |
29
+ | **VDB Technology** | Chroma DB (Persistent Client) |
30
+ | **Embedding Model** | `sentence-transformers` (Generic model type) |
31
+ | **Data Source** | National Cybersecurity Authority (NCA) of Saudi Arabia |
32
+ | **File Asset** | `chroma_db` (Contains persistent Chroma DB files) |
33
+ | **Primary Use Case** | RAG-based AI Advisory for GRC compliance. |
 
34
 
35
+ ## 📜 Data Sourcing and Public Availability
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
 
37
+ <p>
38
+ All textual data used for embedding is derived from the official public document:
39
+ <strong>"Guide to Essential Cybersecurity Controls (ECC) Implementation"</strong>.
40
+ This document is publicly available on the NCA website and is intended for use by national organizations, ensuring the assistant’s advice is based on open and verifiable regulatory standards.
41
+ </p>
42
+
43
+ - **Official Source Link:** [ECC Implementation Guide (NCA)](https://nca.gov.sa/en/regulatory-documents/controls-list/ecc/)
44
+
45
+ ## 🛠️ Usage and Integration
46
+
47
+ <p>
48
+ This asset is designed to be loaded into a Python RAG pipeline using <strong>Chroma DB</strong> and the specified sentence-transformer embedding method. Ensure the Python environment has <code>chromadb</code> and <code>sentence-transformers</code> installed.
49
+ </p>
50
+
51
+ ## 📧 Contact
52
+
53
+ * **Author:** Meshal Qushaym (MQushaym)
54
+ * **Email:** meshalqushim@outlook.com