hatchfinder 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 GreenMap-chan
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,215 @@
1
+ Metadata-Version: 2.4
2
+ Name: hatchfinder
3
+ Version: 0.1.0
4
+ Summary: Conditional heatmap model for finding hatch patterns in drawings
5
+ Author: GreenMap-chan
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/GreenMap-chan/hatch-finder
8
+ Project-URL: Repository, https://github.com/GreenMap-chan/hatch-finder
9
+ Project-URL: Issues, https://github.com/GreenMap-chan/hatch-finder/issues
10
+ Keywords: computer-vision,heatmap,hatching,pytorch
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
18
+ Requires-Python: >=3.11
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: Pillow>=10
22
+ Requires-Dist: PyYAML>=6
23
+ Requires-Dist: pydantic>=2
24
+ Requires-Dist: torch>=2
25
+ Requires-Dist: torchvision>=0.15
26
+ Requires-Dist: tqdm>=4
27
+ Dynamic: license-file
28
+
29
+ # hatch-finder
30
+
31
+ `hatchfinder` is an experimental PyTorch library for locating a supplied hatch
32
+ pattern inside a masked region of a drawing. The model produces a probability
33
+ heatmap with the same spatial dimensions as the drawing.
34
+
35
+ The project is currently in alpha. Its API, model format, and configuration may
36
+ change between releases.
37
+
38
+ ## Installation
39
+
40
+ Install the package from PyPI:
41
+
42
+ ```console
43
+ pip install hatchfinder
44
+ ```
45
+
46
+ To work with the example dataset and configuration files, clone the repository
47
+ and install it in editable mode:
48
+
49
+ ```console
50
+ git clone https://github.com/GreenMap-chan/hatch-finder.git
51
+ cd hatch-finder
52
+ pip install -e .
53
+ ```
54
+
55
+ Python 3.11 or newer is required. PyTorch selects CPU or CUDA automatically
56
+ when `runtime.device` is set to `auto`.
57
+
58
+ ## Tested environment
59
+
60
+ The project has been tested with the following versions:
61
+
62
+ - Python 3.11.0
63
+ - Pillow 12.3.0
64
+ - PyYAML 6.0.3
65
+ - Pydantic 2.13.4
66
+ - PyTorch 2.12.0.dev20260408+cu128
67
+ - Torchvision 0.27.0.dev20260407+cu128
68
+ - tqdm 4.70.0
69
+
70
+ The tested PyTorch and Torchvision packages are nightly builds for CUDA 12.8.
71
+ Other PyTorch and Torchvision versions allowed by the package metadata have not
72
+ yet been verified.
73
+
74
+ ## Inference
75
+
76
+ Create a model from a saved `.pt` file and pass paths or Pillow images to
77
+ `infer`:
78
+
79
+ ```python
80
+ from pathlib import Path
81
+
82
+ from hatchfinder import HatchFinder
83
+
84
+ model = HatchFinder(
85
+ load_model_path=Path("model.pt"),
86
+ device="auto",
87
+ )
88
+
89
+ heatmap = model.infer(
90
+ drawing=Path("drawing.png"),
91
+ mask=Path("search_mask.png"),
92
+ hatch=Path("hatch.png"),
93
+ debug_path=Path("debug"),
94
+ confidence=0.5,
95
+ )
96
+
97
+ print(heatmap.shape) # [1, 1, height, width]
98
+ ```
99
+
100
+ `drawing` and `hatch` are converted to RGB. `mask` is converted to grayscale
101
+ and binarized at `0.5`. The returned tensor contains probabilities in the
102
+ masked area and zeros outside it. When `debug_path` is provided, an overlay is
103
+ saved as `<drawing_name>_debug.png`.
104
+
105
+ ## Training
106
+
107
+ Load a YAML configuration and start training:
108
+
109
+ ```python
110
+ from pathlib import Path
111
+
112
+ from hatchfinder import Train, load_config
113
+
114
+ config = load_config(Path("examples/full_config.yaml"))
115
+ Train(config).train()
116
+ ```
117
+
118
+ Relative paths in a configuration file are resolved relative to that YAML
119
+ file, not to the current working directory. Training writes the resolved
120
+ configuration, a log, `best.pt`, and `last.pt` to the configured output
121
+ directory.
122
+
123
+ Using `batch_size: 1` is strongly recommended when hatch images in the dataset
124
+ have different dimensions. Batches containing multiple examples pad smaller
125
+ hatch images to the largest height and width in the batch. The padding uses a
126
+ white background and may affect the hatch encoder. To retain a larger effective
127
+ batch without padding multiple hatch images together, keep `batch_size: 1` and
128
+ raise `gradient_accumulation_steps` instead. This is not a concern when all
129
+ hatch images in the dataset have the same dimensions, in which case a larger
130
+ batch size can be used.
131
+
132
+ `best.pt` and `last.pt` are resumable training checkpoints. To create a smaller
133
+ model-only file for inference:
134
+
135
+ ```python
136
+ from pathlib import Path
137
+
138
+ from hatchfinder import convert_checkpoint_to_model
139
+
140
+ convert_checkpoint_to_model(
141
+ Path("runs/full_sample/best.pt"),
142
+ Path("runs/full_sample/model.pt"),
143
+ )
144
+ ```
145
+
146
+ ## Dataset structure
147
+
148
+ A dataset must contain separate `train` and `valid` splits. Each split has a
149
+ JSON Lines manifest and four image directories:
150
+
151
+ ```text
152
+ dataset/
153
+ ├── train/
154
+ │ ├── manifest.jsonl
155
+ │ ├── drawing/
156
+ │ ├── search_mask/
157
+ │ ├── hatch/
158
+ │ └── target/
159
+ └── valid/
160
+ ├── manifest.jsonl
161
+ ├── drawing/
162
+ ├── search_mask/
163
+ ├── hatch/
164
+ └── target/
165
+ ```
166
+
167
+ Each line in `manifest.jsonl` describes one example. Paths are relative to the
168
+ dataset root:
169
+
170
+ ```json
171
+ {"drawing":"train/drawing/0001.png","search_mask":"train/search_mask/0001.png","hatch":"train/hatch/0001.png","target":"train/target/0001.png"}
172
+ ```
173
+
174
+ - `drawing` is an RGB drawing.
175
+ - `search_mask` is a grayscale mask of the area in which to search.
176
+ - `hatch` is an RGB image of the hatch pattern to find.
177
+ - `target` is a grayscale ground-truth mask. White pixels mark matches; an
178
+ all-black target represents a negative example.
179
+
180
+ Images belonging to one example may have arbitrary filenames, but `drawing`,
181
+ `search_mask`, and `target` must have the same spatial dimensions. The hatch
182
+ image may have a different size.
183
+
184
+ ## Sample dataset
185
+
186
+ [`examples/sample_dataset`](https://github.com/GreenMap-chan/hatch-finder/tree/main/examples/sample_dataset)
187
+ contains 20 training and 10 validation examples. It is intentionally small and
188
+ is only suitable for checking the data pipeline and training loop, not for
189
+ training an accurate model. Each split contains an equal number of positive and
190
+ negative examples. The sample dataset is stored in the GitHub repository and is
191
+ not installed by `pip`.
192
+
193
+ The minimal CPU configuration in
194
+ [`examples/smoke_test.yaml`](https://github.com/GreenMap-chan/hatch-finder/blob/main/examples/smoke_test.yaml)
195
+ uses a reduced model and runs one epoch on this sample dataset. From the
196
+ repository root:
197
+
198
+ ```python
199
+ from pathlib import Path
200
+
201
+ from hatchfinder import Train, load_config
202
+
203
+ config = load_config(Path("examples/smoke_test.yaml"))
204
+ Train(config).train()
205
+ ```
206
+
207
+ Training output is written to `runs/sample`.
208
+
209
+ The full example configuration is available at
210
+ [`examples/full_config.yaml`](https://github.com/GreenMap-chan/hatch-finder/blob/main/examples/full_config.yaml).
211
+
212
+ ## License
213
+
214
+ Licensed under the Apache License 2.0. See
215
+ [`LICENSE`](https://github.com/GreenMap-chan/hatch-finder/blob/main/LICENSE).
@@ -0,0 +1,187 @@
1
+ # hatch-finder
2
+
3
+ `hatchfinder` is an experimental PyTorch library for locating a supplied hatch
4
+ pattern inside a masked region of a drawing. The model produces a probability
5
+ heatmap with the same spatial dimensions as the drawing.
6
+
7
+ The project is currently in alpha. Its API, model format, and configuration may
8
+ change between releases.
9
+
10
+ ## Installation
11
+
12
+ Install the package from PyPI:
13
+
14
+ ```console
15
+ pip install hatchfinder
16
+ ```
17
+
18
+ To work with the example dataset and configuration files, clone the repository
19
+ and install it in editable mode:
20
+
21
+ ```console
22
+ git clone https://github.com/GreenMap-chan/hatch-finder.git
23
+ cd hatch-finder
24
+ pip install -e .
25
+ ```
26
+
27
+ Python 3.11 or newer is required. PyTorch selects CPU or CUDA automatically
28
+ when `runtime.device` is set to `auto`.
29
+
30
+ ## Tested environment
31
+
32
+ The project has been tested with the following versions:
33
+
34
+ - Python 3.11.0
35
+ - Pillow 12.3.0
36
+ - PyYAML 6.0.3
37
+ - Pydantic 2.13.4
38
+ - PyTorch 2.12.0.dev20260408+cu128
39
+ - Torchvision 0.27.0.dev20260407+cu128
40
+ - tqdm 4.70.0
41
+
42
+ The tested PyTorch and Torchvision packages are nightly builds for CUDA 12.8.
43
+ Other PyTorch and Torchvision versions allowed by the package metadata have not
44
+ yet been verified.
45
+
46
+ ## Inference
47
+
48
+ Create a model from a saved `.pt` file and pass paths or Pillow images to
49
+ `infer`:
50
+
51
+ ```python
52
+ from pathlib import Path
53
+
54
+ from hatchfinder import HatchFinder
55
+
56
+ model = HatchFinder(
57
+ load_model_path=Path("model.pt"),
58
+ device="auto",
59
+ )
60
+
61
+ heatmap = model.infer(
62
+ drawing=Path("drawing.png"),
63
+ mask=Path("search_mask.png"),
64
+ hatch=Path("hatch.png"),
65
+ debug_path=Path("debug"),
66
+ confidence=0.5,
67
+ )
68
+
69
+ print(heatmap.shape) # [1, 1, height, width]
70
+ ```
71
+
72
+ `drawing` and `hatch` are converted to RGB. `mask` is converted to grayscale
73
+ and binarized at `0.5`. The returned tensor contains probabilities in the
74
+ masked area and zeros outside it. When `debug_path` is provided, an overlay is
75
+ saved as `<drawing_name>_debug.png`.
76
+
77
+ ## Training
78
+
79
+ Load a YAML configuration and start training:
80
+
81
+ ```python
82
+ from pathlib import Path
83
+
84
+ from hatchfinder import Train, load_config
85
+
86
+ config = load_config(Path("examples/full_config.yaml"))
87
+ Train(config).train()
88
+ ```
89
+
90
+ Relative paths in a configuration file are resolved relative to that YAML
91
+ file, not to the current working directory. Training writes the resolved
92
+ configuration, a log, `best.pt`, and `last.pt` to the configured output
93
+ directory.
94
+
95
+ Using `batch_size: 1` is strongly recommended when hatch images in the dataset
96
+ have different dimensions. Batches containing multiple examples pad smaller
97
+ hatch images to the largest height and width in the batch. The padding uses a
98
+ white background and may affect the hatch encoder. To retain a larger effective
99
+ batch without padding multiple hatch images together, keep `batch_size: 1` and
100
+ raise `gradient_accumulation_steps` instead. This is not a concern when all
101
+ hatch images in the dataset have the same dimensions, in which case a larger
102
+ batch size can be used.
103
+
104
+ `best.pt` and `last.pt` are resumable training checkpoints. To create a smaller
105
+ model-only file for inference:
106
+
107
+ ```python
108
+ from pathlib import Path
109
+
110
+ from hatchfinder import convert_checkpoint_to_model
111
+
112
+ convert_checkpoint_to_model(
113
+ Path("runs/full_sample/best.pt"),
114
+ Path("runs/full_sample/model.pt"),
115
+ )
116
+ ```
117
+
118
+ ## Dataset structure
119
+
120
+ A dataset must contain separate `train` and `valid` splits. Each split has a
121
+ JSON Lines manifest and four image directories:
122
+
123
+ ```text
124
+ dataset/
125
+ ├── train/
126
+ │ ├── manifest.jsonl
127
+ │ ├── drawing/
128
+ │ ├── search_mask/
129
+ │ ├── hatch/
130
+ │ └── target/
131
+ └── valid/
132
+ ├── manifest.jsonl
133
+ ├── drawing/
134
+ ├── search_mask/
135
+ ├── hatch/
136
+ └── target/
137
+ ```
138
+
139
+ Each line in `manifest.jsonl` describes one example. Paths are relative to the
140
+ dataset root:
141
+
142
+ ```json
143
+ {"drawing":"train/drawing/0001.png","search_mask":"train/search_mask/0001.png","hatch":"train/hatch/0001.png","target":"train/target/0001.png"}
144
+ ```
145
+
146
+ - `drawing` is an RGB drawing.
147
+ - `search_mask` is a grayscale mask of the area in which to search.
148
+ - `hatch` is an RGB image of the hatch pattern to find.
149
+ - `target` is a grayscale ground-truth mask. White pixels mark matches; an
150
+ all-black target represents a negative example.
151
+
152
+ Images belonging to one example may have arbitrary filenames, but `drawing`,
153
+ `search_mask`, and `target` must have the same spatial dimensions. The hatch
154
+ image may have a different size.
155
+
156
+ ## Sample dataset
157
+
158
+ [`examples/sample_dataset`](https://github.com/GreenMap-chan/hatch-finder/tree/main/examples/sample_dataset)
159
+ contains 20 training and 10 validation examples. It is intentionally small and
160
+ is only suitable for checking the data pipeline and training loop, not for
161
+ training an accurate model. Each split contains an equal number of positive and
162
+ negative examples. The sample dataset is stored in the GitHub repository and is
163
+ not installed by `pip`.
164
+
165
+ The minimal CPU configuration in
166
+ [`examples/smoke_test.yaml`](https://github.com/GreenMap-chan/hatch-finder/blob/main/examples/smoke_test.yaml)
167
+ uses a reduced model and runs one epoch on this sample dataset. From the
168
+ repository root:
169
+
170
+ ```python
171
+ from pathlib import Path
172
+
173
+ from hatchfinder import Train, load_config
174
+
175
+ config = load_config(Path("examples/smoke_test.yaml"))
176
+ Train(config).train()
177
+ ```
178
+
179
+ Training output is written to `runs/sample`.
180
+
181
+ The full example configuration is available at
182
+ [`examples/full_config.yaml`](https://github.com/GreenMap-chan/hatch-finder/blob/main/examples/full_config.yaml).
183
+
184
+ ## License
185
+
186
+ Licensed under the Apache License 2.0. See
187
+ [`LICENSE`](https://github.com/GreenMap-chan/hatch-finder/blob/main/LICENSE).
@@ -0,0 +1,49 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "hatchfinder"
7
+ version = "0.1.0"
8
+ description = "Conditional heatmap model for finding hatch patterns in drawings"
9
+ readme = "README.md"
10
+ requires-python = ">=3.11"
11
+ license = "Apache-2.0"
12
+ license-files = ["LICENSE"]
13
+ authors = [
14
+ { name = "GreenMap-chan" },
15
+ ]
16
+ keywords = [
17
+ "computer-vision",
18
+ "heatmap",
19
+ "hatching",
20
+ "pytorch",
21
+ ]
22
+ classifiers = [
23
+ "Development Status :: 3 - Alpha",
24
+ "Intended Audience :: Developers",
25
+ "Intended Audience :: Science/Research",
26
+ "Programming Language :: Python :: 3",
27
+ "Programming Language :: Python :: 3.11",
28
+ "Operating System :: OS Independent",
29
+ "Topic :: Scientific/Engineering :: Artificial Intelligence",
30
+ ]
31
+ dependencies = [
32
+ "Pillow>=10",
33
+ "PyYAML>=6",
34
+ "pydantic>=2",
35
+ "torch>=2",
36
+ "torchvision>=0.15",
37
+ "tqdm>=4",
38
+ ]
39
+
40
+ [project.urls]
41
+ Homepage = "https://github.com/GreenMap-chan/hatch-finder"
42
+ Repository = "https://github.com/GreenMap-chan/hatch-finder"
43
+ Issues = "https://github.com/GreenMap-chan/hatch-finder/issues"
44
+
45
+ [tool.setuptools]
46
+ package-dir = {"" = "src"}
47
+
48
+ [tool.setuptools.packages.find]
49
+ where = ["src"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,37 @@
1
+ from importlib.metadata import PackageNotFoundError, version
2
+
3
+ from .config import (
4
+ AugmentationSettings,
5
+ Config,
6
+ DataSettings,
7
+ ModelSettings,
8
+ OutputSettings,
9
+ RuntimeSettings,
10
+ TrainingSettings,
11
+ load_config,
12
+ save_config,
13
+ )
14
+ from .hatch_finder import HatchFinder
15
+ from .train import Train
16
+ from .checkpoint import convert_checkpoint_to_model
17
+
18
+
19
+ __all__ = [
20
+ "AugmentationSettings",
21
+ "Config",
22
+ "DataSettings",
23
+ "HatchFinder",
24
+ "ModelSettings",
25
+ "OutputSettings",
26
+ "RuntimeSettings",
27
+ "Train",
28
+ "TrainingSettings",
29
+ "load_config",
30
+ "save_config",
31
+ "convert_checkpoint_to_model",
32
+ ]
33
+
34
+ try:
35
+ __version__ = version("hatchfinder")
36
+ except PackageNotFoundError:
37
+ __version__ = "0.0.0+unknown"