jdalfonso commited on
Commit
75bcde3
·
1 Parent(s): df80fb7

:rocket: feature: README.md

Browse files
Files changed (1) hide show
  1. README.md +17 -15
README.md CHANGED
@@ -1,40 +1,42 @@
1
- # SISE Ultimate Challenge
 
2
 
3
- This is the ultimate challenge for Master SISE.
4
 
5
- ## Overview
6
 
7
- This project is a Streamlit-based dashboard for analyzing security logs, data trends, and applying machine learning models.
8
 
9
- ## Features
10
 
11
- - Home: Overview of the challenge
12
- - Analytics: View and analyze security logs and data trends
13
- - Machine Learning: Train and evaluate machine learning models
14
 
15
  ## Installation
16
 
17
- To run this project locally, follow these steps:
18
 
19
- 1. Clone the repository:
20
  ```sh
21
  git clone https://github.com/jdalfons/sise-ultimate-challenge.git
22
  cd sise-ultimate-challenge
23
  ```
24
 
25
- 2. Create a virtual environment and activate it:
26
  ```sh
27
  python3 -m venv venv
28
  source venv/bin/activate
29
  ```
30
 
31
- 3. Install the required dependencies:
32
  ```sh
33
  pip install -r requirements.txt
34
  ```
35
 
36
- ## Usage
37
 
38
- To start the Streamlit app, run the following command:
39
  ```sh
40
- streamlit run [app.py](http://_vscodecontentref_/1)
 
 
1
+ # SISE Ultimate Challenge
2
+ ![Logo du Ultimate Challenge SISE](img/logo.png)
3
 
4
+ Ceci est le Ultimate Challenge pour le Master SISE.
5
 
6
+ ## Aperçu
7
 
8
+ Ce projet est un tableau de bord basé sur Streamlit pour analyser les journaux de sécurité, les tendances des données et appliquer des modèles d'apprentissage automatique.
9
 
10
+ ## Fonctionnalités
11
 
12
+ - Accueil : Vue d'ensemble du défi
13
+ - Analytique : Visualiser et analyser les journaux de sécurité et les tendances des données
14
+ - Apprentissage Automatique : Entraîner et évaluer des modèles d'apprentissage automatique
15
 
16
  ## Installation
17
 
18
+ Pour exécuter ce projet localement, suivez ces étapes :
19
 
20
+ 1. Clonez le dépôt :
21
  ```sh
22
  git clone https://github.com/jdalfons/sise-ultimate-challenge.git
23
  cd sise-ultimate-challenge
24
  ```
25
 
26
+ 2. Créez un environnement virtuel et activez-le :
27
  ```sh
28
  python3 -m venv venv
29
  source venv/bin/activate
30
  ```
31
 
32
+ 3. Installez les dépendances requises :
33
  ```sh
34
  pip install -r requirements.txt
35
  ```
36
 
37
+ ## Utilisation
38
 
39
+ Pour démarrer l'application Streamlit, exécutez la commande suivante :
40
  ```sh
41
+ streamlit run app.py
42
+ ```