Upload MLX packaging for OpenMed-PII-Italian-FastClinical-Small-82M-v1-mlx

README.md

@@ -0,0 +1,105 @@
+---
+license: apache-2.0
+base_model: OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1
+pipeline_tag: token-classification
+library_name: openmed
+tags:
+  - openmed
+  - mlx
+  - apple-silicon
+  - token-classification
+  - pii
+  - de-identification
+  - medical
+  - clinical
+---
+
+# OpenMed-PII-Italian-FastClinical-Small-82M-v1 for OpenMed MLX
+
+This repository contains a **private MLX packaging** of [`OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1`](https://huggingface.co/OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1) for Apple Silicon inference with [**OpenMed**](https://github.com/maziyarpanahi/openmed).
+
+[OpenMed](https://github.com/maziyarpanahi/openmed) is the main product experience:
+
+- Install the Python package with `pip install openmed`
+- Enable Apple Silicon acceleration with `pip install "openmed[mlx]"`
+- Run the same OpenMed API you already use, now backed by MLX on macOS
+- For Apple apps, use **OpenMedKit** from the same GitHub repository with a CoreML bundle
+
+This MLX repo is meant to pair with:
+
+- OpenMed GitHub: [https://github.com/maziyarpanahi/openmed](https://github.com/maziyarpanahi/openmed)
+- OpenMed website: [https://openmed.life](https://openmed.life)
+- Source checkpoint: [`OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1`](https://huggingface.co/OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1)
+
+## Quick Start
+
+### Python
+
+```bash
+pip install openmed
+pip install "openmed[mlx]"
+```
+
+```python
+from openmed import analyze_text
+from openmed.core.config import OpenMedConfig
+
+result = analyze_text(
+    "Patient John Doe, DOB 1990-05-15, SSN 123-45-6789",
+    model_name="OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1",
+    config=OpenMedConfig(backend="mlx"),
+)
+
+for entity in result.entities:
+    print(entity.label, entity.text, round(entity.confidence, 4))
+```
+
+You can use the source model ID directly through OpenMed, or download this private MLX packaging from [`OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1-mlx`](https://huggingface.co/OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1-mlx) for a preconverted path.
+
+### Swift
+
+Use Swift with **OpenMedKit**, not with MLX weight files directly.
+
+1. Open Xcode and go to **File > Add Package Dependencies...**
+2. Paste the OpenMed repository URL:
+   `https://github.com/maziyarpanahi/openmed`
+3. Choose the package product **OpenMedKit** from the repository.
+4. Add a compatible CoreML model bundle plus `id2label.json` to your app target.
+
+After that, import OpenMedKit in Swift:
+
+```swift
+import OpenMedKit
+```
+
+Then load your bundled CoreML model and label map:
+
+```swift
+import Foundation
+import OpenMedKit
+
+let modelFolder = Bundle.main.resourceURL!
+let modelURL = modelFolder.appendingPathComponent("OpenMedPII.mlmodelc")
+let labelsURL = modelFolder.appendingPathComponent("id2label.json")
+
+let openmed = try OpenMed(
+    modelURL: modelURL,
+    id2labelURL: labelsURL
+)
+```
+
+This private MLX artifact remains the right choice for:
+
+- Python services on Apple Silicon
+- local MLX inference on macOS
+- private preconverted packaging on the Hub
+
+If a given architecture or environment cannot be exported cleanly as `safetensors`, OpenMed falls back to `weights.npz` so the model remains usable.
+
+## Credits
+
+- Base checkpoint: [`OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1`](https://huggingface.co/OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1)
+- OpenMed GitHub: [https://github.com/maziyarpanahi/openmed](https://github.com/maziyarpanahi/openmed)
+- OpenMed website: [https://openmed.life](https://openmed.life)
+- MLX packaging and runtime support: [**OpenMed**](https://github.com/maziyarpanahi/openmed)
+- Swift runtime for Apple apps: **OpenMedKit** from the OpenMed repository

config.json

@@ -0,0 +1,196 @@
+{
+  "transformers_version": "5.5.0",
+  "architectures": [
+    "RobertaForTokenClassification"
+  ],
+  "output_hidden_states": false,
+  "return_dict": true,
+  "dtype": "float32",
+  "chunk_size_feed_forward": 0,
+  "is_encoder_decoder": false,
+  "id2label": {
+    "0": "O",
+    "1": "B-ACCOUNTNAME",
+    "2": "B-AGE",
+    "3": "B-AMOUNT",
+    "4": "B-BANKACCOUNT",
+    "5": "B-BIC",
+    "6": "B-BITCOINADDRESS",
+    "7": "B-BUILDINGNUMBER",
+    "8": "B-CITY",
+    "9": "B-COUNTY",
+    "10": "B-CREDITCARD",
+    "11": "B-CREDITCARDISSUER",
+    "12": "B-CURRENCY",
+    "13": "B-CURRENCYCODE",
+    "14": "B-CURRENCYNAME",
+    "15": "B-CURRENCYSYMBOL",
+    "16": "B-CVV",
+    "17": "B-DATE",
+    "18": "B-DATEOFBIRTH",
+    "19": "B-EMAIL",
+    "20": "B-ETHEREUMADDRESS",
+    "21": "B-EYECOLOR",
+    "22": "B-FIRSTNAME",
+    "23": "B-GENDER",
+    "24": "B-GPSCOORDINATES",
+    "25": "B-HEIGHT",
+    "26": "B-IBAN",
+    "27": "B-IMEI",
+    "28": "B-IPADDRESS",
+    "29": "B-JOBDEPARTMENT",
+    "30": "B-JOBTITLE",
+    "31": "B-LASTNAME",
+    "32": "B-LITECOINADDRESS",
+    "33": "B-MACADDRESS",
+    "34": "B-MASKEDNUMBER",
+    "35": "B-MIDDLENAME",
+    "36": "B-OCCUPATION",
+    "37": "B-ORDINALDIRECTION",
+    "38": "B-ORGANIZATION",
+    "39": "B-PASSWORD",
+    "40": "B-PHONE",
+    "41": "B-PIN",
+    "42": "B-PREFIX",
+    "43": "B-SECONDARYADDRESS",
+    "44": "B-SEX",
+    "45": "B-SSN",
+    "46": "B-STATE",
+    "47": "B-STREET",
+    "48": "B-TIME",
+    "49": "B-URL",
+    "50": "B-USERAGENT",
+    "51": "B-USERNAME",
+    "52": "B-VIN",
+    "53": "B-VRM",
+    "54": "B-ZIPCODE",
+    "55": "I-ACCOUNTNAME",
+    "56": "I-AGE",
+    "57": "I-AMOUNT",
+    "58": "I-CITY",
+    "59": "I-COUNTY",
+    "60": "I-CURRENCY",
+    "61": "I-CURRENCYNAME",
+    "62": "I-DATE",
+    "63": "I-DATEOFBIRTH",
+    "64": "I-EYECOLOR",
+    "65": "I-GENDER",
+    "66": "I-HEIGHT",
+    "67": "I-JOBTITLE",
+    "68": "I-ORGANIZATION",
+    "69": "I-PHONE",
+    "70": "I-SECONDARYADDRESS",
+    "71": "I-SSN",
+    "72": "I-STATE",
+    "73": "I-STREET",
+    "74": "I-TIME",
+    "75": "I-USERAGENT"
+  },
+  "label2id": {
+    "B-ACCOUNTNAME": 1,
+    "B-AGE": 2,
+    "B-AMOUNT": 3,
+    "B-BANKACCOUNT": 4,
+    "B-BIC": 5,
+    "B-BITCOINADDRESS": 6,
+    "B-BUILDINGNUMBER": 7,
+    "B-CITY": 8,
+    "B-COUNTY": 9,
+    "B-CREDITCARD": 10,
+    "B-CREDITCARDISSUER": 11,
+    "B-CURRENCY": 12,
+    "B-CURRENCYCODE": 13,
+    "B-CURRENCYNAME": 14,
+    "B-CURRENCYSYMBOL": 15,
+    "B-CVV": 16,
+    "B-DATE": 17,
+    "B-DATEOFBIRTH": 18,
+    "B-EMAIL": 19,
+    "B-ETHEREUMADDRESS": 20,
+    "B-EYECOLOR": 21,
+    "B-FIRSTNAME": 22,
+    "B-GENDER": 23,
+    "B-GPSCOORDINATES": 24,
+    "B-HEIGHT": 25,
+    "B-IBAN": 26,
+    "B-IMEI": 27,
+    "B-IPADDRESS": 28,
+    "B-JOBDEPARTMENT": 29,
+    "B-JOBTITLE": 30,
+    "B-LASTNAME": 31,
+    "B-LITECOINADDRESS": 32,
+    "B-MACADDRESS": 33,
+    "B-MASKEDNUMBER": 34,
+    "B-MIDDLENAME": 35,
+    "B-OCCUPATION": 36,
+    "B-ORDINALDIRECTION": 37,
+    "B-ORGANIZATION": 38,
+    "B-PASSWORD": 39,
+    "B-PHONE": 40,
+    "B-PIN": 41,
+    "B-PREFIX": 42,
+    "B-SECONDARYADDRESS": 43,
+    "B-SEX": 44,
+    "B-SSN": 45,
+    "B-STATE": 46,
+    "B-STREET": 47,
+    "B-TIME": 48,
+    "B-URL": 49,
+    "B-USERAGENT": 50,
+    "B-USERNAME": 51,
+    "B-VIN": 52,
+    "B-VRM": 53,
+    "B-ZIPCODE": 54,
+    "I-ACCOUNTNAME": 55,
+    "I-AGE": 56,
+    "I-AMOUNT": 57,
+    "I-CITY": 58,
+    "I-COUNTY": 59,
+    "I-CURRENCY": 60,
+    "I-CURRENCYNAME": 61,
+    "I-DATE": 62,
+    "I-DATEOFBIRTH": 63,
+    "I-EYECOLOR": 64,
+    "I-GENDER": 65,
+    "I-HEIGHT": 66,
+    "I-JOBTITLE": 67,
+    "I-ORGANIZATION": 68,
+    "I-PHONE": 69,
+    "I-SECONDARYADDRESS": 70,
+    "I-SSN": 71,
+    "I-STATE": 72,
+    "I-STREET": 73,
+    "I-TIME": 74,
+    "I-USERAGENT": 75,
+    "O": 0
+  },
+  "problem_type": null,
+  "vocab_size": 50265,
+  "hidden_size": 768,
+  "num_hidden_layers": 6,
+  "num_attention_heads": 12,
+  "intermediate_size": 3072,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "attention_probs_dropout_prob": 0.1,
+  "max_position_embeddings": 514,
+  "type_vocab_size": 1,
+  "initializer_range": 0.02,
+  "layer_norm_eps": 1e-05,
+  "pad_token_id": 1,
+  "bos_token_id": 0,
+  "eos_token_id": 2,
+  "use_cache": true,
+  "classifier_dropout": null,
+  "is_decoder": false,
+  "add_cross_attention": false,
+  "tie_word_embeddings": true,
+  "_name_or_path": "OpenMed/OpenMed-PII-Italian-FastClinical-Small-82M-v1",
+  "model_type": "roberta",
+  "position_embedding_type": "absolute",
+  "output_attentions": false,
+  "_mlx_position_offset": 2,
+  "_mlx_model_type": "bert",
+  "num_labels": 76,
+  "_mlx_weights_format": "safetensors"
+}

id2label.json

@@ -0,0 +1,78 @@
+{
+  "0": "O",
+  "1": "B-ACCOUNTNAME",
+  "2": "B-AGE",
+  "3": "B-AMOUNT",
+  "4": "B-BANKACCOUNT",
+  "5": "B-BIC",
+  "6": "B-BITCOINADDRESS",
+  "7": "B-BUILDINGNUMBER",
+  "8": "B-CITY",
+  "9": "B-COUNTY",
+  "10": "B-CREDITCARD",
+  "11": "B-CREDITCARDISSUER",
+  "12": "B-CURRENCY",
+  "13": "B-CURRENCYCODE",
+  "14": "B-CURRENCYNAME",
+  "15": "B-CURRENCYSYMBOL",
+  "16": "B-CVV",
+  "17": "B-DATE",
+  "18": "B-DATEOFBIRTH",
+  "19": "B-EMAIL",
+  "20": "B-ETHEREUMADDRESS",
+  "21": "B-EYECOLOR",
+  "22": "B-FIRSTNAME",
+  "23": "B-GENDER",
+  "24": "B-GPSCOORDINATES",
+  "25": "B-HEIGHT",
+  "26": "B-IBAN",
+  "27": "B-IMEI",
+  "28": "B-IPADDRESS",
+  "29": "B-JOBDEPARTMENT",
+  "30": "B-JOBTITLE",
+  "31": "B-LASTNAME",
+  "32": "B-LITECOINADDRESS",
+  "33": "B-MACADDRESS",
+  "34": "B-MASKEDNUMBER",
+  "35": "B-MIDDLENAME",
+  "36": "B-OCCUPATION",
+  "37": "B-ORDINALDIRECTION",
+  "38": "B-ORGANIZATION",
+  "39": "B-PASSWORD",
+  "40": "B-PHONE",
+  "41": "B-PIN",
+  "42": "B-PREFIX",
+  "43": "B-SECONDARYADDRESS",
+  "44": "B-SEX",
+  "45": "B-SSN",
+  "46": "B-STATE",
+  "47": "B-STREET",
+  "48": "B-TIME",
+  "49": "B-URL",
+  "50": "B-USERAGENT",
+  "51": "B-USERNAME",
+  "52": "B-VIN",
+  "53": "B-VRM",
+  "54": "B-ZIPCODE",
+  "55": "I-ACCOUNTNAME",
+  "56": "I-AGE",
+  "57": "I-AMOUNT",
+  "58": "I-CITY",
+  "59": "I-COUNTY",
+  "60": "I-CURRENCY",
+  "61": "I-CURRENCYNAME",
+  "62": "I-DATE",
+  "63": "I-DATEOFBIRTH",
+  "64": "I-EYECOLOR",
+  "65": "I-GENDER",
+  "66": "I-HEIGHT",
+  "67": "I-JOBTITLE",
+  "68": "I-ORGANIZATION",
+  "69": "I-PHONE",
+  "70": "I-SECONDARYADDRESS",
+  "71": "I-SSN",
+  "72": "I-STATE",
+  "73": "I-STREET",
+  "74": "I-TIME",
+  "75": "I-USERAGENT"
+}

weights.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b9437a03dfdd367a9b0b3d72bb5b43a78b5d14042c7c260825f039eae8059c63
+size 326355889