shakii commited on
Commit
f903d86
·
verified ·
1 Parent(s): ed81b57

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -21
README.md CHANGED
@@ -1,27 +1,31 @@
1
- # AI Text Detection API
 
 
 
 
 
 
 
 
 
2
 
3
- This API provides endpoints for detecting AI-generated text using the RoBERTa-based model from fakespot-ai.
4
 
5
- ## API Endpoints
6
 
7
- - GET `/`: Health check endpoint
8
- - POST `/predict`: Predict if text is AI-generated or human-written
9
 
10
- ### Sample Usage
11
 
12
- POST `/predict`
13
- ```json
14
- {
15
- "text": "Your text to analyze"
16
- }
17
- ```
18
 
19
- Response:
20
- ```json
21
- {
22
- "text": "Your text to analyze",
23
- "human_probability": 85.5,
24
- "ai_probability": 14.5,
25
- "prediction": "Human-written"
26
- }
27
- ```
 
 
1
+ ---
2
+ title: AI Text Detector
3
+ emoji: 🔍
4
+ colorFrom: indigo
5
+ colorTo: purple
6
+ sdk: gradio
7
+ sdk_version: 5.2.2
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
 
12
+ # AI Text Detector
13
 
14
+ This space hosts an API for detecting AI-generated text using the RoBERTa-based model [fakespot-ai/roberta-base-ai-text-detection-v1](https://huggingface.co/fakespot-ai/roberta-base-ai-text-detection-v1).
15
 
16
+ ## Model Details
 
17
 
18
+ The model is trained to distinguish between human-written and AI-generated text. It provides probability scores for both classes and makes predictions based on which score is higher.
19
 
20
+ ## Features
 
 
 
 
 
21
 
22
+ - Fast and efficient text analysis
23
+ - Returns probability scores for both human and AI-generated text
24
+ - Simple REST API interface
25
+ - CORS enabled for web applications
26
+
27
+ ## Deployment
28
+
29
+ This space is deployed as a FastAPI application and can be accessed via REST API endpoints.
30
+
31
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference