tommulder commited on
Commit
e5cac04
Β·
1 Parent(s): dda1af7

Add comprehensive table of contents to README with navigation links

Browse files
Files changed (1) hide show
  1. README.md +36 -2
README.md CHANGED
@@ -16,6 +16,40 @@ short_description: "YOLO-E European document detection with quality metrics"
16
 
17
  This Hugging Face Space provides a production-ready API for detecting and classifying European identity documents (passports, driver's licenses, identity cards) with advanced ML-based orientation detection and video processing capabilities.
18
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
19
  ## ✨ Features
20
 
21
  ### 🎯 European Document Detection
@@ -260,7 +294,7 @@ import requests
260
  # Image detection
261
  with open('document.jpg', 'rb') as f:
262
  response = requests.post(
263
- 'https://your-hf-space-url/v1/id/detect',
264
  files={'file': f},
265
  data={'min_confidence': 0.5}
266
  )
@@ -279,7 +313,7 @@ const formData = new FormData();
279
  formData.append('file', fileInput.files[0]);
280
  formData.append('min_confidence', '0.5');
281
 
282
- fetch('https://your-hf-space-url/v1/id/detect', {
283
  method: 'POST',
284
  body: formData
285
  })
 
16
 
17
  This Hugging Face Space provides a production-ready API for detecting and classifying European identity documents (passports, driver's licenses, identity cards) with advanced ML-based orientation detection and video processing capabilities.
18
 
19
+ ## πŸ“‹ Table of Contents
20
+
21
+ - [✨ Features](#-features)
22
+ - [🎯 European Document Detection](#-european-document-detection)
23
+ - [πŸŽ₯ Video Processing](#-video-processing)
24
+ - [πŸ”§ Technical Capabilities](#-technical-capabilities)
25
+ - [πŸš€ Quick Start](#-quick-start)
26
+ - [Image Detection](#image-detection)
27
+ - [Video Detection](#video-detection)
28
+ - [πŸ“Š API Endpoints](#-api-endpoints)
29
+ - [POST `/v1/id/detect`](#post-v1iddetect)
30
+ - [POST `/v1/id/detect-video`](#post-v1iddetect-video)
31
+ - [GET `/health`](#get-health)
32
+ - [🎯 Document Types Supported](#-document-types-supported)
33
+ - [πŸ” Orientation Classification](#-orientation-classification)
34
+ - [πŸ“ˆ Quality Metrics](#-quality-metrics)
35
+ - [⚑ Performance](#-performance)
36
+ - [πŸ› οΈ Configuration](#️-configuration)
37
+ - [Class Mapping](#class-mapping)
38
+ - [Model Weights](#model-weights)
39
+ - [πŸ”§ Deployment](#-deployment)
40
+ - [Hugging Face Spaces](#hugging-face-spaces)
41
+ - [GPU Docker Runtime](#gpu-docker-runtime)
42
+ - [Local Development](#local-development)
43
+ - [πŸ“ Example Usage](#-example-usage)
44
+ - [Python Client](#python-client)
45
+ - [JavaScript Client](#javascript-client)
46
+ - [🚨 Error Handling](#-error-handling)
47
+ - [Accessing the API](#accessing-the-api)
48
+ - [🎯 Test Results Summary](#-test-results-summary)
49
+ - [πŸ”’ Security & Privacy](#-security--privacy)
50
+ - [πŸ“Š Monitoring](#-monitoring)
51
+ - [πŸŽ‰ Future Enhancements](#-future-enhancements)
52
+
53
  ## ✨ Features
54
 
55
  ### 🎯 European Document Detection
 
294
  # Image detection
295
  with open('document.jpg', 'rb') as f:
296
  response = requests.post(
297
+ 'https://algoryn-yolo-e-idcard.hf.space/v1/id/detect',
298
  files={'file': f},
299
  data={'min_confidence': 0.5}
300
  )
 
313
  formData.append('file', fileInput.files[0]);
314
  formData.append('min_confidence', '0.5');
315
 
316
+ fetch('https://algoryn-yolo-e-idcard.hf.space/v1/id/detect', {
317
  method: 'POST',
318
  body: formData
319
  })