updates

.gitignore

@@ -160,14 +160,14 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
+# miscellaneous
+.gitpod.yml
+**/development/
 
 # Data and models
 data/*/*
 !.gitkeep
 
-#devops
-.gitpod.yml
-
 # Logs Directories 
 outputs
 mlruns

README.md

@@ -1,4 +1,23 @@
-# PROJECT / BUSINESS UNDERSTANDING
+# Log Anomaly Detection
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#about-the-project">About The Project</a></li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+      </ul>
+    </li>
+    <li><a href="#analysis-and-report">Analysis and Report</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+## About The Project
 
 In the realm of computing, logging involves the process of creating a record detailing events that transpire within a computer system. These events encompass issues, errors, or even informative updates about ongoing operations. These occurrences might manifest within the operating system or other software components. For every such event, a message or entry is documented.
 
@@ -16,6 +35,54 @@ The data containing the logs was provided. The dataset was in **JSON** format wh
 
 The labels for logs are **"abnormal" and "normal"**
 
-## Project Objectives
+### Project Objectives
 
 1. To train a machine learning model that can predict whether a given log is an anomaly or normal
+
+### Dataset
+about the dataset
+pic of samples of data
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+To get a local copy up and running follow these simple example steps.
+
+### Prerequisites
+
+In
+
+```bash
+# Clone this repository
+$ git clone 
+
+# Go into the repository
+$ cd 
+
+# Install dependencies
+$ make setup
+```
+
+### Runing the program
+
+train.py
+different models
+evalute.py
+
+## Analysis and Report
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTACT -->
+## Contact
+
+If you have questions or need assistance, feel free to reach out to:
+
+**Name:** **Ipadeola Ezekiel Ladipo**  
+**Email:** <[email protected]>  
+**GitHub:** [@rileydrizzy](https://github.com/rileydrizzy)  
+**Linkdeln:** [Ipadeola Ladipo](https://www.linkedin.com/in/ladipo-ipadeola/)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+---

dev.txt

@@ -0,0 +1,7 @@
+evaluate and analysis c #
+pretrained embedding #
+learning rate scheduler #
+class weight
+github repo
+Confusion Matrix for error analysis c #
+Hyper-tunning of the model to be done