biomedparse-mlx 0.1.1__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.
- biomedparse_mlx-0.1.1/.gitignore +14 -0
- biomedparse_mlx-0.1.1/LICENSE +201 -0
- biomedparse_mlx-0.1.1/PKG-INFO +131 -0
- biomedparse_mlx-0.1.1/README.md +94 -0
- biomedparse_mlx-0.1.1/THIRD_PARTY_NOTICES.md +144 -0
- biomedparse_mlx-0.1.1/pyproject.toml +87 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/__init__.py +3 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/_dicom.py +23 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/_nifti.py +45 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/_skimage.py +27 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/backbone.py +126 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/cli.py +86 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/data/__init__.py +1 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/data/model.json +30 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/decoder.py +190 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/dependency_types.py +11 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/image2d.py +180 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/layers.py +140 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/medmlx.py +261 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/mlx_types.py +39 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/model.py +120 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/ontology.py +385 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/pipeline.py +219 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/pixel_decoder.py +88 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/preprocessing.py +112 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/resize.py +94 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/text.py +145 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/volume.py +164 -0
- biomedparse_mlx-0.1.1/src/biomedparse_mlx/weights.py +114 -0
|
@@ -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 [yyyy] [name of copyright owner]
|
|
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,131 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: biomedparse-mlx
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Native MLX inference for BioMedParse v2 on Apple Silicon
|
|
5
|
+
Author: Joseph Sandoval, Alfredo Sandoval Jr.
|
|
6
|
+
License-Expression: Apache-2.0 AND MIT AND BSD-3-Clause
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
License-File: THIRD_PARTY_NOTICES.md
|
|
9
|
+
Classifier: Operating System :: MacOS :: MacOS X
|
|
10
|
+
Requires-Python: <3.15,>=3.13
|
|
11
|
+
Requires-Dist: medmlx-core==0.2.3
|
|
12
|
+
Requires-Dist: nibabel<6,>=5.3
|
|
13
|
+
Requires-Dist: numpy<3,>=2
|
|
14
|
+
Requires-Dist: pillow<14,>=13
|
|
15
|
+
Requires-Dist: pydicom<4,>=3
|
|
16
|
+
Requires-Dist: scikit-image<1,>=0.25
|
|
17
|
+
Requires-Dist: tokenizers<0.23,>=0.22
|
|
18
|
+
Provides-Extra: assets
|
|
19
|
+
Requires-Dist: huggingface-hub<2,>=1; extra == 'assets'
|
|
20
|
+
Provides-Extra: conversion
|
|
21
|
+
Requires-Dist: safetensors<1,>=0.6; extra == 'conversion'
|
|
22
|
+
Requires-Dist: torch<3,>=2.6; extra == 'conversion'
|
|
23
|
+
Provides-Extra: dev
|
|
24
|
+
Requires-Dist: hypothesis<7,>=6.140; extra == 'dev'
|
|
25
|
+
Requires-Dist: pyright==1.1.414; extra == 'dev'
|
|
26
|
+
Requires-Dist: pytest<10,>=8.4; extra == 'dev'
|
|
27
|
+
Requires-Dist: ruff<1,>=0.13; extra == 'dev'
|
|
28
|
+
Provides-Extra: oracle
|
|
29
|
+
Requires-Dist: fvcore>=0.1.5; extra == 'oracle'
|
|
30
|
+
Requires-Dist: hydra-core<2,>=1.3; extra == 'oracle'
|
|
31
|
+
Requires-Dist: safetensors<1,>=0.6; extra == 'oracle'
|
|
32
|
+
Requires-Dist: simpleitk<3,>=2.4; extra == 'oracle'
|
|
33
|
+
Requires-Dist: timm<2,>=1; extra == 'oracle'
|
|
34
|
+
Requires-Dist: torch<3,>=2.6; extra == 'oracle'
|
|
35
|
+
Requires-Dist: transformers<6,>=5; extra == 'oracle'
|
|
36
|
+
Description-Content-Type: text/markdown
|
|
37
|
+
|
|
38
|
+
# biomedparse-mlx
|
|
39
|
+
|
|
40
|
+
Native MLX port of [Microsoft BioMedParse v2](https://github.com/microsoft/BiomedParse/tree/v2)
|
|
41
|
+
for Apple Silicon. Segment medical images from text prompts, locally on Mac.
|
|
42
|
+
|
|
43
|
+
- Text-guided 3D segmentation with multiple prompts and labels
|
|
44
|
+
- Raw NIfTI and DICOM windowing, with geometry-preserving NIfTI mask output
|
|
45
|
+
- Float32 model execution on Metal; PyTorch is used for conversion and oracle tests
|
|
46
|
+
- A 2D image path with overlapping prompt masks; dedicated 2D weights remain unqualified
|
|
47
|
+
|
|
48
|
+
Part of [MedMLX](https://github.com/MedMLX).
|
|
49
|
+
[Technical notes](https://github.com/MedMLX/biomedparse-mlx/blob/main/docs/technical.md) · [Usage](https://github.com/MedMLX/biomedparse-mlx/blob/main/docs/usage.md)
|
|
50
|
+
|
|
51
|
+
[Quick start](#quick-start) · [Input and output](#input-and-output) · [Technical details](#technical-details) · [License](#license)
|
|
52
|
+
|
|
53
|
+
## Requirements
|
|
54
|
+
|
|
55
|
+
Apple Silicon Mac with Metal, Python 3.13 or 3.14 and [uv](https://docs.astral.sh/uv/).
|
|
56
|
+
The released checkpoint requires access to the gated Microsoft model on Hugging Face.
|
|
57
|
+
|
|
58
|
+
## Quick start
|
|
59
|
+
|
|
60
|
+
Prepare the locked checkout and local checkpoint assets:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
gh repo clone MedMLX/biomedparse-mlx
|
|
64
|
+
cd biomedparse-mlx
|
|
65
|
+
make env
|
|
66
|
+
MACOSX_DEPLOYMENT_TARGET=27.0 uv sync --locked --extra dev --extra oracle --extra conversion --extra assets
|
|
67
|
+
|
|
68
|
+
uv run --locked --no-sync hf download microsoft/BiomedParse biomedparse_v2.ckpt \
|
|
69
|
+
--revision e473e5b2b1a3f44649734afd3dc7cf1770aaa9e2 --local-dir weights/source
|
|
70
|
+
uv run --locked --no-sync hf download openai/clip-vit-base-patch32 tokenizer.json \
|
|
71
|
+
--revision 3d74acf9a28c67741b2f4f2ea7635f0aaf6f0268 --local-dir weights
|
|
72
|
+
|
|
73
|
+
uv run --locked --no-sync biomedparse-mlx convert \
|
|
74
|
+
--source weights/source/biomedparse_v2.ckpt --output weights/biomedparse-v2.npz
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
The source checkpoint is about 4.46 GB. Conversion writes a float32 tensor bundle
|
|
78
|
+
and a versioned receipt. Inference uses local assets without implicit downloads.
|
|
79
|
+
|
|
80
|
+
Segment a preprocessed volume:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
uv run --locked --no-sync biomedparse-mlx segment \
|
|
84
|
+
--image scan.npy --weights weights/biomedparse-v2.npz --tokenizer weights/tokenizer.json \
|
|
85
|
+
--prompt 'Visualization of the liver in abdominal CT imaging' --label 6 \
|
|
86
|
+
--output-dir outputs/liver --slice-batch-size 2 --seed 7
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Repeat `--prompt` and `--label` for multiple structures. Existing outputs require
|
|
90
|
+
`--overwrite`. Python usage, raw-image windowing, instance segmentation and the
|
|
91
|
+
`segment-2d` command are described in [docs/usage.md](https://github.com/MedMLX/biomedparse-mlx/blob/main/docs/usage.md).
|
|
92
|
+
The model is discoverable by [medmlx](https://github.com/MedMLX/medmlx) as `biomedparse-v2`.
|
|
93
|
+
|
|
94
|
+
## Input and output
|
|
95
|
+
|
|
96
|
+
Volumes are preprocessed numeric `.npy` arrays or `.npz` files containing `imgs`
|
|
97
|
+
in the upstream 0..255 intensity range. Raw NIfTI volumes and DICOM slices require
|
|
98
|
+
explicit `--modality` and, for CT, `--ct-site` windowing options. Volume slicing
|
|
99
|
+
follows upstream's fixed shape heuristic.
|
|
100
|
+
|
|
101
|
+
The volume path writes `segmentation.npz` with uint16 labels on the original array
|
|
102
|
+
grid, prompt-by-slice existence probabilities, and `run.json`. NIfTI inputs also
|
|
103
|
+
produce `segmentation.nii.gz` on the source affine. The 2D path returns separate,
|
|
104
|
+
potentially overlapping masks and probabilities per prompt.
|
|
105
|
+
|
|
106
|
+
## Technical details
|
|
107
|
+
|
|
108
|
+
The native graph follows the pinned BioMedParse v2 architecture and checkpoint
|
|
109
|
+
contract. Controlled oracle comparisons replay upstream attention masks; matching
|
|
110
|
+
integer seeds alone does not align Torch and MLX sampling. Recorded qualification
|
|
111
|
+
covers bounded synthetic and AMOS cases. Dedicated 2D weights, broader task
|
|
112
|
+
accuracy and clinical performance remain unqualified.
|
|
113
|
+
|
|
114
|
+
Architecture, numerical tolerances, development checks and recorded measurements
|
|
115
|
+
are in [docs/technical.md](https://github.com/MedMLX/biomedparse-mlx/blob/main/docs/technical.md).
|
|
116
|
+
|
|
117
|
+
## Intended use
|
|
118
|
+
|
|
119
|
+
Intended for research and education, not clinical diagnosis or treatment decisions.
|
|
120
|
+
Outputs require human review.
|
|
121
|
+
|
|
122
|
+
## License
|
|
123
|
+
|
|
124
|
+
Original contributions: Apache-2.0; see [LICENSE](https://github.com/MedMLX/biomedparse-mlx/blob/main/LICENSE). Upstream MIT/BSD notices and full
|
|
125
|
+
license texts are retained in [THIRD_PARTY_NOTICES.md](https://github.com/MedMLX/biomedparse-mlx/blob/main/THIRD_PARTY_NOTICES.md).
|
|
126
|
+
Model weights have separate publisher terms: Microsoft's model card declares
|
|
127
|
+
CC-BY-NC-SA-4.0. Weights, tokenizers, datasets and masks are excluded from Git.
|
|
128
|
+
|
|
129
|
+
## Implementation mapping
|
|
130
|
+
|
|
131
|
+
[Central implementation map](https://github.com/MedMLX/Med-MLX/blob/main/implementation-maps/biomedparse-mlx.json) records upstream-to-native changes, source references and qualification scope.
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# biomedparse-mlx
|
|
2
|
+
|
|
3
|
+
Native MLX port of [Microsoft BioMedParse v2](https://github.com/microsoft/BiomedParse/tree/v2)
|
|
4
|
+
for Apple Silicon. Segment medical images from text prompts, locally on Mac.
|
|
5
|
+
|
|
6
|
+
- Text-guided 3D segmentation with multiple prompts and labels
|
|
7
|
+
- Raw NIfTI and DICOM windowing, with geometry-preserving NIfTI mask output
|
|
8
|
+
- Float32 model execution on Metal; PyTorch is used for conversion and oracle tests
|
|
9
|
+
- A 2D image path with overlapping prompt masks; dedicated 2D weights remain unqualified
|
|
10
|
+
|
|
11
|
+
Part of [MedMLX](https://github.com/MedMLX).
|
|
12
|
+
[Technical notes](https://github.com/MedMLX/biomedparse-mlx/blob/main/docs/technical.md) · [Usage](https://github.com/MedMLX/biomedparse-mlx/blob/main/docs/usage.md)
|
|
13
|
+
|
|
14
|
+
[Quick start](#quick-start) · [Input and output](#input-and-output) · [Technical details](#technical-details) · [License](#license)
|
|
15
|
+
|
|
16
|
+
## Requirements
|
|
17
|
+
|
|
18
|
+
Apple Silicon Mac with Metal, Python 3.13 or 3.14 and [uv](https://docs.astral.sh/uv/).
|
|
19
|
+
The released checkpoint requires access to the gated Microsoft model on Hugging Face.
|
|
20
|
+
|
|
21
|
+
## Quick start
|
|
22
|
+
|
|
23
|
+
Prepare the locked checkout and local checkpoint assets:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
gh repo clone MedMLX/biomedparse-mlx
|
|
27
|
+
cd biomedparse-mlx
|
|
28
|
+
make env
|
|
29
|
+
MACOSX_DEPLOYMENT_TARGET=27.0 uv sync --locked --extra dev --extra oracle --extra conversion --extra assets
|
|
30
|
+
|
|
31
|
+
uv run --locked --no-sync hf download microsoft/BiomedParse biomedparse_v2.ckpt \
|
|
32
|
+
--revision e473e5b2b1a3f44649734afd3dc7cf1770aaa9e2 --local-dir weights/source
|
|
33
|
+
uv run --locked --no-sync hf download openai/clip-vit-base-patch32 tokenizer.json \
|
|
34
|
+
--revision 3d74acf9a28c67741b2f4f2ea7635f0aaf6f0268 --local-dir weights
|
|
35
|
+
|
|
36
|
+
uv run --locked --no-sync biomedparse-mlx convert \
|
|
37
|
+
--source weights/source/biomedparse_v2.ckpt --output weights/biomedparse-v2.npz
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
The source checkpoint is about 4.46 GB. Conversion writes a float32 tensor bundle
|
|
41
|
+
and a versioned receipt. Inference uses local assets without implicit downloads.
|
|
42
|
+
|
|
43
|
+
Segment a preprocessed volume:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
uv run --locked --no-sync biomedparse-mlx segment \
|
|
47
|
+
--image scan.npy --weights weights/biomedparse-v2.npz --tokenizer weights/tokenizer.json \
|
|
48
|
+
--prompt 'Visualization of the liver in abdominal CT imaging' --label 6 \
|
|
49
|
+
--output-dir outputs/liver --slice-batch-size 2 --seed 7
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Repeat `--prompt` and `--label` for multiple structures. Existing outputs require
|
|
53
|
+
`--overwrite`. Python usage, raw-image windowing, instance segmentation and the
|
|
54
|
+
`segment-2d` command are described in [docs/usage.md](https://github.com/MedMLX/biomedparse-mlx/blob/main/docs/usage.md).
|
|
55
|
+
The model is discoverable by [medmlx](https://github.com/MedMLX/medmlx) as `biomedparse-v2`.
|
|
56
|
+
|
|
57
|
+
## Input and output
|
|
58
|
+
|
|
59
|
+
Volumes are preprocessed numeric `.npy` arrays or `.npz` files containing `imgs`
|
|
60
|
+
in the upstream 0..255 intensity range. Raw NIfTI volumes and DICOM slices require
|
|
61
|
+
explicit `--modality` and, for CT, `--ct-site` windowing options. Volume slicing
|
|
62
|
+
follows upstream's fixed shape heuristic.
|
|
63
|
+
|
|
64
|
+
The volume path writes `segmentation.npz` with uint16 labels on the original array
|
|
65
|
+
grid, prompt-by-slice existence probabilities, and `run.json`. NIfTI inputs also
|
|
66
|
+
produce `segmentation.nii.gz` on the source affine. The 2D path returns separate,
|
|
67
|
+
potentially overlapping masks and probabilities per prompt.
|
|
68
|
+
|
|
69
|
+
## Technical details
|
|
70
|
+
|
|
71
|
+
The native graph follows the pinned BioMedParse v2 architecture and checkpoint
|
|
72
|
+
contract. Controlled oracle comparisons replay upstream attention masks; matching
|
|
73
|
+
integer seeds alone does not align Torch and MLX sampling. Recorded qualification
|
|
74
|
+
covers bounded synthetic and AMOS cases. Dedicated 2D weights, broader task
|
|
75
|
+
accuracy and clinical performance remain unqualified.
|
|
76
|
+
|
|
77
|
+
Architecture, numerical tolerances, development checks and recorded measurements
|
|
78
|
+
are in [docs/technical.md](https://github.com/MedMLX/biomedparse-mlx/blob/main/docs/technical.md).
|
|
79
|
+
|
|
80
|
+
## Intended use
|
|
81
|
+
|
|
82
|
+
Intended for research and education, not clinical diagnosis or treatment decisions.
|
|
83
|
+
Outputs require human review.
|
|
84
|
+
|
|
85
|
+
## License
|
|
86
|
+
|
|
87
|
+
Original contributions: Apache-2.0; see [LICENSE](https://github.com/MedMLX/biomedparse-mlx/blob/main/LICENSE). Upstream MIT/BSD notices and full
|
|
88
|
+
license texts are retained in [THIRD_PARTY_NOTICES.md](https://github.com/MedMLX/biomedparse-mlx/blob/main/THIRD_PARTY_NOTICES.md).
|
|
89
|
+
Model weights have separate publisher terms: Microsoft's model card declares
|
|
90
|
+
CC-BY-NC-SA-4.0. Weights, tokenizers, datasets and masks are excluded from Git.
|
|
91
|
+
|
|
92
|
+
## Implementation mapping
|
|
93
|
+
|
|
94
|
+
[Central implementation map](https://github.com/MedMLX/Med-MLX/blob/main/implementation-maps/biomedparse-mlx.json) records upstream-to-native changes, source references and qualification scope.
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
MedMLX-authored additions are licensed under [Apache-2.0](LICENSE).
|
|
4
|
+
The upstream attribution and license notices are retained below.
|
|
5
|
+
|
|
6
|
+
biomedparse-mlx
|
|
7
|
+
|
|
8
|
+
This package adapts the inference architecture and preprocessing of Microsoft's
|
|
9
|
+
BioMedParse v2, revision f571d5ccaa4f8c0479bb89e390a7ef0dfc0736f4,
|
|
10
|
+
https://github.com/microsoft/BiomedParse, licensed under Apache-2.0.
|
|
11
|
+
The implementation was changed to use native MLX, channel-last tensors, local
|
|
12
|
+
tokenizer assets, strict loading, and typed inference actions.
|
|
13
|
+
|
|
14
|
+
FocalNet: Copyright (c) 2022 Microsoft; written by Jianwei Yang.
|
|
15
|
+
X-Decoder language encoder: Copyright (c) 2022 Microsoft; written by Xueyan Zou.
|
|
16
|
+
These portions carry MIT notices; full terms are retained below.
|
|
17
|
+
|
|
18
|
+
Transformer/FPN, attention layers, and sine positional encoding retain upstream
|
|
19
|
+
copyright (c) Facebook, Inc. and its affiliates (Meta). The BioMedParse source
|
|
20
|
+
distributes these adaptations under its root Apache-2.0 license.
|
|
21
|
+
|
|
22
|
+
Interpolation formulas follow PyTorch's UpSample.h and UpSampleKernel.cpp;
|
|
23
|
+
PyTorch BSD terms are retained in THIRD_PARTY_NOTICES.md.
|
|
24
|
+
|
|
25
|
+
Pretrained weights are separate assets. The Microsoft Hugging Face model card
|
|
26
|
+
declares CC-BY-NC-SA-4.0; no checkpoint, tokenizer, dataset, or converted weights
|
|
27
|
+
are distributed in this repository. Cite BioMedParse, BoltzFormer, and the
|
|
28
|
+
CVPR 2025 Text-guided 3D Segmentation Challenge as requested by upstream.
|
|
29
|
+
|
|
30
|
+
Dependencies declared in [pyproject.toml](pyproject.toml) are installed separately
|
|
31
|
+
and retain their respective licenses.
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
## Full license: FocalNet-MIT.txt
|
|
35
|
+
|
|
36
|
+
MIT License
|
|
37
|
+
|
|
38
|
+
Copyright (c) Microsoft Corporation.
|
|
39
|
+
|
|
40
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
41
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
42
|
+
in the Software without restriction, including without limitation the rights
|
|
43
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
44
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
45
|
+
furnished to do so, subject to the following conditions:
|
|
46
|
+
|
|
47
|
+
The above copyright notice and this permission notice shall be included in all
|
|
48
|
+
copies or substantial portions of the Software.
|
|
49
|
+
|
|
50
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
51
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
52
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
53
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
54
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
55
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
56
|
+
SOFTWARE
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
## Full license: PyTorch-BSD.txt
|
|
60
|
+
|
|
61
|
+
From PyTorch:
|
|
62
|
+
|
|
63
|
+
Copyright (c) 2016- Facebook, Inc (Adam Paszke)
|
|
64
|
+
Copyright (c) 2014- Facebook, Inc (Soumith Chintala)
|
|
65
|
+
Copyright (c) 2011-2014 Idiap Research Institute (Ronan Collobert)
|
|
66
|
+
Copyright (c) 2012-2014 Deepmind Technologies (Koray Kavukcuoglu)
|
|
67
|
+
Copyright (c) 2011-2012 NEC Laboratories America (Koray Kavukcuoglu)
|
|
68
|
+
Copyright (c) 2011-2013 NYU (Clement Farabet)
|
|
69
|
+
Copyright (c) 2006-2010 NEC Laboratories America (Ronan Collobert, Leon Bottou, Iain Melvin, Jason Weston)
|
|
70
|
+
Copyright (c) 2006 Idiap Research Institute (Samy Bengio)
|
|
71
|
+
Copyright (c) 2001-2004 Idiap Research Institute (Ronan Collobert, Samy Bengio, Johnny Mariethoz)
|
|
72
|
+
|
|
73
|
+
From Caffe2:
|
|
74
|
+
|
|
75
|
+
Copyright (c) 2016-present, Facebook Inc. All rights reserved.
|
|
76
|
+
|
|
77
|
+
All contributions by Facebook:
|
|
78
|
+
Copyright (c) 2016 Facebook Inc.
|
|
79
|
+
|
|
80
|
+
All contributions by Google:
|
|
81
|
+
Copyright (c) 2015 Google Inc.
|
|
82
|
+
All rights reserved.
|
|
83
|
+
|
|
84
|
+
All contributions by Yangqing Jia:
|
|
85
|
+
Copyright (c) 2015 Yangqing Jia
|
|
86
|
+
All rights reserved.
|
|
87
|
+
|
|
88
|
+
All contributions by Kakao Brain:
|
|
89
|
+
Copyright 2019-2020 Kakao Brain
|
|
90
|
+
|
|
91
|
+
All contributions by Cruise LLC:
|
|
92
|
+
Copyright (c) 2022 Cruise LLC.
|
|
93
|
+
All rights reserved.
|
|
94
|
+
|
|
95
|
+
All contributions by Tri Dao:
|
|
96
|
+
Copyright (c) 2024 Tri Dao.
|
|
97
|
+
All rights reserved.
|
|
98
|
+
|
|
99
|
+
All contributions by Arm:
|
|
100
|
+
Copyright (c) 2021, 2023-2025 Arm Limited and/or its affiliates
|
|
101
|
+
|
|
102
|
+
All contributions from Caffe:
|
|
103
|
+
Copyright(c) 2013, 2014, 2015, the respective contributors
|
|
104
|
+
All rights reserved.
|
|
105
|
+
|
|
106
|
+
All other contributions:
|
|
107
|
+
Copyright(c) 2015, 2016 the respective contributors
|
|
108
|
+
All rights reserved.
|
|
109
|
+
|
|
110
|
+
Caffe2 uses a copyright model similar to Caffe: each contributor holds
|
|
111
|
+
copyright over their contributions to Caffe2. The project versioning records
|
|
112
|
+
all such contribution and copyright details. If a contributor wants to further
|
|
113
|
+
mark their specific copyright on a particular contribution, they should
|
|
114
|
+
indicate their copyright solely in the commit message of the change when it is
|
|
115
|
+
committed.
|
|
116
|
+
|
|
117
|
+
All rights reserved.
|
|
118
|
+
|
|
119
|
+
Redistribution and use in source and binary forms, with or without
|
|
120
|
+
modification, are permitted provided that the following conditions are met:
|
|
121
|
+
|
|
122
|
+
1. Redistributions of source code must retain the above copyright
|
|
123
|
+
notice, this list of conditions and the following disclaimer.
|
|
124
|
+
|
|
125
|
+
2. Redistributions in binary form must reproduce the above copyright
|
|
126
|
+
notice, this list of conditions and the following disclaimer in the
|
|
127
|
+
documentation and/or other materials provided with the distribution.
|
|
128
|
+
|
|
129
|
+
3. Neither the names of Facebook, Deepmind Technologies, NYU, NEC Laboratories America
|
|
130
|
+
and IDIAP Research Institute nor the names of its contributors may be
|
|
131
|
+
used to endorse or promote products derived from this software without
|
|
132
|
+
specific prior written permission.
|
|
133
|
+
|
|
134
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
135
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
136
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
137
|
+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
138
|
+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
139
|
+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
140
|
+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
141
|
+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
142
|
+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
143
|
+
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
144
|
+
POSSIBILITY OF SUCH DAMAGE.
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling>=1.27"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "biomedparse-mlx"
|
|
7
|
+
version = "0.1.1"
|
|
8
|
+
description = "Native MLX inference for BioMedParse v2 on Apple Silicon"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
classifiers = ["Operating System :: MacOS :: MacOS X"]
|
|
11
|
+
license = "Apache-2.0 AND MIT AND BSD-3-Clause"
|
|
12
|
+
license-files = ["LICENSE", "THIRD_PARTY_NOTICES.md"]
|
|
13
|
+
authors = [{ name = "Joseph Sandoval" }, { name = "Alfredo Sandoval Jr." }]
|
|
14
|
+
requires-python = ">=3.13,<3.15"
|
|
15
|
+
dependencies = [
|
|
16
|
+
"medmlx-core==0.2.3",
|
|
17
|
+
"numpy>=2,<3",
|
|
18
|
+
"tokenizers>=0.22,<0.23",
|
|
19
|
+
"nibabel>=5.3,<6",
|
|
20
|
+
"pillow>=13,<14",
|
|
21
|
+
"pydicom>=3,<4",
|
|
22
|
+
"scikit-image>=0.25,<1",
|
|
23
|
+
]
|
|
24
|
+
|
|
25
|
+
[project.scripts]
|
|
26
|
+
biomedparse-mlx = "biomedparse_mlx.cli:main"
|
|
27
|
+
|
|
28
|
+
[project.entry-points."medmlx.models"]
|
|
29
|
+
biomedparse-v2 = "biomedparse_mlx.medmlx:MODEL"
|
|
30
|
+
|
|
31
|
+
[project.optional-dependencies]
|
|
32
|
+
conversion = ["torch>=2.6,<3", "safetensors>=0.6,<1"]
|
|
33
|
+
assets = ["huggingface-hub>=1,<2"]
|
|
34
|
+
dev = ["pyright==1.1.414", "ruff>=0.13,<1", "pytest>=8.4,<10", "hypothesis>=6.140,<7"]
|
|
35
|
+
oracle = ["torch>=2.6,<3", "timm>=1,<2", "fvcore>=0.1.5", "hydra-core>=1.3,<2", "safetensors>=0.6,<1", "transformers>=5,<6", "simpleitk>=2.4,<3"]
|
|
36
|
+
|
|
37
|
+
[tool.hatch.metadata]
|
|
38
|
+
allow-direct-references = true
|
|
39
|
+
|
|
40
|
+
[tool.hatch.build.targets.wheel]
|
|
41
|
+
packages = ["src/biomedparse_mlx"]
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
[tool.uv]
|
|
45
|
+
constraint-dependencies = ["setuptools>=84.1.0", "filelock>=4.2.1", ]
|
|
46
|
+
environments = ["sys_platform == 'darwin' and platform_machine == 'arm64'"]
|
|
47
|
+
|
|
48
|
+
[tool.ruff]
|
|
49
|
+
target-version = "py313"
|
|
50
|
+
line-length = 100
|
|
51
|
+
|
|
52
|
+
[tool.ruff.lint]
|
|
53
|
+
select = ["E", "F", "I", "UP", "B", "SIM", "RUF", "ANN401", "TID251", "TID252"]
|
|
54
|
+
|
|
55
|
+
[tool.pytest.ini_options]
|
|
56
|
+
testpaths = ["tests"]
|
|
57
|
+
addopts = "--strict-config --strict-markers"
|
|
58
|
+
markers = ["metal: evaluated native MLX execution", "oracle: upstream PyTorch comparison"]
|
|
59
|
+
|
|
60
|
+
[tool.pyright]
|
|
61
|
+
include = ["src", "tests", "typings"]
|
|
62
|
+
stubPath = "typings"
|
|
63
|
+
extraPaths = ["src"]
|
|
64
|
+
pythonVersion = "3.13"
|
|
65
|
+
typeCheckingMode = "strict"
|
|
66
|
+
enableTypeIgnoreComments = false
|
|
67
|
+
reportUnnecessaryTypeIgnoreComment = "error"
|
|
68
|
+
|
|
69
|
+
[tool.ruff.lint.flake8-tidy-imports]
|
|
70
|
+
ban-relative-imports = "all"
|
|
71
|
+
|
|
72
|
+
[tool.ruff.lint.flake8-tidy-imports.banned-api]
|
|
73
|
+
"typing.Any" = { msg = "Use a precise type or protocol." }
|
|
74
|
+
"typing_extensions.Any" = { msg = "Use a precise type or protocol." }
|
|
75
|
+
|
|
76
|
+
[tool.uv.sources]
|
|
77
|
+
medmlx-core = { git = "https://github.com/MedMLX/medmlx.git", rev = "e765f0a94aa31e8dfcdc599e4a4206eaca84f8b0", subdirectory = "packages/core" }
|
|
78
|
+
|
|
79
|
+
[tool.hatch.build.targets.sdist]
|
|
80
|
+
exclude = ["AGENTS.md", "CLAUDE.md", ".claude", ".codex", ".cursor"]
|
|
81
|
+
only-include = [
|
|
82
|
+
"src/biomedparse_mlx",
|
|
83
|
+
"pyproject.toml",
|
|
84
|
+
"README.md",
|
|
85
|
+
"LICENSE",
|
|
86
|
+
"THIRD_PARTY_NOTICES.md",
|
|
87
|
+
]
|