Update README.md

README.md

@@ -1,5 +1,3 @@
-## README.md (with Metadata)
-```yaml
 ---
 model_name: "Canstralian/CySec_Known_Exploit_Analyzer"
 tags:
@@ -20,7 +18,6 @@ language:
  - en
 model_type: neural-network
 ---
-```
 
 # Canstralian/CySec_Known_Exploit_Analyzer
 
@@ -43,51 +40,35 @@ To clone the repository and install necessary dependencies:
 git clone https://huggingface.co/Canstralian/CySec_Known_Exploit_Analyzer
 cd CySec_Known_Exploit_Analyzer
 pip install -r requirements.txt
-```
 
-### Usage
+Usage
+
 To analyze a network traffic log:
-```bash
+
 python analyze_exploit.py --input [input-file]
-```
 
-### Example
-```bash
+Example
+
 # Example command to analyze a sample log
 python analyze_exploit.py --input data/sample_log.csv
-```
 
-### Model Inference
-- **Input:** Network traffic logs in CSV format
-- **Output:** Classification of potential exploits with confidence scores
+Model Inference
+
+   •   Input: Network traffic logs in CSV format
+   •   Output: Classification of potential exploits with confidence scores
+
+License
 
-## License
 This project is licensed under the MIT License. See the LICENSE.md file for more details.
 
-## Datasets
-The model was trained using the **cysec-known-exploit-dataset**, which consists of exploit data collected from real-world network traffic.
+Datasets
 
-## Contributing
-We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+The model was trained using the cysec-known-exploit-dataset, which consists of exploit data collected from real-world network traffic.
 
-## Contact
-For any questions or feedback, feel free to open an issue or reach out to [Your Email].
+Contributing
 
----
+We welcome contributions! Please see CONTRIBUTING.md for guidelines.
+
+Contact
 
-### **Metadata Fields Explained:**
-- **`model_name`:** The name of the model.
-- **`tags`:** Keywords for discoverability.
-- **`license`:** Chosen license (MIT).
-- **`datasets`:** Dataset used for training.
-- **`metrics`:** Metrics for model evaluation.
-- **`library_name`:** Library used to build the model.
-- **`language`:** Language of the documentation.
-- **`model_type`:** Type of model.
-
-This structure will enhance discoverability and usability for users on platforms like Hugging Face or GitHub. If you need any more adjustments or additions, let me know!
-
-## Commit Options
-- Commit directly to the **main** branch.
-- Open as a pull request to the **main** branch.
-```
+For any questions or feedback, feel free to open an issue or reach out to [[email protected]].