typhoon-ocr2 0.1.0__tar.gz

typhoon_ocr2-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 SCB 10X Co., Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

typhoon_ocr2-0.1.0/NOTICE

@@ -0,0 +1,7 @@
+typhoon-ocr2
+Copyright 2026 Surapon Nonesung
+
+This project is derived from typhoon-ocr (https://github.com/scb-10x/typhoon-ocr),
+Copyright the Typhoon OCR Contributors, SCB 10X, licensed under the Apache License 2.0.
+It is maintained as a separate package with the Typhoon team's permission.
+"Typhoon" is used to refer to the Typhoon models; this package is not an official SCB 10X product.

typhoon_ocr2-0.1.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: typhoon-ocr2
+Version: 0.1.0
+Summary: Parse Thai and English documents (PDFs and images) into layout elements and Markdown with Typhoon OCR V2
+Author: Surapon Nonesung
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/srn-source/typhoon-ocr2
+Project-URL: Model (2B), https://huggingface.co/typhoon-ai/typhoon-ocr2-2b
+Project-URL: Model (0.8B), https://huggingface.co/typhoon-ai/typhoon-ocr2-0.8b
+Project-URL: Playground, https://playground.opentyphoon.ai/ocr
+Keywords: ocr,document-parsing,layout-analysis,thai,vlm,typhoon
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Natural Language :: Thai
+Classifier: Natural Language :: English
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: httpx>=0.24
+Requires-Dist: pillow>=9.0
+Requires-Dist: pypdfium2>=4.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Dynamic: license-file
+
+# typhoon-ocr2
+
+Read Thai and English documents (PDFs and images) with **Typhoon OCR**. For every page you get:
+
+- the page as **Markdown** (tables as HTML, formulas as LaTeX), and
+- with Typhoon OCR V2, the **layout elements** in reading order: each one has a category (title, text, table, …), a bounding box and its text.
+
+Links: [Typhoon OCR V2 2B](https://huggingface.co/typhoon-ai/typhoon-ocr2-2b) · [Typhoon OCR V2 0.8B](https://huggingface.co/typhoon-ai/typhoon-ocr2-0.8b) · [Playground](https://playground.opentyphoon.ai/ocr) · [Typhoon API docs](https://docs.opentyphoon.ai/)
+
+This package continues [scb-10x/typhoon-ocr](https://github.com/scb-10x/typhoon-ocr) (`pip install typhoon-ocr`) with the Typhoon team's permission. It has a new name, so code that uses `typhoon-ocr` keeps working.
+
+## Install
+
+```bash
+pip install typhoon-ocr2
+```
+
+PDF support is included; you do not need to install Poppler.
+
+## Quick start: Typhoon API (no GPU needed)
+
+```python
+import os
+from typhoon_ocr2 import TyphoonOCR
+
+os.environ["TYPHOON_API_KEY"] = "YOUR_KEY"       # your Typhoon API key (or pass api_key="YOUR_KEY" below)
+
+ocr = TyphoonOCR(
+    base_url="https://api.opentyphoon.ai/v1",    # the Typhoon API
+    version="v2",                                # Typhoon OCR V2 ("v1.5" for Typhoon OCR 1.5)
+    upscale=True,                                # enlarge images under 1,600 px (recommended; see Settings)
+)
+
+pages = ocr.parse("report.pdf", pages="1-3")     # a PDF or an image; pages: "1-3", 2, [1, 4] or None for all
+for page in pages:
+    print(f"--- page {page.page}")
+    print(page.markdown)
+```
+
+## Typhoon OCR V2 or 1.5
+
+Switch with `version`; the rest of the code stays the same.
+
+```python
+ocr_v15 = TyphoonOCR(
+    base_url="https://api.opentyphoon.ai/v1",
+    version="v1.5",
+)
+print(ocr_v15.parse("page.jpg")[0].markdown)
+```
+
+| | `version="v2"` | `version="v1.5"` |
+|---|---|---|
+| model used on the Typhoon API | `typhoon-ocr-v2` | `typhoon-ocr-v1.5` |
+| `page.markdown` | yes | yes |
+| `page.elements` (category, box, text) | yes | no (empty list) |
+| `ask()` / `extract()` | yes | not tested |
+
+**`version` or `model`?** `version` tells the package which prompt to send and how to read the answer. `model` is the model's name on the server. On the Typhoon API you only need `version`: the package picks the matching model for you. You need `model` when you run the model yourself (next section), because there the name depends on how you started the server.
+
+## Run the model yourself
+
+Start a server, then point `base_url` and `model` at it:
+
+```bash
+# vLLM 0.33.0 or newer (GPU)
+vllm serve typhoon-ai/typhoon-ocr2-2b --max-model-len 40960 \
+  --limit-mm-per-prompt '{"image": 1}' \
+  --mm-processor-kwargs '{"min_pixels": 2048, "max_pixels": 16777216}'
+
+# Ollama 0.40.15 or newer
+ollama pull SuraponOCR/typhoon-ocr2-2b
+
+# llama.cpp (GGUF)
+llama-server -hf typhoon-ai/typhoon-ocr2-2b-GGUF:Q8_0 --jinja --reasoning off -c 40960 --image-max-tokens 16384
+```
+
+| Server | `base_url` | `model` |
+|---|---|---|
+| vLLM | `"http://localhost:8000/v1"` | `"typhoon-ai/typhoon-ocr2-2b"` |
+| Ollama | `"http://localhost:11434"` | `"SuraponOCR/typhoon-ocr2-2b"` |
+| llama.cpp | `"http://localhost:8080/v1"` | `"typhoon-ocr2"` (llama-server serves one model; any name works) |
+
+```python
+ocr = TyphoonOCR(
+    base_url="http://localhost:8000/v1",
+    model="typhoon-ai/typhoon-ocr2-2b",
+    version="v2",
+    upscale=True,
+)
+```
+
+For the smaller page parser, use `typhoon-ai/typhoon-ocr2-0.8b` (Ollama: `SuraponOCR/typhoon-ocr2-0.8b`). On vLLM older than 0.33.0, add `--enforce-eager` to `vllm serve`: in the default compiled mode of vLLM 0.27.1, accuracy dropped by about 9 points on MDPBench. Other OpenAI-compatible servers work the same way.
+
+## What you get back
+
+`ocr.parse()` returns one `PageResult` per page:
+
+| Field | Meaning |
+|---|---|
+| `page.page` | page number (1-based) |
+| `page.markdown` | the page as Markdown; by default without headers, footers and page footnotes (see below) |
+| `page.elements` | V2 only: **every** element the model returned, as `{"bbox": [x1, y1, x2, y2], "category": "...", "text": "..."}`, in reading order |
+| `page.image_size` | `(width, height)` of the page image the boxes refer to |
+| `page.truncated` | True if the output stopped at the token limit (usually a repetition loop); `elements` keeps the complete ones |
+| `page.raw` | the model's raw output |
+
+### Headers, footers and other categories
+
+The model always returns header, footer and page_footnote elements, and they are always in `page.elements`. Only `page.markdown` leaves them out by default, because that is how the model was evaluated (and running page numbers and headers usually get in the way of reading). You choose what the Markdown keeps:
+
+```python
+pages = ocr.parse("report.pdf")                                   # default: no header, footer, page_footnote
+pages = ocr.parse("report.pdf", keep_header_footer=True)          # keep every element
+pages = ocr.parse("report.pdf", exclude=["footer"])               # keep headers, drop footers only
+pages = ocr.parse("report.pdf", exclude=["header", "footer", "page_footnote", "figure_caption"])  # your own list
+
+footers = [e["text"] for e in pages[0].elements if e["category"] == "footer"]   # the elements themselves
+```
+
+On the command line: `--keep-header-footer`, or `--exclude footer` (several names allowed; `--exclude` with no names keeps everything).
+
+The 13 categories are header, title, text, figure, table, formula, figure_caption, table_caption, formula_caption, figure_footnote, table_footnote, page_footnote and footer. Boxes use a 0–1000 grid relative to the page, so they do not depend on the image size:
+
+```python
+from typhoon_ocr2 import draw_layout, load_pages, to_pixels
+
+image = load_pages("report.pdf", pages=[1])[0]
+first = pages[0].elements[0]
+print(first["category"], to_pixels(first["bbox"], *image.size))   # box in pixels
+draw_layout(image, pages[0].elements).save("page1_layout.png")     # boxes numbered in reading order
+```
+
+## Questions and key information (Typhoon OCR V2 2B)
+
+```python
+answer = ocr.ask("receipt.jpg", "What is the total amount?")      # plain text
+fields = ocr.extract("receipt.jpg", ["Date", "Total", "VAT 7%"])   # dict with these keys
+everything = ocr.extract("receipt.jpg")                            # every field; the model picks the keys
+```
+
+The 0.8B model is a page parser only; it is much weaker at questions and extraction. Check extracted values before you use them: key-information extraction is the 2B model's weakest task.
+
+## Command line
+
+```bash
+export TYPHOON_API_KEY=YOUR_KEY
+API=https://api.opentyphoon.ai/v1
+
+typhoon-ocr2 report.pdf --base-url $API                                  # Markdown of every page (V2)
+typhoon-ocr2 report.pdf --base-url $API --pages 2-4 --format json        # layout elements
+typhoon-ocr2 receipt.jpg --base-url $API --ask "What is the total amount?"
+typhoon-ocr2 receipt.jpg --base-url $API --extract Date Total
+typhoon-ocr2 page.jpg --base-url $API --version v1.5                     # Typhoon OCR 1.5
+typhoon-ocr2 page.jpg --base-url http://localhost:11434 --model SuraponOCR/typhoon-ocr2-2b   # Ollama
+```
+
+To avoid repeating `--base-url`, set `TYPHOON_OCR_BASE_URL`. Add `--no-upscale` to turn upscaling off.
+
+## Settings
+
+All settings of `TyphoonOCR(...)`. The defaults are the settings the models were evaluated with.
+
+| Setting | Default | What it does |
+|---|---|---|
+| `base_url` | `$TYPHOON_OCR_BASE_URL`, else `"http://localhost:8000/v1"` | server address |
+| `model` | on the Typhoon API, chosen from `version`; on Ollama, `"SuraponOCR/typhoon-ocr2-2b"`; on other servers, the first model they serve | model name on the server; needed only for your own server |
+| `api_key` | `$TYPHOON_API_KEY` | key for the Typhoon API |
+| `version` | `"v2"` (or follows `model`, if you set one) | `"v2"` or `"v1.5"`: the prompt and output format |
+| `upscale` | `True` | enlarge images whose long side is under 1,600 px. On ThaiOCRBench this raised Typhoon OCR V2 2B from 59.9 to 62.9 and 0.8B from 37.3 to 41.3; large pages are not changed. `False` turns it off; a number sets another size |
+| `max_tokens` | `16384` | output limit per page |
+| `pdf_long_side` | `2048` | PDF pages are rendered with this long side, in pixels |
+| `max_workers` | `4` | PDF pages sent in parallel |
+| `timeout` | `600` | seconds to wait for one page |
+| `backend` | `"auto"` | `"openai"` or `"ollama"`; auto picks Ollama for `http://localhost:11434` |
+| `figure_language` | `"Thai"` | v1.5 only: language of figure descriptions |
+
+The prompts are the ones the models were trained with (`typhoon_ocr2.PARSE_PROMPT` for V2), and decoding is greedy with thinking turned off.
+
+## Coming from `typhoon-ocr`
+
+| `typhoon-ocr` | `typhoon-ocr2` |
+|---|---|
+| `from typhoon_ocr import ocr_document` | `from typhoon_ocr2 import ocr_document` (same idea), or `TyphoonOCR` for more |
+| `ocr_document(path, page_num=1, base_url=..., model=...)` | `ocr_document(path, pages=1, base_url=..., model=...)` |
+| returns a Markdown string | `TyphoonOCR.parse()` also returns layout elements with boxes |
+| one page per call | `pages="1-3,5"` or all pages, sent in parallel |
+| needs Poppler for PDFs | no system dependency |
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                                                                  # unit tests, no GPU needed
+TYPHOON_OCR2_TEST_URL=http://localhost:8000/v1 pytest -m integration    # against a running server
+```
+
+## Releasing
+
+1. On pypi.org, add a Trusted Publisher for project `typhoon-ocr2`: this GitHub repository, workflow `publish.yml`, environment `pypi`.
+2. Bump `__version__` in `src/typhoon_ocr2/__init__.py`, commit, then tag and push: `git tag v0.1.0 && git push origin v0.1.0`.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). Use of the Typhoon models is subject to the [OpenTyphoon Terms and Conditions](https://opentyphoon.ai/tac).

typhoon_ocr2-0.1.0/README.md

@@ -0,0 +1,205 @@
+# typhoon-ocr2
+
+Read Thai and English documents (PDFs and images) with **Typhoon OCR**. For every page you get:
+
+- the page as **Markdown** (tables as HTML, formulas as LaTeX), and
+- with Typhoon OCR V2, the **layout elements** in reading order: each one has a category (title, text, table, …), a bounding box and its text.
+
+Links: [Typhoon OCR V2 2B](https://huggingface.co/typhoon-ai/typhoon-ocr2-2b) · [Typhoon OCR V2 0.8B](https://huggingface.co/typhoon-ai/typhoon-ocr2-0.8b) · [Playground](https://playground.opentyphoon.ai/ocr) · [Typhoon API docs](https://docs.opentyphoon.ai/)
+
+This package continues [scb-10x/typhoon-ocr](https://github.com/scb-10x/typhoon-ocr) (`pip install typhoon-ocr`) with the Typhoon team's permission. It has a new name, so code that uses `typhoon-ocr` keeps working.
+
+## Install
+
+```bash
+pip install typhoon-ocr2
+```
+
+PDF support is included; you do not need to install Poppler.
+
+## Quick start: Typhoon API (no GPU needed)
+
+```python
+import os
+from typhoon_ocr2 import TyphoonOCR
+
+os.environ["TYPHOON_API_KEY"] = "YOUR_KEY"       # your Typhoon API key (or pass api_key="YOUR_KEY" below)
+
+ocr = TyphoonOCR(
+    base_url="https://api.opentyphoon.ai/v1",    # the Typhoon API
+    version="v2",                                # Typhoon OCR V2 ("v1.5" for Typhoon OCR 1.5)
+    upscale=True,                                # enlarge images under 1,600 px (recommended; see Settings)
+)
+
+pages = ocr.parse("report.pdf", pages="1-3")     # a PDF or an image; pages: "1-3", 2, [1, 4] or None for all
+for page in pages:
+    print(f"--- page {page.page}")
+    print(page.markdown)
+```
+
+## Typhoon OCR V2 or 1.5
+
+Switch with `version`; the rest of the code stays the same.
+
+```python
+ocr_v15 = TyphoonOCR(
+    base_url="https://api.opentyphoon.ai/v1",
+    version="v1.5",
+)
+print(ocr_v15.parse("page.jpg")[0].markdown)
+```
+
+| | `version="v2"` | `version="v1.5"` |
+|---|---|---|
+| model used on the Typhoon API | `typhoon-ocr-v2` | `typhoon-ocr-v1.5` |
+| `page.markdown` | yes | yes |
+| `page.elements` (category, box, text) | yes | no (empty list) |
+| `ask()` / `extract()` | yes | not tested |
+
+**`version` or `model`?** `version` tells the package which prompt to send and how to read the answer. `model` is the model's name on the server. On the Typhoon API you only need `version`: the package picks the matching model for you. You need `model` when you run the model yourself (next section), because there the name depends on how you started the server.
+
+## Run the model yourself
+
+Start a server, then point `base_url` and `model` at it:
+
+```bash
+# vLLM 0.33.0 or newer (GPU)
+vllm serve typhoon-ai/typhoon-ocr2-2b --max-model-len 40960 \
+  --limit-mm-per-prompt '{"image": 1}' \
+  --mm-processor-kwargs '{"min_pixels": 2048, "max_pixels": 16777216}'
+
+# Ollama 0.40.15 or newer
+ollama pull SuraponOCR/typhoon-ocr2-2b
+
+# llama.cpp (GGUF)
+llama-server -hf typhoon-ai/typhoon-ocr2-2b-GGUF:Q8_0 --jinja --reasoning off -c 40960 --image-max-tokens 16384
+```
+
+| Server | `base_url` | `model` |
+|---|---|---|
+| vLLM | `"http://localhost:8000/v1"` | `"typhoon-ai/typhoon-ocr2-2b"` |
+| Ollama | `"http://localhost:11434"` | `"SuraponOCR/typhoon-ocr2-2b"` |
+| llama.cpp | `"http://localhost:8080/v1"` | `"typhoon-ocr2"` (llama-server serves one model; any name works) |
+
+```python
+ocr = TyphoonOCR(
+    base_url="http://localhost:8000/v1",
+    model="typhoon-ai/typhoon-ocr2-2b",
+    version="v2",
+    upscale=True,
+)
+```
+
+For the smaller page parser, use `typhoon-ai/typhoon-ocr2-0.8b` (Ollama: `SuraponOCR/typhoon-ocr2-0.8b`). On vLLM older than 0.33.0, add `--enforce-eager` to `vllm serve`: in the default compiled mode of vLLM 0.27.1, accuracy dropped by about 9 points on MDPBench. Other OpenAI-compatible servers work the same way.
+
+## What you get back
+
+`ocr.parse()` returns one `PageResult` per page:
+
+| Field | Meaning |
+|---|---|
+| `page.page` | page number (1-based) |
+| `page.markdown` | the page as Markdown; by default without headers, footers and page footnotes (see below) |
+| `page.elements` | V2 only: **every** element the model returned, as `{"bbox": [x1, y1, x2, y2], "category": "...", "text": "..."}`, in reading order |
+| `page.image_size` | `(width, height)` of the page image the boxes refer to |
+| `page.truncated` | True if the output stopped at the token limit (usually a repetition loop); `elements` keeps the complete ones |
+| `page.raw` | the model's raw output |
+
+### Headers, footers and other categories
+
+The model always returns header, footer and page_footnote elements, and they are always in `page.elements`. Only `page.markdown` leaves them out by default, because that is how the model was evaluated (and running page numbers and headers usually get in the way of reading). You choose what the Markdown keeps:
+
+```python
+pages = ocr.parse("report.pdf")                                   # default: no header, footer, page_footnote
+pages = ocr.parse("report.pdf", keep_header_footer=True)          # keep every element
+pages = ocr.parse("report.pdf", exclude=["footer"])               # keep headers, drop footers only
+pages = ocr.parse("report.pdf", exclude=["header", "footer", "page_footnote", "figure_caption"])  # your own list
+
+footers = [e["text"] for e in pages[0].elements if e["category"] == "footer"]   # the elements themselves
+```
+
+On the command line: `--keep-header-footer`, or `--exclude footer` (several names allowed; `--exclude` with no names keeps everything).
+
+The 13 categories are header, title, text, figure, table, formula, figure_caption, table_caption, formula_caption, figure_footnote, table_footnote, page_footnote and footer. Boxes use a 0–1000 grid relative to the page, so they do not depend on the image size:
+
+```python
+from typhoon_ocr2 import draw_layout, load_pages, to_pixels
+
+image = load_pages("report.pdf", pages=[1])[0]
+first = pages[0].elements[0]
+print(first["category"], to_pixels(first["bbox"], *image.size))   # box in pixels
+draw_layout(image, pages[0].elements).save("page1_layout.png")     # boxes numbered in reading order
+```
+
+## Questions and key information (Typhoon OCR V2 2B)
+
+```python
+answer = ocr.ask("receipt.jpg", "What is the total amount?")      # plain text
+fields = ocr.extract("receipt.jpg", ["Date", "Total", "VAT 7%"])   # dict with these keys
+everything = ocr.extract("receipt.jpg")                            # every field; the model picks the keys
+```
+
+The 0.8B model is a page parser only; it is much weaker at questions and extraction. Check extracted values before you use them: key-information extraction is the 2B model's weakest task.
+
+## Command line
+
+```bash
+export TYPHOON_API_KEY=YOUR_KEY
+API=https://api.opentyphoon.ai/v1
+
+typhoon-ocr2 report.pdf --base-url $API                                  # Markdown of every page (V2)
+typhoon-ocr2 report.pdf --base-url $API --pages 2-4 --format json        # layout elements
+typhoon-ocr2 receipt.jpg --base-url $API --ask "What is the total amount?"
+typhoon-ocr2 receipt.jpg --base-url $API --extract Date Total
+typhoon-ocr2 page.jpg --base-url $API --version v1.5                     # Typhoon OCR 1.5
+typhoon-ocr2 page.jpg --base-url http://localhost:11434 --model SuraponOCR/typhoon-ocr2-2b   # Ollama
+```
+
+To avoid repeating `--base-url`, set `TYPHOON_OCR_BASE_URL`. Add `--no-upscale` to turn upscaling off.
+
+## Settings
+
+All settings of `TyphoonOCR(...)`. The defaults are the settings the models were evaluated with.
+
+| Setting | Default | What it does |
+|---|---|---|
+| `base_url` | `$TYPHOON_OCR_BASE_URL`, else `"http://localhost:8000/v1"` | server address |
+| `model` | on the Typhoon API, chosen from `version`; on Ollama, `"SuraponOCR/typhoon-ocr2-2b"`; on other servers, the first model they serve | model name on the server; needed only for your own server |
+| `api_key` | `$TYPHOON_API_KEY` | key for the Typhoon API |
+| `version` | `"v2"` (or follows `model`, if you set one) | `"v2"` or `"v1.5"`: the prompt and output format |
+| `upscale` | `True` | enlarge images whose long side is under 1,600 px. On ThaiOCRBench this raised Typhoon OCR V2 2B from 59.9 to 62.9 and 0.8B from 37.3 to 41.3; large pages are not changed. `False` turns it off; a number sets another size |
+| `max_tokens` | `16384` | output limit per page |
+| `pdf_long_side` | `2048` | PDF pages are rendered with this long side, in pixels |
+| `max_workers` | `4` | PDF pages sent in parallel |
+| `timeout` | `600` | seconds to wait for one page |
+| `backend` | `"auto"` | `"openai"` or `"ollama"`; auto picks Ollama for `http://localhost:11434` |
+| `figure_language` | `"Thai"` | v1.5 only: language of figure descriptions |
+
+The prompts are the ones the models were trained with (`typhoon_ocr2.PARSE_PROMPT` for V2), and decoding is greedy with thinking turned off.
+
+## Coming from `typhoon-ocr`
+
+| `typhoon-ocr` | `typhoon-ocr2` |
+|---|---|
+| `from typhoon_ocr import ocr_document` | `from typhoon_ocr2 import ocr_document` (same idea), or `TyphoonOCR` for more |
+| `ocr_document(path, page_num=1, base_url=..., model=...)` | `ocr_document(path, pages=1, base_url=..., model=...)` |
+| returns a Markdown string | `TyphoonOCR.parse()` also returns layout elements with boxes |
+| one page per call | `pages="1-3,5"` or all pages, sent in parallel |
+| needs Poppler for PDFs | no system dependency |
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                                                                  # unit tests, no GPU needed
+TYPHOON_OCR2_TEST_URL=http://localhost:8000/v1 pytest -m integration    # against a running server
+```
+
+## Releasing
+
+1. On pypi.org, add a Trusted Publisher for project `typhoon-ocr2`: this GitHub repository, workflow `publish.yml`, environment `pypi`.
+2. Bump `__version__` in `src/typhoon_ocr2/__init__.py`, commit, then tag and push: `git tag v0.1.0 && git push origin v0.1.0`.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). Use of the Typhoon models is subject to the [OpenTyphoon Terms and Conditions](https://opentyphoon.ai/tac).