SoggyBurritos commited on
Commit
8dda02a
·
verified ·
1 Parent(s): 8dd46b8

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -34
README.md CHANGED
@@ -1,40 +1,20 @@
1
  ---
2
  title: Spam Classifier Agent
3
- emoji: 📧
4
- colorFrom: blue
5
- colorTo: green
6
- sdk: streamlit
7
- sdk_version: 1.47.1
8
- app_file: streamlit/app/main.py
9
- python_version: 3.10
 
 
 
10
  ---
11
 
12
- # 📧 Spam Classifier Agent Live Demo
13
 
14
- A Streamlit web application that leverages a fine-tuned GPT-2 model to classify text messages as either "SPAM" or "NOT SPAM". This agent helps users quickly determine the nature of a message. Try it here @ [SoggyBurritos/Spam_Classifier_Agent](https://huggingface.co/spaces/SoggyBurritos/Spam_Classifier_Agent)
15
 
16
- ## Features
17
-
18
- * **Text Input:** Easily enter any text message for classification.
19
- * **Real-time Prediction:** Get instant results on whether the message is spam or not.
20
- * **Probability Scores:** View the confidence scores for both "SPAM" and "NOT SPAM" categories.
21
- * **Intuitive UI:** A clean and user-friendly interface built with Streamlit.
22
- * **Fine-tuned GPT-2 Model:** Utilizes a powerful transformer model for accurate classification.
23
-
24
- ## 💻 How to Use
25
-
26
- 1. **Enter Text:** Type or paste the message you want to classify into the provided text area.
27
- 2. **Analyze:** Click the "Analyze Text" button.
28
- 3. **View Results:** The application will display the prediction (SPAM or NOT SPAM) along with the probability scores.
29
-
30
- ## ⚙️ Technical Details for Hugging Face Spaces
31
-
32
- **App File Location:**
33
- The main Streamlit application script is located at `streamlit/app/main.py`. Hugging Face Spaces will be configured to run this specific file.
34
-
35
- **Dependencies:**
36
- All required Python packages for this deployment is listed in `requirements.txt`.
37
-
38
- **Model & Data:**
39
- * The fine-tuned GPT-2 model weights (`Spam-Classifier-GPT2-Model.pt`) are expected to be in the `models/` directory at the root of the repository.
40
- * The application also relies on data preparation scripts which may download or create necessary data files.
 
1
  ---
2
  title: Spam Classifier Agent
3
+ emoji: 🚀
4
+ colorFrom: red
5
+ colorTo: red
6
+ sdk: docker
7
+ app_port: 8501
8
+ tags:
9
+ - streamlit
10
+ pinned: false
11
+ short_description: Streamlit template space
12
+ license: apache-2.0
13
  ---
14
 
15
+ # Welcome to Streamlit!
16
 
17
+ Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
18
 
19
+ If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
20
+ forums](https://discuss.streamlit.io).