Pratik-B/span-marker-bert-base-fewnerd-coarse-super

README.md

@@ -0,0 +1,229 @@
+---
+library_name: span-marker
+tags:
+- span-marker
+- token-classification
+- ner
+- named-entity-recognition
+- generated_from_span_marker_trainer
+datasets:
+- DFKI-SLT/few-nerd
+metrics:
+- precision
+- recall
+- f1
+widget:
+- text: The Hebrew Union College libraries in Cincinnati and Los Angeles, the Library
+    of Congress in Washington, D.C ., the Jewish Theological Seminary in New York
+    City, and the Harvard University Library (which received donations of Deinard's
+    texts from Lucius Nathan Littauer, housed in Widener and Houghton libraries) also
+    have large collections of Deinard works.
+- text: Abu Abd Allah Muhammad al-Idrisi (1099–1165 or 1166), the Moroccan Muslim
+    geographer, cartographer, Egyptologist and traveller who lived in Sicily at the
+    court of King Roger II, mentioned this island, naming it جزيرة مليطمة ("jazīrat
+    Malīṭma", "the island of Malitma ") on page 583 of his book "Nuzhat al-mushtaq
+    fi ihtiraq ghal afaq", otherwise known as The Book of Roger, considered a geographic
+    encyclopaedia of the medieval world.
+- text: The font is also used in the logo of the American rock band Greta Van Fleet,
+    in the logo for Netflix show "Stranger Things ", and in the album art for rapper
+    Logic's album "Supermarket ".
+- text: Caretaker manager George Goss led them on a run in the FA Cup, defeating Liverpool
+    in round 4, to reach the semi-final at Stamford Bridge, where they were defeated
+    2–0 by Sheffield United on 28 March 1925.
+- text: In 1991, the National Science Foundation (NSF), which manages the U.S . Antarctic
+    Program (US AP), honoured his memory by dedicating a state-of-the-art laboratory
+    complex in his name, the Albert P. Crary Science and Engineering Center (CSEC)
+    located in McMurdo Station.
+pipeline_tag: token-classification
+model-index:
+- name: SpanMarker
+  results:
+  - task:
+      type: token-classification
+      name: Named Entity Recognition
+    dataset:
+      name: Unknown
+      type: DFKI-SLT/few-nerd
+      split: test
+    metrics:
+    - type: f1
+      value: 0.7710703953712633
+      name: F1
+    - type: precision
+      value: 0.778881745567894
+      name: Precision
+    - type: recall
+      value: 0.7634141684170327
+      name: Recall
+---
+
+# SpanMarker
+
+This is a [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) model trained on the [DFKI-SLT/few-nerd](https://huggingface.co/datasets/DFKI-SLT/few-nerd) dataset that can be used for Named Entity Recognition.
+
+## Model Details
+
+### Model Description
+- **Model Type:** SpanMarker
+<!-- - **Encoder:** [Unknown](https://huggingface.co/unknown) -->
+- **Maximum Sequence Length:** 256 tokens
+- **Maximum Entity Length:** 8 words
+- **Training Dataset:** [DFKI-SLT/few-nerd](https://huggingface.co/datasets/DFKI-SLT/few-nerd)
+<!-- - **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                                                                       |
+|:-------------|:-------------------------------------------------------------------------------|
+| art          | "The Seven Year Itch", "Time", "Imelda de ' Lambertazzi"                       |
+| building     | "Henry Ford Museum", "Sheremetyevo International Airport", "Boston Garden"     |
+| event        | "French Revolution", "Iranian Constitutional Revolution", "Russian Revolution" |
+| location     | "Croatian", "the Republic of Croatia", "Mediterranean Basin"                   |
+| organization | "IAEA", "Church 's Chicken", "Texas Chicken"                                   |
+| other        | "Amphiphysin", "N-terminal lipid", "BAR"                                       |
+| person       | "Edmund Payne", "Ellaline Terriss", "Hicks"                                    |
+| product      | "100EX", "Phantom", "Corvettes - GT1 C6R"                                      |
+
+## Evaluation
+
+### Metrics
+| Label        | Precision | Recall | F1     |
+|:-------------|:----------|:-------|:-------|
+| **all**      | 0.7789    | 0.7634 | 0.7711 |
+| art          | 0.7610    | 0.7256 | 0.7429 |
+| building     | 0.6316    | 0.6857 | 0.6575 |
+| event        | 0.6304    | 0.5346 | 0.5786 |
+| location     | 0.8114    | 0.8554 | 0.8328 |
+| organization | 0.7370    | 0.68   | 0.7074 |
+| other        | 0.7407    | 0.6085 | 0.6682 |
+| person       | 0.8611    | 0.9035 | 0.8818 |
+| product      | 0.704     | 0.5966 | 0.6459 |
+
+## 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("Caretaker manager George Goss led them on a run in the FA Cup, defeating Liverpool in round 4, to reach the semi-final at Stamford Bridge, where they were defeated 2–0 by Sheffield United on 28 March 1925.")
+```
+
+### 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       | 1   | 24.4956 | 163 |
+| Entities per sentence | 0   | 2.5439  | 35  |
+
+### Training Hyperparameters
+- learning_rate: 5e-05
+- train_batch_size: 4
+- eval_batch_size: 4
+- seed: 42
+- gradient_accumulation_steps: 2
+- total_train_batch_size: 8
+- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- lr_scheduler_type: linear
+- lr_scheduler_warmup_ratio: 0.1
+- num_epochs: 1
+
+### Training Results
+| Epoch  | Step | Validation Loss | Validation Precision | Validation Recall | Validation F1 | Validation Accuracy |
+|:------:|:----:|:---------------:|:--------------------:|:-----------------:|:-------------:|:-------------------:|
+| 0.1629 | 200  | 0.0335          | 0.6884               | 0.6223            | 0.6537        | 0.9062              |
+| 0.3259 | 400  | 0.0238          | 0.7412               | 0.7193            | 0.7301        | 0.9242              |
+| 0.4888 | 600  | 0.0220          | 0.7628               | 0.7378            | 0.7501        | 0.9325              |
+| 0.6517 | 800  | 0.0211          | 0.7614               | 0.7677            | 0.7645        | 0.9376              |
+| 0.8147 | 1000 | 0.0197          | 0.7839               | 0.7596            | 0.7716        | 0.9384              |
+| 0.9776 | 1200 | 0.0194          | 0.7803               | 0.7633            | 0.7717        | 0.9393              |
+
+### Framework Versions
+- Python: 3.10.12
+- SpanMarker: 1.5.0
+- Transformers: 4.37.2
+- PyTorch: 2.1.0+cu121
+- Datasets: 2.17.1
+- Tokenizers: 0.15.2
+
+## 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,113 @@
+{
+  "architectures": [
+    "SpanMarkerModel"
+  ],
+  "encoder": {
+    "_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": "art",
+      "2": "building",
+      "3": "event",
+      "4": "location",
+      "5": "organization",
+      "6": "other",
+      "7": "person",
+      "8": "product"
+    },
+    "initializer_range": 0.02,
+    "intermediate_size": 3072,
+    "is_decoder": false,
+    "is_encoder_decoder": false,
+    "label2id": {
+      "O": 0,
+      "art": 1,
+      "building": 2,
+      "event": 3,
+      "location": 4,
+      "organization": 5,
+      "other": 6,
+      "person": 7,
+      "product": 8
+    },
+    "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.37.2",
+    "type_vocab_size": 2,
+    "typical_p": 1.0,
+    "use_bfloat16": false,
+    "use_cache": true,
+    "vocab_size": 29000
+  },
+  "entity_max_length": 8,
+  "marker_max_length": 128,
+  "max_next_context": null,
+  "max_prev_context": null,
+  "model_max_length": 256,
+  "model_max_length_default": 512,
+  "model_type": "span-marker",
+  "span_marker_version": "1.5.0",
+  "torch_dtype": "float32",
+  "trained_with_document_context": false,
+  "transformers_version": "4.37.2",
+  "vocab_size": 29000
+}

model.safetensors

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

runs/Feb22_11-50-38_6163c3b3e44c/events.out.tfevents.1708602666.6163c3b3e44c.470.0

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

runs/Feb22_11-50-38_6163c3b3e44c/events.out.tfevents.1708604273.6163c3b3e44c.470.1

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

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,72 @@
+{
+  "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": true,
+  "cls_token": "[CLS]",
+  "do_lower_case": false,
+  "mask_token": "[MASK]",
+  "model_max_length": 256,
+  "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:b252a26ee0168b48fa32b5f1d0db50b7c417473e6d39ec7b6bd306be2c0bee8c
+size 4728