DaVinciCode commited on
Commit
915b8af
·
1 Parent(s): 4f16972

Add DocRes MBD weights, MIT license, and model card

Browse files
Files changed (3) hide show
  1. LICENSE.txt +21 -0
  2. README.md +50 -0
  3. mbd.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,50 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ library_name: pytorch
4
+ pipeline_tag: image-segmentation
5
+ tags:
6
+ - document-image-restoration
7
+ - mask-background-detection
8
+ - preprocessing
9
+ - dtsprompt
10
+ - doctra
11
+ model-index:
12
+ - name: DocRes MBD (mbd.pkl)
13
+ results: []
14
+ ---
15
+
16
+ # DocRes MBD Weights (mbd.pkl)
17
+
18
+ These are the **MBD weights** (`mbd.pkl`) used by the **DocRes** model (CVPR 2024), rehosted for use in the [Doctra](https://github.com/your-username/doctra) library.
19
+
20
+ ---
21
+
22
+ ## 📖 Source
23
+ - Original repository: [ZZZHANG-jx/DocRes](https://github.com/ZZZHANG-jx/DocRes)
24
+ - Paper: *DocRes: Dynamic Task-Specific Prompt for Generalist Document Image Restoration* (CVPR 2024)
25
+
26
+ ---
27
+
28
+ ## ⚖️ License
29
+ MIT License (see LICENSE file).
30
+ Weights are redistributed under the same terms, with attribution to the original authors.
31
+
32
+ ---
33
+
34
+ ## ✅ Intended Use
35
+ The `mbd.pkl` weights are used for **Mask and Background Detection (MBD)**, a critical component of DocRes for:
36
+
37
+ - Generating document masks
38
+ - Producing background priors
39
+ - Supporting the Dynamic Task-Specific Prompt (DTSPrompt) mechanism
40
+
41
+ These weights are required to prepare task-specific prompts for the main `docres.pkl` model.
42
+
43
+ ---
44
+
45
+ ## ⚠️ Limitations
46
+ - Designed specifically for document mask/background detection.
47
+ - Performance depends on the quality of scanned/photographed inputs.
48
+ - Should be used in combination with the main DocRes weights (`docres.pkl`) for full restoration capability.
49
+
50
+ ---
mbd.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:7c2dc15a6b0e613adf7c3a794891f44caef544b92c5898ac610ae689e9cd9085
3
+ size 712981585