DaVinciCode commited on
Commit
bda6419
Β·
1 Parent(s): 39de849

Add DocRes main weights, MIT license, and model card

Browse files
Files changed (3) hide show
  1. LICENSE.txt +21 -0
  2. README.md +37 -0
  3. docres.pkl +3 -0
LICENSE.txt ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Jiaxin Zhang
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
README.md ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # DocRes Main Weights (docres.pkl)
2
+
3
+ These are the official **DocRes** (CVPR 2024) main weights (`docres.pkl`), rehosted for use in the [Doctra](https://github.com/your-username/doctra) library.
4
+
5
+ ---
6
+
7
+ ## πŸ“– Source
8
+ - Original repository: [ZZZHANG-jx/DocRes](https://github.com/ZZZHANG-jx/DocRes)
9
+ - Paper: *DocRes: Dynamic Task-Specific Prompt for Generalist Document Image Restoration* (CVPR 2024)
10
+
11
+ ---
12
+
13
+ ## βš–οΈ License
14
+ MIT License (see LICENSE file).
15
+ Weights are redistributed under the same terms, with attribution to the original authors.
16
+
17
+ ---
18
+
19
+ ## βœ… Intended Use
20
+ The `docres.pkl` weights are used with the DocRes model backbone to perform generalist document image restoration tasks, including:
21
+
22
+ - πŸ“ Dewarping
23
+ - πŸŒ— Deshadowing
24
+ - ✨ Appearance enhancement (illumination cleanup)
25
+ - πŸ”„ Deblurring
26
+ - ⚫ Binarization
27
+
28
+ These weights are integrated into the **Doctra** library to improve preprocessing and restoration of scanned or photographed documents.
29
+
30
+ ---
31
+
32
+ ## ⚠️ Limitations
33
+ - Performance may not always exceed highly specialized single-task models.
34
+ - Trained on specific datasets (see [source repo](https://github.com/ZZZHANG-jx/DocRes) for details).
35
+ - Not intended for non-document natural images.
36
+
37
+ ---
docres.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:1d6a89d754fe1e58ffd1865eab0ef3f03344798d39197b2d9a77ce4fbc8c02fd
3
+ size 183260711