Upload 9 files

README.md

@@ -0,0 +1,215 @@
+---
+language: en
+license: cc-by-sa-4.0
+library_name: span-marker
+tags:
+- span-marker
+- token-classification
+- ner
+- named-entity-recognition
+- generated_from_span_marker_trainer
+metrics:
+- precision
+- recall
+- f1
+widget:
+- text: Inductively Coupled Plasma - Mass Spectrometry ( ICP - MS ) analysis of Longcliffe
+    SP52 limestone was undertaken to identify other impurities present , and the effect
+    of sorbent mass and SO2 concentration on elemental partitioning in the carbonator
+    between solid sorbent and gaseous phase was investigated , using a bubbler sampling
+    system .
+- text: We extensively evaluate our work against benchmark and competitive protocols
+    across a range of metrics over three real connectivity and GPS traces such as
+    Sassy [ 44 ] , San Francisco Cabs [ 45 ] and Infocom 2006 [ 33 ] .
+- text: In this research , we developed a robust two - layer classifier that can accurately
+    classify normal hearing ( NH ) from hearing impaired ( HI ) infants with congenital
+    sensori - neural hearing loss ( SNHL ) based on their Magnetic Resonance ( MR
+    ) images .
+- text: In situ Peak Force Tapping AFM was employed for determining morphology and
+    nano - mechanical properties of the surface layer .
+- text: By means of a criterion of Gilmer for polynomially dense subsets of the ring
+    of integers of a number field , we show that , if h∈K[X ] maps every element of
+    OK of degree n to an algebraic integer , then h(X ) is integral - valued over
+    OK , that is , h(OK)⊂OK .
+pipeline_tag: token-classification
+base_model: bert-base-uncased
+model-index:
+- name: SpanMarker with bert-base-uncased on my-data
+  results:
+  - task:
+      type: token-classification
+      name: Named Entity Recognition
+    dataset:
+      name: my-data
+      type: unknown
+      split: test
+    metrics:
+    - type: f1
+      value: 0.6547008547008547
+      name: F1
+    - type: precision
+      value: 0.69009009009009
+      name: Precision
+    - type: recall
+      value: 0.6227642276422765
+      name: Recall
+---
+
+# SpanMarker with bert-base-uncased on my-data
+
+This is a [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) model that can be used for Named Entity Recognition. This SpanMarker model uses [bert-base-uncased](https://huggingface.co/bert-base-uncased) as the underlying encoder.
+
+## Model Details
+
+### Model Description
+- **Model Type:** SpanMarker
+- **Encoder:** [bert-base-uncased](https://huggingface.co/bert-base-uncased)
+- **Maximum Sequence Length:** 256 tokens
+- **Maximum Entity Length:** 8 words
+<!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
+- **Language:** en
+- **License:** cc-by-sa-4.0
+
+### 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                                                                                                |
+|:---------|:--------------------------------------------------------------------------------------------------------|
+| Data     | "an overall mitochondrial", "defect", "Depth time - series"                                             |
+| Material | "cross - shore measurement locations", "the subject 's fibroblasts", "COXI , COXII and COXIII subunits" |
+| Method   | "EFSA", "an approximation", "in vitro"                                                                  |
+| Process  | "translation", "intake", "a significant reduction of synthesis"                                         |
+
+## Evaluation
+
+### Metrics
+| Label    | Precision | Recall | F1     |
+|:---------|:----------|:-------|:-------|
+| **all**  | 0.6901    | 0.6228 | 0.6547 |
+| Data     | 0.6136    | 0.5714 | 0.5918 |
+| Material | 0.7926    | 0.7413 | 0.7661 |
+| Method   | 0.4286    | 0.3    | 0.3529 |
+| Process  | 0.6780    | 0.5854 | 0.6283 |
+
+## 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("In situ Peak Force Tapping AFM was employed for determining morphology and nano - mechanical properties of the surface layer .")
+```
+
+### 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       | 3   | 25.6049 | 106 |
+| Entities per sentence | 0   | 5.2439  | 22  |
+
+### Training Hyperparameters
+- learning_rate: 5e-05
+- train_batch_size: 8
+- eval_batch_size: 8
+- seed: 42
+- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- lr_scheduler_type: linear
+- lr_scheduler_warmup_ratio: 0.1
+- num_epochs: 10
+
+### Training Results
+| Epoch  | Step | Validation Loss | Validation Precision | Validation Recall | Validation F1 | Validation Accuracy |
+|:------:|:----:|:---------------:|:--------------------:|:-----------------:|:-------------:|:-------------------:|
+| 2.0134 | 300  | 0.0557          | 0.6921               | 0.5706            | 0.6255        | 0.7645              |
+| 4.0268 | 600  | 0.0583          | 0.6994               | 0.6527            | 0.6752        | 0.7974              |
+| 6.0403 | 900  | 0.0701          | 0.7085               | 0.6679            | 0.6876        | 0.8039              |
+| 8.0537 | 1200 | 0.0797          | 0.6963               | 0.6870            | 0.6916        | 0.8129              |
+
+### Framework Versions
+- Python: 3.10.12
+- SpanMarker: 1.5.0
+- Transformers: 4.36.2
+- PyTorch: 2.0.1+cu118
+- Datasets: 2.16.1
+- Tokenizers: 0.15.0
+
+## 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>": 30523,
+  "<start>": 30522
+}

config.json

@@ -0,0 +1,105 @@
+{
+  "architectures": [
+    "SpanMarkerModel"
+  ],
+  "encoder": {
+    "_name_or_path": "bert-base-uncased",
+    "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": "Data",
+      "2": "Material",
+      "3": "Method",
+      "4": "Process"
+    },
+    "initializer_range": 0.02,
+    "intermediate_size": 3072,
+    "is_decoder": false,
+    "is_encoder_decoder": false,
+    "label2id": {
+      "Data": 1,
+      "Material": 2,
+      "Method": 3,
+      "O": 0,
+      "Process": 4
+    },
+    "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.36.2",
+    "type_vocab_size": 2,
+    "typical_p": 1.0,
+    "use_bfloat16": false,
+    "use_cache": true,
+    "vocab_size": 30528
+  },
+  "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.36.2",
+  "vocab_size": 30528
+}

model.safetensors

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

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,74 @@
+{
+  "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
+    },
+    "30522": {
+      "content": "<start>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "30523": {
+      "content": "<end>",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "clean_up_tokenization_spaces": true,
+  "cls_token": "[CLS]",
+  "do_lower_case": true,
+  "entity_max_length": 8,
+  "marker_max_length": 128,
+  "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:5ca7bd243862991559985b93db78a0a2c78dee03aa2887ad3315cd27b4848b0f
+size 4283