tc-mb commited on
Commit
580e4d0
·
verified ·
1 Parent(s): 14f74cd

docs: mark Jev API doc as stub

Browse files
Files changed (1) hide show
  1. README.md +3 -2
README.md CHANGED
@@ -111,7 +111,7 @@ The existing AUROC results do **not** establish a universal default threshold.
111
 
112
  | Deployment | Guide |
113
  | :--- | :--- |
114
- | Cloud API | [Single-candidate scoring, best-of-N, batched best-of-N](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/minicpm_ocr_jev_api_en.md) |
115
  | Docker / local SDK | [Environment, rendering options, service startup](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/minicpm_ocr_jev_tutorial_en.md) |
116
  | vLLM backend | [Service configuration with and without a renderer](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/vllm_deploy_jev_en.md) |
117
  | SGLang | [Deployment guide](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/sglang_deploy_jev_en.md) |
@@ -134,7 +134,8 @@ rendering, or forward-pass failures must not be read as low model scores.
134
  4. Emit selected results in the original reading order and keep pending regions for reviewers.
135
 
136
  Use `score` for one candidate, `score_best` for best-of-N within a block, and `score_best_batch`
137
- across blocks — see the [API documentation](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/minicpm_ocr_jev_api_en.md).
 
138
 
139
  ### Fine-tuning
140
 
 
111
 
112
  | Deployment | Guide |
113
  | :--- | :--- |
114
+ | Cloud API | [Single-candidate scoring, best-of-N, batched best-of-N](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/minicpm_ocr_jev_api_en.md) (stub — being written) |
115
  | Docker / local SDK | [Environment, rendering options, service startup](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/minicpm_ocr_jev_tutorial_en.md) |
116
  | vLLM backend | [Service configuration with and without a renderer](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/vllm_deploy_jev_en.md) |
117
  | SGLang | [Deployment guide](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/sglang_deploy_jev_en.md) |
 
134
  4. Emit selected results in the original reading order and keep pending regions for reviewers.
135
 
136
  Use `score` for one candidate, `score_best` for best-of-N within a block, and `score_best_batch`
137
+ across blocks — see the [API documentation](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/minicpm_ocr_jev_api_en.md) (stub for now;
138
+ until it lands use the [vLLM deploy guide for Jev](https://github.com/yiranyyu/MiniCPM-OCR-private/blob/main/docs/vllm_deploy_jev_en.md)).
139
 
140
  ### Fine-tuning
141