Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
D
DAN
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Package Registry
Container Registry
Operate
Terraform modules
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Automatic Text Recognition
DAN
Commits
2adb6ba8
Commit
2adb6ba8
authored
1 year ago
by
Yoann Schneider
Committed by
Mélodie Boillet
1 year ago
Browse files
Options
Downloads
Patches
Plain Diff
Update doc to mentions development setup
parent
378a86c0
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!147
Update doc to mentions development setup
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+32
-4
32 additions, 4 deletions
README.md
with
32 additions
and
4 deletions
README.md
+
32
−
4
View file @
2adb6ba8
...
...
@@ -2,16 +2,44 @@
## Documentation
For more details about this package, make sure to see the documentation available at https://teklia.gitlab.io/atr/dan/.
## Installation
To use DAN in your own scripts, install it using pip:
```
console
pip install -e .
```
For more details about this package, make sure to see the documentation available at https://teklia.gitlab.io/atr/dan/.
## Development
For development and tests purpose it may be useful to install the project as a editable package with pip.
*
Use a virtualenv (e.g. with virtualenvwrapper
`mkvirtualenv -a . dan`
)
*
Install
`dan`
as a package (e.g.
`pip install -e .`
)
### Linter
Code syntax is analyzed before submitting the code.
\
To run the linter tools suite you may use pre-commit.
```
shell
pip
install
pre-commit
pre-commit run
-a
```
### Run tests
Tests are executed with
`tox`
using
[
pytest
](
https://pytest.org
)
.
To install
`tox`
,
```
shell
pip
install
tox
tox
```
To reload the test virtual environment you can use
`tox -r`
Run a single test module:
`tox -- <test_path>`
Run a single test:
`tox -- <test_path>::<test_function>`
The tests use a large file stored via
[
Git-LFS
](
https://docs.gitlab.com/ee/topics/git/lfs/
)
. Make sure to run
`git-lfs pull`
before running them.
## Inference
To apply DAN to an image, one needs to first add a few imports and to load an image. Note that the image should be in RGB.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment