diff --git a/README.md b/README.md
index 07b534e..82d9a88 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
-
+
@@ -16,6 +16,7 @@
### Introduction
+
`rapid_latex_ocr` is a tool to convert formula images to latex format.
**The reasoning code in the repo is modified from [LaTeX-OCR](https://github.com/lukas-blecher/LaTeX-OCR), the model has all been converted to ONNX format, and the reasoning code has been simplified, Inference is faster and easier to deploy.**
@@ -33,6 +34,7 @@ If it helps you, please give a little star ⭐ or sponsor a cup of coffee (click
### Framework
+
```mermaid
flowchart LR
@@ -45,6 +47,7 @@ click D "https://github.com/RapidAI/RapidLaTeXOCR" _blank
```
### Installation
+>
> [!NOTE]
> When installing the package through pip, the model file will be automatically downloaded and placed under models in the installation directory.
>
@@ -55,7 +58,9 @@ pip install rapid_latex_ocr
```
### Usage
+
#### Used by python script
+
```python
from rapid_latex_ocr import LatexOCR
@@ -70,7 +75,9 @@ res, elapse = model(data)
print(res)
print(elapse)
```
+
#### Used by command line
+
```bash
$ rapid_latex_ocr tests/test_files/6.png
@@ -78,27 +85,32 @@ $ rapid_latex_ocr tests/test_files/6.png
# 0.47902780000000034
```
-### Changlog
+### Changlog ([more](https://github.com/RapidAI/RapidLaTeXOCR/releases))
Click to expand
-#### 2023-12-10 v0.0.6 update:
+#### 2023-12-10 v0.0.6 update
+
- Fixed issue [#12](https://github.com/RapidAI/RapidLaTeXOCR/issues/12)
-#### 2023-12-07 v0.0.5 update:
+#### 2023-12-07 v0.0.5 update
+
- Add the relevant code to automatically download the model when installing the package
-#### 2023-09-13 v0.0.4 update:
+#### 2023-09-13 v0.0.4 update
+
- Merge [pr #5](https://github.com/RapidAI/RapidLatexOCR/pull/5)
- Optim code
-#### 2023-07-15 v0.0.1 update:
+#### 2023-07-15 v0.0.1 update
+
- First release
@@ -106,6 +118,7 @@ $ rapid_latex_ocr tests/test_files/6.png
### Contributing + Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate. @@ -119,4 +132,5 @@ If you want to sponsor the project, you can directly click the **Buy me a coffee ### License + This project is released under the [MIT license](./LICENSE). diff --git a/requirements.txt b/requirements.txt index d0d650a..3603f93 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ onnxruntime tokenizers>=0.13.2 -numpy +numpy<2.0.0 opencv-python Pillow>=9.2.0 PyYAML \ No newline at end of file diff --git a/setup.py b/setup.py index 2d3d57a..f78976d 100644 --- a/setup.py +++ b/setup.py @@ -67,8 +67,9 @@ def get_readme() -> str: "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", ], - python_requires=">=3.6,<3.12", + python_requires=">=3.6,<3.13", entry_points={ "console_scripts": [f"{MODULE_NAME}={MODULE_NAME}.main:main"], },