sourize commited on
Commit
30559f0
Β·
1 Parent(s): 86b6a5f

Initial Commit

Browse files
Files changed (1) hide show
  1. README.md +61 -0
README.md CHANGED
@@ -1,3 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # πŸ›‘οΈ E-Commerce Fraud Detection System
2
 
3
  A Streamlit app for real-time e-commerce fraud detection using machine learning and explainable AI.
@@ -25,6 +45,41 @@ lightgbm_model.pkl
25
  customer_loc.pkl
26
  ```
27
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
  ## πŸ§‘β€πŸ’» Local Development
29
  1. Install dependencies:
30
  ```bash
@@ -57,6 +112,12 @@ The app will be available at [http://localhost:8501](http://localhost:8501).
57
 
58
  > **Note:** For Docker-based Spaces, select the **Docker** SDK and ensure your Dockerfile is present in the repo.
59
 
 
 
 
 
 
 
60
  ## πŸ“¦ Requirements
61
  All dependencies are listed in `requirements.txt`.
62
 
 
1
+ ---
2
+ title: E-Commerce Fraud Detection
3
+ emoji: πŸ›‘οΈ
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: streamlit
7
+ sdk_version: 1.28.1
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
+ tags:
12
+ - fraud-detection
13
+ - machine-learning
14
+ - streamlit
15
+ - e-commerce
16
+ - security
17
+ datasets:
18
+ - fraud-detection-dataset
19
+ ---
20
+
21
  # πŸ›‘οΈ E-Commerce Fraud Detection System
22
 
23
  A Streamlit app for real-time e-commerce fraud detection using machine learning and explainable AI.
 
45
  customer_loc.pkl
46
  ```
47
 
48
+ ## βš™οΈ Configuration
49
+
50
+ ### Hugging Face Space Configuration
51
+ For optimal deployment on Hugging Face Spaces, ensure your repository includes:
52
+
53
+ #### Space Metadata (README.md)
54
+ ```yaml
55
+ ---
56
+ title: E-Commerce Fraud Detection
57
+ emoji: πŸ›‘οΈ
58
+ colorFrom: blue
59
+ colorTo: purple
60
+ sdk: streamlit
61
+ sdk_version: 1.28.1
62
+ app_file: app.py
63
+ pinned: false
64
+ license: mit
65
+ ---
66
+ ```
67
+
68
+ #### Space Configuration (README.md)
69
+ Add this section to your README for better Space discovery:
70
+ ```yaml
71
+ ---
72
+ tags:
73
+ - fraud-detection
74
+ - machine-learning
75
+ - streamlit
76
+ - e-commerce
77
+ - security
78
+ datasets:
79
+ - fraud-detection-dataset
80
+ ---
81
+ ```
82
+
83
  ## πŸ§‘β€πŸ’» Local Development
84
  1. Install dependencies:
85
  ```bash
 
112
 
113
  > **Note:** For Docker-based Spaces, select the **Docker** SDK and ensure your Dockerfile is present in the repo.
114
 
115
+ ### Space Configuration Files
116
+ - **app.py**: Main Streamlit application entry point
117
+ - **requirements.txt**: Python dependencies
118
+ - **Dockerfile**: For Docker-based deployment
119
+ - **README.md**: Space metadata and documentation
120
+
121
  ## πŸ“¦ Requirements
122
  All dependencies are listed in `requirements.txt`.
123