sus commited on
Update README.md
Browse files
README.md
CHANGED
|
@@ -16,7 +16,6 @@ pipeline_tag: text-classification
|
|
| 16 |
A simple Transformer-based classifier that checks if a provided last name is likely to be **real** (LABEL_1) or **fake** (LABEL_0). This can be helpful in validating contact form submissions, preventing bot entries, or for general name classification tasks.
|
| 17 |
|
| 18 |
---
|
| 19 |
-
|
| 20 |
## Table of Contents
|
| 21 |
|
| 22 |
- [Overview](#overview)
|
|
@@ -30,7 +29,6 @@ A simple Transformer-based classifier that checks if a provided last name is lik
|
|
| 30 |
- [Project Structure](#project-structure)
|
| 31 |
- [Support Me](#support-me)
|
| 32 |
- [License](#license)
|
| 33 |
-
|
| 34 |
---
|
| 35 |
|
| 36 |
## Overview
|
|
@@ -42,6 +40,24 @@ The goal of this project is to determine if a given first name is "real" (from a
|
|
| 42 |
- **Deployment:** Code for a Flask API for real-time inference.
|
| 43 |
- **Model Hosting:** Support for pushing the model (in `.safetensors` format) to a private Hugging Face repository, ensuring seamless CPU/GPU usage.
|
| 44 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 45 |
## Installation
|
| 46 |
|
| 47 |
1. **Clone the Repository:**
|
|
@@ -61,7 +77,7 @@ The goal of this project is to determine if a given first name is "real" (from a
|
|
| 61 |
---
|
| 62 |
|
| 63 |
## Usage
|
| 64 |
-
|
| 65 |
```python
|
| 66 |
from transformers import pipeline
|
| 67 |
|
|
@@ -106,26 +122,6 @@ Name: trump => Prediction: LABEL_1, Score: 0.9998
|
|
| 106 |
- **Flask API:**
|
| 107 |
Deploy a Flask API to accept a first name as input and return a prediction (real or fake) in real time.
|
| 108 |
|
| 109 |
-
---
|
| 110 |
-
|
| 111 |
-
## Project Structure
|
| 112 |
-
|
| 113 |
-
```
|
| 114 |
-
Last_Name_Prediction/
|
| 115 |
-
├── .gitattributes
|
| 116 |
-
├── README.md
|
| 117 |
-
├── config.json
|
| 118 |
-
├── model.safetensors
|
| 119 |
-
├── requirements.txt
|
| 120 |
-
├── special_tokens_map.json
|
| 121 |
-
├── tokenizer.json
|
| 122 |
-
├── tokenizer_config.json
|
| 123 |
-
└── vocab.txt
|
| 124 |
-
|
| 125 |
-
```
|
| 126 |
-
|
| 127 |
-
---
|
| 128 |
-
|
| 129 |
## Support Me
|
| 130 |
|
| 131 |
If you find this project helpful and would like to support my work, please consider donating using crypto.
|
|
|
|
| 16 |
A simple Transformer-based classifier that checks if a provided last name is likely to be **real** (LABEL_1) or **fake** (LABEL_0). This can be helpful in validating contact form submissions, preventing bot entries, or for general name classification tasks.
|
| 17 |
|
| 18 |
---
|
|
|
|
| 19 |
## Table of Contents
|
| 20 |
|
| 21 |
- [Overview](#overview)
|
|
|
|
| 29 |
- [Project Structure](#project-structure)
|
| 30 |
- [Support Me](#support-me)
|
| 31 |
- [License](#license)
|
|
|
|
| 32 |
---
|
| 33 |
|
| 34 |
## Overview
|
|
|
|
| 40 |
- **Deployment:** Code for a Flask API for real-time inference.
|
| 41 |
- **Model Hosting:** Support for pushing the model (in `.safetensors` format) to a private Hugging Face repository, ensuring seamless CPU/GPU usage.
|
| 42 |
|
| 43 |
+
---
|
| 44 |
+
## Project Structure
|
| 45 |
+
|
| 46 |
+
```
|
| 47 |
+
Last_Name_Prediction/
|
| 48 |
+
├── .gitattributes
|
| 49 |
+
├── README.md
|
| 50 |
+
├── config.json
|
| 51 |
+
├── model.safetensors
|
| 52 |
+
├── requirements.txt
|
| 53 |
+
├── special_tokens_map.json
|
| 54 |
+
├── tokenizer.json
|
| 55 |
+
├── tokenizer_config.json
|
| 56 |
+
└── vocab.txt
|
| 57 |
+
|
| 58 |
+
```
|
| 59 |
+
---
|
| 60 |
+
|
| 61 |
## Installation
|
| 62 |
|
| 63 |
1. **Clone the Repository:**
|
|
|
|
| 77 |
---
|
| 78 |
|
| 79 |
## Usage
|
| 80 |
+
Python
|
| 81 |
```python
|
| 82 |
from transformers import pipeline
|
| 83 |
|
|
|
|
| 122 |
- **Flask API:**
|
| 123 |
Deploy a Flask API to accept a first name as input and return a prediction (real or fake) in real time.
|
| 124 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 125 |
## Support Me
|
| 126 |
|
| 127 |
If you find this project helpful and would like to support my work, please consider donating using crypto.
|