abdellatif-laghjaj commited on
Commit
eae5e7b
Β·
verified Β·
1 Parent(s): 08d7a73

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -117
README.md CHANGED
@@ -1,117 +1,9 @@
1
- [![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/rzFn0ERT)
2
-
3
- # BirdCLEF 2024: Bird Species Identification from Audio
4
-
5
- ## Overview
6
-
7
- This project is part of the BirdCLEF 2024 competition, focusing on identifying bird species from audio recordings. The
8
- target region is the Western Ghats, a significant biodiversity hotspot in India. The goal is to develop a machine
9
- learning model capable of accurately predicting bird species from audio recordings, with a particular emphasis on
10
- under-studied species.
11
-
12
- ## Author
13
-
14
- This project was created by:
15
-
16
- - **Name**: LAGHJAJ ABDELLATIF
17
- - **Email**: abdelatiflaghjaj@gmail.com
18
-
19
- ## Screenshots
20
-
21
- | **Sketch** | **Main App** | **Result** |
22
- |:----------------------------:|:-------------------------:|:-----------------------:|
23
- | ![Sketch](images/sketch.png) | ![Main App](images/1.png) | ![Result](images/2.png) |
24
-
25
- ## Project Components
26
-
27
- 1. **Data Collection**
28
- 2. **Preprocessing**
29
- 3. **Model Training**
30
- 4. **Prediction and Visualization**
31
- 5. **User Interface**
32
-
33
- ## Setup Instructions
34
-
35
- ### Prerequisites
36
-
37
- Ensure you have the following installed:
38
-
39
- - Python 3.8 or higher
40
- - Required Python packages (specified below)
41
-
42
- ### Installation
43
-
44
- 1. Clone the repository:
45
- ```bash
46
- git clone https://github.com/ISEF-soft/introduction-to-machine-learning-challenge-abdellatif-laghjaj
47
- cd introduction-to-machine-learning-challenge-abdellatif-laghjaj
48
- ```
49
-
50
- 2. Create and activate a virtual environment:
51
- ```bash
52
- python -m venv venv
53
- source venv/bin/activate # On Windows use `venv\Scripts\activate`
54
- ```
55
-
56
- 3. Install the required packages:
57
- ```bash
58
- pip install -r requirements.txt
59
- ```
60
-
61
- ### Directory Structure
62
-
63
- Ensure your project directory is structured as follows:
64
-
65
- ```
66
- birdclef2024/
67
- β”‚
68
- β”œβ”€β”€ sounds/
69
- β”‚ β”œβ”€β”€ asbfly.ogg
70
- β”‚ β”œβ”€β”€ bkwsti.ogg
71
- β”‚ └── comros.ogg
72
- β”‚
73
- |── .gitignore
74
- β”œβ”€β”€ model.joblib
75
- β”œβ”€β”€ data.csv
76
- β”œβ”€β”€ app.py
77
- |── main.ipynb
78
- β”œβ”€β”€ README.md
79
- └── requirements.txt
80
- ```
81
-
82
- ### Files Description
83
-
84
- - `sounds/`: Directory containing sample audio files.
85
- - `model.joblib`: Pre-trained machine learning model.
86
- - `data.csv`: CSV file containing bird species metadata.
87
- - `app.py`: Main Python script to run the project.
88
- - `main.ipynb`: Jupyter notebook containing the project code.
89
- - `README.md`: This readme file.
90
- - `requirements.txt`: List of Python packages required.
91
-
92
- ### Running the Project
93
-
94
- 1. Ensure you have the correct directory structure and all necessary files.
95
- 2. Run the `app.py` script to start the Gradio interface:
96
- ```bash
97
- python apy.py
98
- ```
99
-
100
- ### Usage
101
-
102
- Once the Gradio interface is launched, you can:
103
-
104
- - **Upload an audio recording** of a bird to identify the species.
105
- - **Select a sample** from the provided audio files.
106
-
107
- The interface will display:
108
-
109
- - The **predicted bird species**.
110
- - The **prediction confidence**.
111
- - A **map** showing the location of the recording.
112
- - A **spectrogram** of the audio recording.
113
-
114
- ## Acknowledgements
115
-
116
- This project is based on the BirdCLEF 2024 competition. Special thanks to the organizers and contributors who provided
117
- the dataset and resources.
 
1
+ title: BirdCLEF 2024
2
+ emoji: πŸ‘
3
+ colorFrom: yellow
4
+ colorTo: pink
5
+ sdk: gradio
6
+ sdk_version: 4.36.0
7
+ app_file: app.py
8
+ pinned: false
9
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference