sanaa-11 commited on
Commit
d0f9a1a
·
verified ·
1 Parent(s): 757e838

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +46 -0
README.md CHANGED
@@ -8,5 +8,51 @@ sdk_version: 1.40.1
8
  app_file: app.py
9
  pinned: false
10
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
8
  app_file: app.py
9
  pinned: false
10
  ---
11
+ # **Car Search Engine Based on LSI (Latent Semantic Indexing)**
12
+
13
+ ## **Description**
14
+ This interactive search engine uses the **LSI (Latent Semantic Indexing)** algorithm to search for cars based on keywords provided by the user. It is designed to explore a car dataset and display the most relevant results based on the search query.
15
+
16
+ The application presents results in card format, including details such as the car model, year, price, and a link for more information.
17
+
18
+ ---
19
+
20
+ ## **Features**
21
+ - Search for cars using keywords (e.g., "Peugeot Diesel Manual").
22
+ - Displays relevant results using advanced natural language processing techniques.
23
+ - Interactive user interface developed with **Streamlit**.
24
+ - Results pagination with cards.
25
+
26
+ ---
27
+
28
+ ## **How to Use the Application**
29
+ 1. Enter your search query in the input field.
30
+ 2. Use the slider to set the number of results to display per page.
31
+ 3. Click on the **Search** button.
32
+ 4. Navigate between result pages using the **Previous Page** and **Next Page** buttons.
33
+
34
+ ---
35
+
36
+ ## **Installation and Dependencies**
37
+ To run this application locally, you will need **Python** and the following libraries:
38
+ - **Streamlit**: For the user interface.
39
+ - **scikit-learn**: For LSI algorithms and similarity calculations.
40
+ - **pandas**: For dataset manipulation.
41
+
42
+ ### **Installation Steps**
43
+ 1. Clone the repository:
44
+ ```bash
45
+ git clone https://huggingface.co/spaces/sanaa-11/LSI
46
+ cd your-app-repository
47
+
48
+ 2-Install the required dependencies:
49
+ ```bash
50
+
51
+ pip install -r requirements.txt
52
+
53
+ 3 - Run the application:
54
+
55
+ ```bash
56
+ streamlit run app.py
57
 
58
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference