macpaw-research/mnemos_entity_extractor_v1_small

README.md

@@ -0,0 +1,231 @@
+---
+tags:
+- span-marker
+- token-classification
+- ner
+- named-entity-recognition
+- generated_from_span_marker_trainer
+widget:
+- text: Please lower the brightness, locate any images exceeding 2 MB that contain
+    the summary section, and activate privacy settings in the application.
+- text: Before the meeting in Room 204, can you copy the references list from the
+    thesis and disable notifications for comments in Google Docs?
+- text: For tomorrow' s Parent - Teacher Conference at Lincoln High School, make sure
+    the volume is set to low and email the agenda to principal @ lincolnhs . edu.
+- text: Is the conclusion on page 12 of the thesis . pdf ready for review by Marcus
+    Osei this Thursday? Also, please check if auto - save is enabled.
+- text: Upload the image called vacation2023 . png to my boss via his work email and
+    delete all photos from the gallery app.
+pipeline_tag: token-classification
+library_name: span-marker
+metrics:
+- precision
+- recall
+- f1
+model-index:
+- name: SpanMarker
+  results:
+  - task:
+      type: token-classification
+      name: Named Entity Recognition
+    dataset:
+      name: Unknown
+      type: unknown
+      split: eval
+    metrics:
+    - type: f1
+      value: 0.8599876058665565
+      name: F1
+    - type: precision
+      value: 0.8455601592330815
+      name: Precision
+    - type: recall
+      value: 0.874915938130464
+      name: Recall
+---
+
+# SpanMarker
+
+This is a [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) model that can be used for Named Entity Recognition.
+
+## Model Details
+
+### Model Description
+- **Model Type:** SpanMarker
+<!-- - **Encoder:** [Unknown](https://huggingface.co/unknown) -->
+- **Maximum Sequence Length:** 512 tokens
+- **Maximum Entity Length:** 8 words
+<!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
+<!-- - **Language:** Unknown -->
+<!-- - **License:** Unknown -->
+
+### Model Sources
+
+- **Repository:** [SpanMarker on GitHub](https://github.com/tomaarsen/SpanMarkerNER)
+- **Thesis:** [SpanMarker For Named Entity Recognition](https://raw.githubusercontent.com/tomaarsen/SpanMarkerNER/main/thesis.pdf)
+
+### Model Labels
+| Label          | Examples                                                        |
+|:---------------|:----------------------------------------------------------------|
+| action         | "arrive", "print", "bring"                                      |
+| app_data_type  | "posts", "playlists", "messages"                                |
+| app_name       | "Notion", "Spotify", "Viber"                                    |
+| app_setting    | "notifications", "dark mode", "language setting"                |
+| contact_info   | "address", "email address", "office number"                     |
+| date           | "March 3rd", "15 . 04 . 2024", "2024 - 04 - 01"                 |
+| device_setting | "notifications", "screen timeout", "bluetooth"                  |
+| event_title    | "table", "Board Meeting", "Charity Gala"                        |
+| file_name      | "sales_data . xlsx", "vacation_photos . zip", "expenses . xlsx" |
+| file_size      | "above 700MB", "above 500 kb", "2 MB"                           |
+| file_type      | "document files", "spreadsheet", "videos"                       |
+| folder_name    | "Downloads", "Budget Reports", "Invoices"                       |
+| in_file_data   | "table of contents", "table 2", "table 4"                       |
+| location       | "conference room", "Riverside Pavilion", "San Francisco office" |
+| person_name    | "Maria Lopez", "Priya Singh", "Alexei Petrov"                   |
+| relationship   | "friend", "sister", "colleague"                                 |
+| system_command | "airplane mode", "enable", "delete"                             |
+| time           | "13 : 45", "8 : 30 AM", "noon"                                  |
+
+## Evaluation
+
+### Metrics
+| Label          | Precision | Recall | F1     |
+|:---------------|:----------|:-------|:-------|
+| **all**        | 0.8456    | 0.8749 | 0.8600 |
+| action         | 0.8261    | 0.9137 | 0.8677 |
+| app_data_type  | 0.7631    | 0.6862 | 0.7226 |
+| app_name       | 0.9066    | 0.9407 | 0.9233 |
+| app_setting    | 0.8525    | 0.8998 | 0.8755 |
+| contact_info   | 0.8847    | 0.9089 | 0.8966 |
+| date           | 0.9342    | 0.9302 | 0.9322 |
+| device_setting | 0.8345    | 0.8450 | 0.8397 |
+| event_title    | 0.8881    | 0.9149 | 0.9013 |
+| file_name      | 0.9393    | 0.9243 | 0.9317 |
+| file_size      | 0.7518    | 0.7357 | 0.7437 |
+| file_type      | 0.7535    | 0.8697 | 0.8075 |
+| folder_name    | 0.9523    | 0.9106 | 0.9310 |
+| in_file_data   | 0.7632    | 0.7969 | 0.7797 |
+| location       | 0.8953    | 0.8658 | 0.8803 |
+| person_name    | 0.9742    | 0.9788 | 0.9765 |
+| relationship   | 0.9381    | 0.9476 | 0.9428 |
+| system_command | 0.75      | 0.7491 | 0.7495 |
+| time           | 0.8733    | 0.8385 | 0.8555 |
+
+## Uses
+
+### Direct Use for Inference
+
+```python
+from span_marker import SpanMarkerModel
+
+# Download from the 🤗 Hub
+model = SpanMarkerModel.from_pretrained("span_marker_model_id")
+# Run inference
+entities = model.predict("Upload the image called vacation2023 . png to my boss via his work email and delete all photos from the gallery app.")
+```
+
+### Downstream Use
+You can finetune this model on your own dataset.
+
+<details><summary>Click to expand</summary>
+
+```python
+from span_marker import SpanMarkerModel, Trainer
+
+# Download from the 🤗 Hub
+model = SpanMarkerModel.from_pretrained("span_marker_model_id")
+
+# Specify a Dataset with "tokens" and "ner_tag" columns
+dataset = load_dataset("conll2003") # For example CoNLL2003
+
+# Initialize a Trainer using the pretrained model & dataset
+trainer = Trainer(
+    model=model,
+    train_dataset=dataset["train"],
+    eval_dataset=dataset["validation"],
+)
+trainer.train()
+trainer.save_model("span_marker_model_id-finetuned")
+```
+</details>
+
+<!--
+### Out-of-Scope Use
+
+*List how the model may foreseeably be misused and address what users ought not to do with the model.*
+-->
+
+<!--
+## Bias, Risks and Limitations
+
+*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
+-->
+
+<!--
+### Recommendations
+
+*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
+-->
+
+## Training Details
+
+### Training Set Metrics
+| Training set          | Min | Median  | Max |
+|:----------------------|:----|:--------|:----|
+| Sentence length       | 5   | 19.3422 | 54  |
+| Entities per sentence | 2   | 5.9111  | 13  |
+
+### Training Hyperparameters
+- learning_rate: 5e-05
+- train_batch_size: 32
+- eval_batch_size: 32
+- seed: 42
+- optimizer: Use OptimizerNames.ADAMW_TORCH with betas=(0.9,0.999) and epsilon=1e-08 and optimizer_args=No additional optimizer arguments
+- lr_scheduler_type: linear
+- lr_scheduler_warmup_ratio: 0.1
+- num_epochs: 4
+- mixed_precision_training: Native AMP
+
+### Training Results
+| Epoch  | Step | Validation Loss | Validation Precision | Validation Recall | Validation F1 | Validation Accuracy |
+|:------:|:----:|:---------------:|:--------------------:|:-----------------:|:-------------:|:-------------------:|
+| 1.9763 | 1000 | 0.0369          | 0.8426               | 0.8649            | 0.8536        | 0.9231              |
+| 3.9526 | 2000 | 0.0352          | 0.8450               | 0.8751            | 0.8598        | 0.9264              |
+
+### Framework Versions
+- Python: 3.12.11
+- SpanMarker: 1.7.0
+- Transformers: 4.51.3
+- PyTorch: 2.8.0+cu126
+- Datasets: 3.6.0
+- Tokenizers: 0.21.4
+
+## Citation
+
+### BibTeX
+```
+@software{Aarsen_SpanMarker,
+    author = {Aarsen, Tom},
+    license = {Apache-2.0},
+    title = {{SpanMarker for Named Entity Recognition}},
+    url = {https://github.com/tomaarsen/SpanMarkerNER}
+}
+```
+
+<!--
+## Glossary
+
+*Clearly define terms in order to be accessible across audiences.*
+-->
+
+<!--
+## Model Card Authors
+
+*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
+-->
+
+<!--
+## Model Card Contact
+
+*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
+-->

added_tokens.json

@@ -0,0 +1,4 @@
+{
+  "<end>": 28997,
+  "<start>": 28996
+}

config.json

@@ -0,0 +1,251 @@
+{
+  "architectures": [
+    "SpanMarkerModel"
+  ],
+  "encoder": {
+    "_attn_implementation_autoset": false,
+    "_name_or_path": "bert-base-cased",
+    "add_cross_attention": false,
+    "architectures": [
+      "BertForMaskedLM"
+    ],
+    "attention_probs_dropout_prob": 0.1,
+    "bad_words_ids": null,
+    "begin_suppress_tokens": null,
+    "bos_token_id": null,
+    "chunk_size_feed_forward": 0,
+    "classifier_dropout": null,
+    "cross_attention_hidden_size": null,
+    "decoder_start_token_id": null,
+    "diversity_penalty": 0.0,
+    "do_sample": false,
+    "early_stopping": false,
+    "encoder_no_repeat_ngram_size": 0,
+    "eos_token_id": null,
+    "exponential_decay_length_penalty": null,
+    "finetuning_task": null,
+    "forced_bos_token_id": null,
+    "forced_eos_token_id": null,
+    "gradient_checkpointing": false,
+    "hidden_act": "gelu",
+    "hidden_dropout_prob": 0.1,
+    "hidden_size": 768,
+    "id2label": {
+      "0": "O",
+      "1": "B-action",
+      "2": "B-app_data_type",
+      "3": "B-app_name",
+      "4": "B-app_setting",
+      "5": "B-contact_info",
+      "6": "B-date",
+      "7": "B-device_setting",
+      "8": "B-event_title",
+      "9": "B-file_name",
+      "10": "B-file_size",
+      "11": "B-file_type",
+      "12": "B-folder_name",
+      "13": "B-in_file_data",
+      "14": "B-location",
+      "15": "B-person_name",
+      "16": "B-relationship",
+      "17": "B-system_command",
+      "18": "B-time",
+      "19": "I-action",
+      "20": "I-app_data_type",
+      "21": "I-app_name",
+      "22": "I-app_setting",
+      "23": "I-contact_info",
+      "24": "I-date",
+      "25": "I-device_setting",
+      "26": "I-event_title",
+      "27": "I-file_name",
+      "28": "I-file_size",
+      "29": "I-file_type",
+      "30": "I-folder_name",
+      "31": "I-in_file_data",
+      "32": "I-location",
+      "33": "I-person_name",
+      "34": "I-relationship",
+      "35": "I-system_command",
+      "36": "I-time"
+    },
+    "initializer_range": 0.02,
+    "intermediate_size": 3072,
+    "is_decoder": false,
+    "is_encoder_decoder": false,
+    "label2id": {
+      "B-action": 1,
+      "B-app_data_type": 2,
+      "B-app_name": 3,
+      "B-app_setting": 4,
+      "B-contact_info": 5,
+      "B-date": 6,
+      "B-device_setting": 7,
+      "B-event_title": 8,
+      "B-file_name": 9,
+      "B-file_size": 10,
+      "B-file_type": 11,
+      "B-folder_name": 12,
+      "B-in_file_data": 13,
+      "B-location": 14,
+      "B-person_name": 15,
+      "B-relationship": 16,
+      "B-system_command": 17,
+      "B-time": 18,
+      "I-action": 19,
+      "I-app_data_type": 20,
+      "I-app_name": 21,
+      "I-app_setting": 22,
+      "I-contact_info": 23,
+      "I-date": 24,
+      "I-device_setting": 25,
+      "I-event_title": 26,
+      "I-file_name": 27,
+      "I-file_size": 28,
+      "I-file_type": 29,
+      "I-folder_name": 30,
+      "I-in_file_data": 31,
+      "I-location": 32,
+      "I-person_name": 33,
+      "I-relationship": 34,
+      "I-system_command": 35,
+      "I-time": 36,
+      "O": 0
+    },
+    "layer_norm_eps": 1e-12,
+    "length_penalty": 1.0,
+    "max_length": 20,
+    "max_position_embeddings": 512,
+    "min_length": 0,
+    "model_type": "bert",
+    "no_repeat_ngram_size": 0,
+    "num_attention_heads": 12,
+    "num_beam_groups": 1,
+    "num_beams": 1,
+    "num_hidden_layers": 12,
+    "num_return_sequences": 1,
+    "output_attentions": false,
+    "output_hidden_states": false,
+    "output_scores": false,
+    "pad_token_id": 0,
+    "position_embedding_type": "absolute",
+    "prefix": null,
+    "problem_type": null,
+    "pruned_heads": {},
+    "remove_invalid_values": false,
+    "repetition_penalty": 1.0,
+    "return_dict": true,
+    "return_dict_in_generate": false,
+    "sep_token_id": null,
+    "suppress_tokens": null,
+    "task_specific_params": null,
+    "temperature": 1.0,
+    "tf_legacy_loss": false,
+    "tie_encoder_decoder": false,
+    "tie_word_embeddings": true,
+    "tokenizer_class": null,
+    "top_k": 50,
+    "top_p": 1.0,
+    "torch_dtype": null,
+    "torchscript": false,
+    "transformers_version": "4.51.3",
+    "type_vocab_size": 2,
+    "typical_p": 1.0,
+    "use_bfloat16": false,
+    "use_cache": true,
+    "vocab_size": 29000
+  },
+  "entity_max_length": 8,
+  "id2label": {
+    "0": "O",
+    "1": "action",
+    "2": "app_data_type",
+    "3": "app_name",
+    "4": "app_setting",
+    "5": "contact_info",
+    "6": "date",
+    "7": "device_setting",
+    "8": "event_title",
+    "9": "file_name",
+    "10": "file_size",
+    "11": "file_type",
+    "12": "folder_name",
+    "13": "in_file_data",
+    "14": "location",
+    "15": "person_name",
+    "16": "relationship",
+    "17": "system_command",
+    "18": "time"
+  },
+  "id2reduced_id": {
+    "0": 0,
+    "1": 1,
+    "2": 2,
+    "3": 3,
+    "4": 4,
+    "5": 5,
+    "6": 6,
+    "7": 7,
+    "8": 8,
+    "9": 9,
+    "10": 10,
+    "11": 11,
+    "12": 12,
+    "13": 13,
+    "14": 14,
+    "15": 15,
+    "16": 16,
+    "17": 17,
+    "18": 18,
+    "19": 1,
+    "20": 2,
+    "21": 3,
+    "22": 4,
+    "23": 5,
+    "24": 6,
+    "25": 7,
+    "26": 8,
+    "27": 9,
+    "28": 10,
+    "29": 11,
+    "30": 12,
+    "31": 13,
+    "32": 14,
+    "33": 15,
+    "34": 16,
+    "35": 17,
+    "36": 18
+  },
+  "label2id": {
+    "O": 0,
+    "action": 1,
+    "app_data_type": 2,
+    "app_name": 3,
+    "app_setting": 4,
+    "contact_info": 5,
+    "date": 6,
+    "device_setting": 7,
+    "event_title": 8,
+    "file_name": 9,
+    "file_size": 10,
+    "file_type": 11,
+    "folder_name": 12,
+    "in_file_data": 13,
+    "location": 14,
+    "person_name": 15,
+    "relationship": 16,
+    "system_command": 17,
+    "time": 18
+  },
+  "marker_max_length": 128,
+  "max_next_context": null,
+  "max_prev_context": null,
+  "model_max_length": 512,
+  "model_max_length_default": 512,
+  "model_type": "span-marker",
+  "span_marker_version": "1.7.0",
+  "torch_dtype": "float32",
+  "trained_with_document_context": false,
+  "transformers_version": "4.51.3",
+  "vocab_size": 29000
+}

model.safetensors

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

runs/Oct13_12-21-18_2e4e6b33cc2f/events.out.tfevents.1760358151.2e4e6b33cc2f.5538.0

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

runs/Oct13_12-21-18_2e4e6b33cc2f/events.out.tfevents.1760358497.2e4e6b33cc2f.5538.1

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

special_tokens_map.json

@@ -0,0 +1,7 @@
+{
+  "cls_token": "[CLS]",
+  "mask_token": "[MASK]",
+  "pad_token": "[PAD]",
+  "sep_token": "[SEP]",
+  "unk_token": "[UNK]"
+}

tokenizer_config.json

@@ -0,0 +1,75 @@
+{
+  "add_prefix_space": true,
+  "added_tokens_decoder": {
+    "0": {
+      "content": "[PAD]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "100": {
+      "content": "[UNK]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "101": {
+      "content": "[CLS]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "102": {
+      "content": "[SEP]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "103": {
+      "content": "[MASK]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "28996": {
+      "content": "<start>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "28997": {
+      "content": "<end>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "clean_up_tokenization_spaces": false,
+  "cls_token": "[CLS]",
+  "do_lower_case": false,
+  "entity_max_length": 8,
+  "extra_special_tokens": {},
+  "marker_max_length": 128,
+  "mask_token": "[MASK]",
+  "model_max_length": 512,
+  "pad_token": "[PAD]",
+  "sep_token": "[SEP]",
+  "strip_accents": null,
+  "tokenize_chinese_chars": true,
+  "tokenizer_class": "BertTokenizer",
+  "unk_token": "[UNK]"
+}

training_args.bin

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