Update README.md
Browse files
README.md
CHANGED
|
@@ -17,24 +17,12 @@ A Transformer-based classifier that checks if a provided last name is likely to
|
|
| 17 |
---
|
| 18 |
## Table of Contents
|
| 19 |
|
| 20 |
-
- [Overview](#overview)
|
| 21 |
- [Project Structure](#project_structure)
|
| 22 |
- [Installation](#installation)
|
| 23 |
- [Usage](#usage)
|
| 24 |
- [Support Me](#support-me)
|
| 25 |
- [License](#license)
|
| 26 |
-
---
|
| 27 |
-
|
| 28 |
-
## Overview
|
| 29 |
-
|
| 30 |
-
The goal of this project is to determine if a given first name is "real" (from a curated dataset) or "fake" (randomly generated). The project includes:
|
| 31 |
|
| 32 |
-
- **Custom Reinforcement Learning Setup:** Using OpenAI Gym and PPO for training.
|
| 33 |
-
- **Transformer Fine-tuning:** Leveraging a pre-trained DistilBERT model with Hugging Face’s Trainer API.
|
| 34 |
-
- **Deployment:** Code for a Flask API for real-time inference.
|
| 35 |
-
- **Model Hosting:** Support for pushing the model (in `.safetensors` format) to a private Hugging Face repository, ensuring seamless CPU/GPU usage.
|
| 36 |
-
|
| 37 |
-
---
|
| 38 |
## Project Structure
|
| 39 |
|
| 40 |
```
|
|
|
|
| 17 |
---
|
| 18 |
## Table of Contents
|
| 19 |
|
|
|
|
| 20 |
- [Project Structure](#project_structure)
|
| 21 |
- [Installation](#installation)
|
| 22 |
- [Usage](#usage)
|
| 23 |
- [Support Me](#support-me)
|
| 24 |
- [License](#license)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 25 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 26 |
## Project Structure
|
| 27 |
|
| 28 |
```
|