davanstrien HF Staff commited on
Commit
763d5c9
Β·
1 Parent(s): 400d1bf

Enhance README.md with additional clarity and usage details for OCR scripts

Browse files
Files changed (1) hide show
  1. README.md +8 -1
README.md CHANGED
@@ -5,11 +5,13 @@ tags: [uv-script, ocr, vision-language-model, document-processing]
5
 
6
  # OCR UV Scripts
7
 
 
 
8
  Ready-to-run OCR scripts that work with `uv run` - no setup required!
9
 
10
  ## πŸš€ Quick Start with HuggingFace Jobs
11
 
12
- Run OCR on any dataset without a GPU:
13
 
14
  ```bash
15
  hf jobs uv run --flavor l4x1 \
@@ -22,6 +24,7 @@ That's it! The script will:
22
  - βœ… Process all images in your dataset
23
  - βœ… Add OCR results as a new `markdown` column
24
  - βœ… Push the results to a new dataset
 
25
 
26
  ## πŸ“‹ Available Scripts
27
 
@@ -93,6 +96,10 @@ uv run https://huggingface.co/datasets/uv-scripts/ocr/raw/main/nanonets-ocr.py \
93
  input-dataset output-dataset
94
  ```
95
 
 
 
 
 
96
  ## πŸŽ›οΈ Configuration Options
97
 
98
  | Option | Default | Description |
 
5
 
6
  # OCR UV Scripts
7
 
8
+ > Part of [uv-scripts](https://huggingface.co/uv-scripts) - ready-to-run ML tools powered by UV
9
+
10
  Ready-to-run OCR scripts that work with `uv run` - no setup required!
11
 
12
  ## πŸš€ Quick Start with HuggingFace Jobs
13
 
14
+ Run OCR on any dataset without needing your own GPU:
15
 
16
  ```bash
17
  hf jobs uv run --flavor l4x1 \
 
24
  - βœ… Process all images in your dataset
25
  - βœ… Add OCR results as a new `markdown` column
26
  - βœ… Push the results to a new dataset
27
+ - πŸ“Š View results at: `https://huggingface.co/datasets/[your-output-dataset]`
28
 
29
  ## πŸ“‹ Available Scripts
30
 
 
96
  input-dataset output-dataset
97
  ```
98
 
99
+ ## πŸ“ Works With
100
+
101
+ Any HuggingFace dataset containing images - documents, forms, receipts, books, handwriting.
102
+
103
  ## πŸŽ›οΈ Configuration Options
104
 
105
  | Option | Default | Description |