adewopova commited on
Commit
944a1b8
1 Parent(s): fda4e50

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +66 -0
README.md ADDED
@@ -0,0 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Accident Detection Model
2
+
3
+ This application showcases the capabilities of our Accident Detection Model, a pivotal component of our research project focused on Accident Detection within Smart City Transportation frameworks.
4
+
5
+ ## Overview
6
+
7
+ The application empowers users to view a selection of sample accident videos and upload a new video to test the model. Our model is adept at detecting accidents in both trimmed and untrimmed video formats.
8
+
9
+ ## Table of Contents
10
+
11
+ - [Installation](#installation)
12
+ - [Usage](#usage)
13
+ - [Features](#features)
14
+ - [Contribution](#contribution)
15
+ - [License](#license)
16
+ - [Acknowledgments](#acknowledgments)
17
+
18
+ ## Installation
19
+
20
+ 1. **Clone the repository:**
21
+ ```bash
22
+ git clone [(https://github.com/adewopova/Accident_detection_SM_City/)]
23
+ ```
24
+
25
+ 2. **Navigate to the directory:**
26
+ ```bash
27
+ cd path_to_diretory
28
+ ```
29
+
30
+ 3. **Install the required dependencies:**
31
+ ```bash
32
+ pip install -r requirements.txt
33
+ ```
34
+
35
+ 4. **Launch the Streamlit app:**
36
+ ```bash
37
+ streamlit run app.py
38
+ ```
39
+
40
+ ## Usage
41
+
42
+ With the app up and running:
43
+
44
+ - Opt between trimmed and untrimmed video variants.
45
+ - Pick a sample video from the provided list or upload a video of your choice.
46
+ - The model will analyze the video and superimpose accident likelihood indicators.
47
+
48
+ ## Features
49
+
50
+ - **Sample Videos**: Preloaded sample videos for immediate testing.
51
+ - **Accident Prediction**: The core functionality that exhibits the probability of an accident occurrence within the selected video.
52
+ - **User-friendly Interface**: Crafted using Streamlit, ensuring a seamless and intuitive user experience.
53
+
54
+ ## Contribution
55
+
56
+ Your contributions can make a difference! Kindly consult the contribution guidelines prior to submitting any changes.
57
+
58
+ ## License
59
+
60
+ This project is protected under the MIT License. For more details, please refer to the `LICENSE.md` file.
61
+
62
+ ## Acknowledgments
63
+
64
+ A heartfelt appreciation to our dedicated research team members: Victor Adewopo and Nelly Elsayed.
65
+
66
+ [https://arxiv.org/pdf/2310.10038.pdf](#)