Skip to content

docs: Update warnings and links in docs #659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Update warnings and links in docs #659

wants to merge 1 commit into from

Conversation

@mkopcins
Copy link
Collaborator

@mkopcins mkopcins commented Oct 23, 2025

Description

  • In hooks replaced the links to specific models with links to the corresponding collections on Hugging Face (related to issue Model constants grouped by type #612)
  • Included image segmentation results in the aggregate benchmarks
  • Standardized usage of warnings (instead of warnings and cautions) in both next and 0.5 versions

Introduces a breaking change?

  • Yes
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Documentation update (improves or adds clarity to existing documentation)
  • Other (chores, tests, code style improvements etc.)

Related issues

#612

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

msluszniak
msluszniak requested changes Oct 23, 2025
View reviewed changes
docs/docs/04-benchmarks/inference-time.md
Comment on lines -32 to -43
| Model | iPhone 16 Pro (XNNPACK) [ms] | iPhone 14 Pro Max (XNNPACK) [ms] | iPhone SE 3 (XNNPACK) [ms] | Samsung Galaxy S24 (XNNPACK) [ms] | Samsung Galaxy S21 (XNNPACK) [ms] |
| --------------------- | :--------------------------: | :------------------------------: | :------------------------: | :-------------------------------: | :-------------------------------: |
| Detector (CRAFT_800) | 2099 | 2227 | ❌ | 2245 | 7108 |
| Recognizer (CRNN_512) | 70 | 252 | ❌ | 54 | 151 |
| Recognizer (CRNN_256) | 39 | 123 | ❌ | 24 | 78 |
| Recognizer (CRNN_128) | 17 | 83 | ❌ | 14 | 39 |
| Model | iPhone 16 Pro (XNNPACK) [ms] | iPhone 14 Pro Max (XNNPACK) [ms] | iPhone SE 3 (XNNPACK) | Samsung Galaxy S24 (XNNPACK) [ms] | Samsung Galaxy S21 (XNNPACK) [ms] |
| --------------------- | :--------------------------: | :------------------------------: | :-------------------: | :-------------------------------: | :-------------------------------: |
| Detector (CRAFT_800) | 2099 | 2227 | ❌ | 2245 | 7108 |
| Recognizer (CRNN_512) | 70 | 252 | ❌ | 54 | 151 |
| Recognizer (CRNN_256) | 39 | 123 | ❌ | 24 | 78 |
| Recognizer (CRNN_128) | 17 | 83 | ❌ | 14 | 39 |

❌ - Insufficient RAM.

## Vertical OCR

| Model | iPhone 16 Pro (XNNPACK) [ms] | iPhone 14 Pro Max (XNNPACK) [ms] | iPhone SE 3 (XNNPACK) [ms] | Samsung Galaxy S24 (XNNPACK) [ms] | Samsung Galaxy S21 (XNNPACK) [ms] |
Copy link
Member

@msluszniak msluszniak Oct 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bring back removed [ms], also needs fix in versioned docs as well

@msluszniak msluszniak added documentation Improvements or additions to documentation improvement PRs or issues focused on improvements in the current codebase labels Oct 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@msluszniak msluszniak msluszniak requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation improvement PRs or issues focused on improvements in the current codebase

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mkopcins @msluszniak @a-szymanska