Skip to content
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.

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

Add examples #19

Open
Saransh-cpp opened this issue Jul 25, 2022 · 2 comments
Open

Add examples #19

Saransh-cpp opened this issue Jul 25, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Saransh-cpp
Copy link
Owner

No description provided.

@Saransh-cpp Saransh-cpp added the documentation Improvements or additions to documentation label Jul 25, 2022
@priyanshi-git
Copy link

Hey ! Can you provide a little description of what needs to be done ? I would like to take this up :)

@Saransh-cpp
Copy link
Owner Author

Hi! Thanks for taking this up! This issue requires converting the examples here - https://ocred.readthedocs.io/en/latest/#usage-example - into jupyter notebooks, which can be placed in a new examples/ directory.

Ideally, there should be 2 notebooks, one displaying the Preprocessor class (the last example) and another showing the OCR class. Both of them should have some textual material and should display the results there itself. You can use the images available in the images/ directory for these examples!

Further work on this would include adding tests for these notebooks and rendering them in the documentation (https://ocred.readthedocs.io/en/latest) on a new page. But these can be considered as separate issues. No need to work on them at the moment! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants