Update README.md

README.md

@@ -1,3 +1,100 @@
 ---
+library_name: transformers
 license: apache-2.0
+tags:
+- security
+- cybersecwithai
+- threat
+- vulnerability
+- infosec
+- zysec.ai
+- cyber security
+- ai4security
+- llmsecurity
+- cyber
+- ai4good
+- aisecurity
+- threat
+- cybersec
+- cybersecurity
 ---
+
+## Description
+This repo contains GGUF format model files for ZySec-7B-v2 (01 Mar 2024).
+
+## Files Provided
+|           Name           |  Quant  | Bits | File Size |              Remark              |
+| ------------------------ | ------- | ---- | --------- | -------------------------------- |
+| zysec-7b-v2.IQ3_XXS.gguf | IQ3_XXS |	3 	|  3.02 GB 	| 3.06 bpw quantization            |
+| zysec-7b-v2.IQ3_S.gguf   | IQ3_S   |  3   |  3.18 GB  | 3.44 bpw quantization            |
+| zysec-7b-v2.IQ3_M.gguf   | IQ3_M   |  3   |  3.28 GB  | 3.66 bpw quantization mix        |
+| zysec-7b-v2.Q4_0.gguf    | Q4_0    |  4   |  4.11 GB  | 3.56G, +0.2166 ppl               |
+| zysec-7b-v2.IQ4_NL.gguf  | IQ4_NL  |  4   |  4.16 GB  | 4.25 bpw non-linear quantization |
+| zysec-7b-v2.Q4_K_M.gguf  | Q4_K_M  |  4   |  4.37 GB  | 3.80G, +0.0532 ppl               |
+| zysec-7b-v2.Q5_K_M.gguf  | Q5_K_M  |  5   |  5.13 GB  | 4.45G, +0.0122 ppl               |
+| zysec-7b-v2.Q6_K.gguf    | Q6_K    |  6   |  5.94 GB  | 5.15G, +0.0008 ppl               |
+| zysec-7b-v2.Q8_0.gguf    | Q8_0    |  8   |  7.70 GB  | 6.70G, +0.0004 ppl               |
+
+## Parameters
+|        path       |  type   |    architecture    | rope_theta | sliding_win | max_pos_embed |
+| ----------------- | ------- | ------------------ | ---------- | ----------- | ------------- |
+| ZySec-AI/ZySec-7B | mistral | MistralForCausalLM | 10000.0    | 4096        | 32768         |
+
+## Benchmarks
+Benchmark results from run 2024-03-01T13:39:32.404466:   
+- [open-llm-leaderboard/details_ZySec-AI__ZySec-7B-v2](https://huggingface.co/datasets/open-llm-leaderboard/details_ZySec-AI__ZySec-7B-v2)
+
+# Original Model Card
+
+# ZySec-7B
+
+ZySec-7B, stands as a pivotal innovation for security professionals, leveraging the advanced capabilities of HuggingFace's Zephyr language model series. This AI model is crafted to be an omnipresent cybersecurity ally, offering on-demand, expert guidance in cybersecurity issues. Picture ZySec-7B as an ever-present digital teammate, adept at navigating the complexities of security challenges.
+
+The efficacy of ZySec-7B lies in its comprehensive training across numerous cybersecurity fields, providing a deep and wide-ranging understanding of the sector. ZySec is developed using the DPO technique, utilizing a varied dataset encompassing critical topics such as:
+
+- Sophisticated areas like Attack Surface Threats, Cloud Security, and the Cyber Kill Chain.
+- Key compliance and regulatory frameworks, including CIS Controls, FedRAMP, PCI DSS, and ISO/IEC 27001.
+- Practical aspects like Cloud Secure Migration, Data Exfiltration Techniques, and Security Incident Handling.
+- Crucial strategic fields such as Security Governance, Risk Management, and Security Architecture Review.
+
+ZySec-7B's training spans over 30 unique domains, each enriched with thousands of data points, delivering unparalleled expertise.
+
+As the first of its kind in an open-source, AI-driven cybersecurity series, ZySec-7B transcends the conventional role of a support tool, redefining organizational security approaches. Its open-source nature not only invites community contributions but also enhances its flexibility and transparency in managing vast cybersecurity data. ZySec-7B is instrumental in providing vital, actionable insights for strategic decision-making and advanced risk management. More than a mere software, ZySec-7B is a community-enhanced strategic tool, equipping your team to proactively confront and stay ahead of the dynamic landscape of cyber threats and regulatory demands.
+
+# Try the demo space [ZySec AI](https://huggingface.co/spaces/ZySec-AI/ZySec)
+
+<img src="https://huggingface.co/aihub-app/ZySec-7B-v1/resolve/main/ZySec-7B-dataset-composition.png?download=true" alt="Dataset Distribution" width="90%"/>
+
+Details of dataset distribution here - [Dataset Distribution](https://huggingface.co/aihub-app/ZySec-7B/resolve/main/ZySec-7B-dataset-composition.png?download=true)
+
+Fully compatible with [LM Studio](https://lmstudio.ai). Search for “Zysec” and here is what you get. Here is a sample output of ZySec writing email to John about database security using LM Studio:
+
+<img src="https://huggingface.co/aihub-app/ZySec-7B-v1/resolve/main/sample-output.png" alt="Sample Output" width="90%"/>
+
+---
+
+The training is funded by [AttackIO](https://www.attackio.app), the mobile app for Cyber Security professionals.
+
+Official GGUF version is hosted here - [ZySec-7B-v1-GGUF on HuggingFace](https://huggingface.co/aihub-app/ZySec-7B-v1-GGUF)
+
+
+## [ZySec AI: Unleashing the Potential of the ZySec Series Model](https://github.com/ZySec-AI/ZySec)
+
+
+Project ZySec, an integral part of ZySec AI, stands at the forefront of integrating Artificial Intelligence into Cybersecurity. Centered around the innovative ZySec 7B model, it's designed to revolutionize the cybersecurity landscape with AI-driven solutions. ZySec AI isn't just a tool, it's a transformative approach, blending AI's cutting-edge capabilities with the unique intricacies of cybersecurity, while ensuring privacy and security.
+
+
+### Discover the Key Features of Project ZySec
+- **AI-Driven Cybersecurity:** Tap into the power of the ZySec 7B model, a bespoke AI solution fine-tuned for cybersecurity.
+- **24/7 Expert Assistance:** Benefit from round-the-clock support and expert advice, guaranteeing smooth operations during any SOC shift.
+- **Efficient Playbook Access:** Streamline your workflow with quick and easy access to playbooks and documents, enhancing information retrieval.
+- **Standards Explorer:** Navigate various standards with ease, akin to a seasoned expert's proficiency.
+- **Ongoing Internet Research:** Leverage AI-enabled, thorough internet research for exhaustive insights. (Note: Internet use is optional and specific to this feature).
+
+### About Project ZySec by ZySec AI
+ZySec AI an opensource project, with a vision towards fusioning of Cybersecurity with Artificial Intelligence. Our goal is to transform the way security professionals engage with technology. More than a mere tool, ZySec AI symbolizes a comprehensive strategy to augment security operations, merging the innovative essence of AI with cybersecurity's distinctive challenges, always ensuring privacy and security.
+
+https://github.com/ZySec-AI/ZySec
+
+### The ZySec Roadmap
+https://github.com/ZySec-AI/.github/blob/main/roadmap.md