josand commited on
Commit
4ea5f0c
·
verified ·
1 Parent(s): d4bbcc5

Document verified public runtime and checkpoint scope

Browse files
Files changed (1) hide show
  1. README.md +13 -6
README.md CHANGED
@@ -14,6 +14,7 @@ language:
14
  - en
15
  inference: false
16
  pipeline_tag: image-segmentation
 
17
  ---
18
 
19
  # FleXray Radiograph Segmentation
@@ -32,15 +33,16 @@ MLX implementation by [MedMLX](https://github.com/MedMLX).
32
 
33
  ## Requirements
34
 
35
- Apple Silicon Mac with Metal GPU access, Python 3.12 and [uv](https://docs.astral.sh/uv/).
36
  The weights are included here; checkpoint conversion is not needed.
37
 
38
  ## Quick start
39
 
40
  ```bash
41
- uv venv --python 3.12
42
  source .venv/bin/activate
43
- uv pip install "flexray-mlx @ git+https://github.com/MedMLX/flexray-mlx.git" huggingface_hub
 
44
 
45
  hf download MedMLX/flexray-mlx --local-dir models
46
  ```
@@ -78,7 +80,11 @@ Each run writes:
78
 
79
  ## Technical details
80
 
81
- Native result: **success**. Original-code comparison: **pass**, `minimum_per_label_dice` = `0.9999704176268988`.
 
 
 
 
82
 
83
  Paper uses flux0375 only; the prepared bundle supports `ensemble=False`. The unchanged upstream ensemble descriptor lists all five members, but only the flagship member is packaged. Original comparison passes. Montgomery radiograph panels are excluded from submission/distribution pending image-sharing clearance.
84
 
@@ -116,8 +122,9 @@ clinical diagnosis or treatment decisions.
116
  ## License
117
 
118
  Weights: **CC-BY-NC-4.0** ([license](https://huggingface.co/MedMLX/flexray-mlx/blob/main/LICENSE)).
119
- Upstream code: **MIT**. MLX port code:
120
- [Apache-2.0](https://github.com/MedMLX/flexray-mlx/blob/main/LICENSE).
 
121
 
122
  Retain the [attribution and notices](https://huggingface.co/MedMLX/flexray-mlx/blob/main/NOTICE) when redistributing
123
  the bundle or a conversion:
 
14
  - en
15
  inference: false
16
  pipeline_tag: image-segmentation
17
+ base_model: VictorButoi/flexray
18
  ---
19
 
20
  # FleXray Radiograph Segmentation
 
33
 
34
  ## Requirements
35
 
36
+ Apple Silicon Mac with Metal GPU access, Python 3.13 or 3.14 and [uv](https://docs.astral.sh/uv/).
37
  The weights are included here; checkpoint conversion is not needed.
38
 
39
  ## Quick start
40
 
41
  ```bash
42
+ uv venv --python 3.13
43
  source .venv/bin/activate
44
+ uv pip install "flexray-mlx @ https://github.com/MedMLX/flexray-mlx/releases/download/v0.2.1/flexray_mlx-0.2.1-py3-none-any.whl"
45
+ uv tool install huggingface-hub
46
 
47
  hf download MedMLX/flexray-mlx --local-dir models
48
  ```
 
80
 
81
  ## Technical details
82
 
83
+ The companion runtime is [v0.2.1](https://github.com/MedMLX/flexray-mlx/releases/tag/v0.2.1), source `5a0ef5f36f40ef606819a48b5869d381386909a2`, with `medmlx-core==0.2.3`. All 206 flagship tensors exactly match the original publisher's pinned `6b63ddf09cfdff99aea494e3738cf243a4e22cdb` bundle used for that release. The ensemble descriptor, flagship configuration, label schema and preprocessing metadata are also byte-identical. The installed public bundle admission accepts this Hub layout with `ensemble=False`, without loading MLX. No weights or runtime assets were changed by this card update.
84
+
85
+ The current fresh installed-wheel suite passed 122 tests with zero skips using independently recorded, seeded upstream numerical fixtures. Separate real released-weight API runs checked flagship execution and the complete external five-member ensemble with TTA; the latter does not imply the missing four members are included here. Those execution/output checks are separate from released-checkpoint cross-framework agreement and clinical accuracy. The following one-case reference comparison is historical and retains its original revision and settings.
86
+
87
+ Historical native result: **success**. Original-code comparison: **pass**, `minimum_per_label_dice` = `0.9999704176268988`.
88
 
89
  Paper uses flux0375 only; the prepared bundle supports `ensemble=False`. The unchanged upstream ensemble descriptor lists all five members, but only the flagship member is packaged. Original comparison passes. Montgomery radiograph panels are excluded from submission/distribution pending image-sharing clearance.
90
 
 
122
  ## License
123
 
124
  Weights: **CC-BY-NC-4.0** ([license](https://huggingface.co/MedMLX/flexray-mlx/blob/main/LICENSE)).
125
+ Upstream FleXray code is **MIT**. Original MLX port contributions are
126
+ [Apache-2.0](https://github.com/MedMLX/flexray-mlx/blob/main/LICENSE), with retained MIT and BSD notices for FleXray, PyTorch and TorchVision adaptations in
127
+ [THIRD_PARTY_NOTICES.md](https://github.com/MedMLX/flexray-mlx/blob/main/THIRD_PARTY_NOTICES.md). These code terms do not replace the noncommercial weight license above.
128
 
129
  Retain the [attribution and notices](https://huggingface.co/MedMLX/flexray-mlx/blob/main/NOTICE) when redistributing
130
  the bundle or a conversion: