Documentation updates #209
Conversation
kba
left a comment
kba
left a comment
There was a problem hiding this comment.
LGTM, much improved docs, many thanks.
But can we keep the PEP8 changes out of it for now? They will be cleaned up later but there's now multiple branches changing code in utils and if we can minimize the number of conflicts, we should ;)
| @@ -1,7 +1,8 @@ | |||
| # Eynollah | |||
|
|
|||
| > Document Layout Analysis, Binarization and OCR with Deep Learning and Heuristics | |||
There was a problem hiding this comment.
| > Document Layout Analysis, Binarization and OCR with Deep Learning and Heuristics | |
| > Document Layout Analysis, OCR, Binarization, Reading Order Detection and Image Enhancement with Deep Learning and Heuristics |
If we could have a terse consistent, complete description, we should reuse that everywhere, like in the CLI.
There was a problem hiding this comment.
I am hesitant to list all the (sometimes confusing) features here already - sth simple and concise like "Historical Document Layout Analysis and Recognition" would be better for the first line of README imho...
| See the flowchart below for the different stages and how they interact: | ||
|
|
||
|  | ||
| <img width="810" height="691" alt="eynollah_flowchart" src="https://github.com/user-attachments/assets/42dd55bc-7b85-4b46-9afe-15ff712607f0" /> |
There was a problem hiding this comment.
We should add the image and diagram source to the docs folder as well - @vahidrezanezhad can you share those with me, I'll add them.
| "Programming Language :: Python :: 3.8", | ||
| "Programming Language :: Python :: 3.9", | ||
| "Programming Language :: Python :: 3.10", | ||
| "Programming Language :: Python :: 3.11", |
There was a problem hiding this comment.
We could automate that with https://pyproject-fmt.readthedocs.io/en/latest/#calculating-max-supported-python-version. Though I think trove classifiers for Python version has been deprecated in favor of requires-python pyproject.toml field. In any case, we should also adopt requires-python.
| #print(x_end,'x_end') | ||
| if len(new_main_sep_y)>0: | ||
|
|
||
| min_ys=np.min(y_sep) |
There was a problem hiding this comment.
I have no qualms with autopep8-ing the code, but to make our life easier when we merge #206 and the upcoming refactorings, can we skip the PEP8 changes for now pls?
Sure, I can revert those later. |
…/eynollah into docs_and_minor_fixes
cneud
changed the title
No description provided.