Upload model

README.md

@@ -0,0 +1,85 @@
+---
+library_name: span-marker
+tags:
+- span-marker
+- token-classification
+- ner
+- named-entity-recognition
+- generated_from_span_marker_trainer
+metrics:
+- precision
+- recall
+- f1
+widget: []
+pipeline_tag: token-classification
+---
+
+# 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/models/unknown) -->
+- **Maximum Sequence Length:** 256 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)
+
+## Uses
+
+### Direct Use
+
+```python
+from span_marker import SpanMarkerModel
+
+# Download from the 🤗 Hub
+model = SpanMarkerModel.from_pretrained("span_marker_model_id")
+# Run inference
+entities = model.predict("Amelia Earhart flew her single engine Lockheed Vega 5B across the Atlantic to Paris.")
+```
+
+### 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>
+
+## Training Details
+
+### Framework Versions
+
+- Python: 3.9.16
+- SpanMarker: 1.3.1.dev
+- Transformers : 4.29.2
+- PyTorch: 2.0.1+cu118
+- Datasets: 2.14.3
+- Tokenizers: 0.13.2

added_tokens.json

@@ -0,0 +1,4 @@
+{
+  "<end>": 30523,
+  "<start>": 30522
+}

config.json

@@ -0,0 +1,115 @@
+{
+  "_name_or_path": "models\\tomaarsen\\span_marker_bert_base_uncased_keyphrase_inspec\\checkpoint-final",
+  "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": "B-KEY",
+      "2": "I-KEY"
+    },
+    "initializer_range": 0.02,
+    "intermediate_size": 3072,
+    "is_decoder": false,
+    "is_encoder_decoder": false,
+    "label2id": {
+      "B-KEY": 1,
+      "I-KEY": 2,
+      "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.29.2",
+    "type_vocab_size": 2,
+    "typical_p": 1.0,
+    "use_bfloat16": false,
+    "use_cache": true,
+    "vocab_size": 30524
+  },
+  "entity_max_length": 8,
+  "id2label": {
+    "0": "O",
+    "1": "KEY"
+  },
+  "id2reduced_id": {
+    "0": 0,
+    "1": 1,
+    "2": 1
+  },
+  "label2id": {
+    "KEY": 1,
+    "O": 0
+  },
+  "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.3.1.dev",
+  "torch_dtype": "float32",
+  "trained_with_document_context": false,
+  "transformers_version": "4.29.2",
+  "vocab_size": 30524
+}

pytorch_model.bin

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

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,14 @@
+{
+  "add_prefix_space": true,
+  "clean_up_tokenization_spaces": true,
+  "cls_token": "[CLS]",
+  "do_lower_case": true,
+  "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]"
+}