Upload model

README.md

@@ -1,127 +1,131 @@
-
 ---
-license: apache-2.0
 library_name: span-marker
 tags:
 - span-marker
 - token-classification
 - ner
 - named-entity-recognition
-pipeline_tag: token-classification
-widget:
-- text: "Here, DA = direct assessment, RR = relative ranking, DS = discrete scale and CS = continuous scale."
-  example_title: "Example 1"
-- text: "Modifying or replacing the Erasable Programmable Read Only Memory (EPROM) in a phone would allow the configuration of any ESN and MIN via software for cellular devices."
-  example_title: "Example 2"
-- text: "We propose a technique called Aggressive Stochastic Weight Averaging (ASWA) and an extension called Norm-filtered Aggressive Stochastic Weight Averaging (NASWA) which improves the stability of models over random seeds."
-  example_title: "Example 3"
-- text: "The choice of the encoder and decoder modules of DNPG can be quite flexible, for instance long-short term memory networks (LSTM) or convolutional neural network (CNN)."
-  example_title: "Example 4"
-model-index:
-  - name: SpanMarker w. bert-base-cased on Acronym Identification by Tom Aarsen
-    results:
-      - task:
-          type: token-classification
-          name: Named Entity Recognition
-        dataset:
-          type: acronym_identification
-          name: Acronym Identification
-          split: validation
-          revision: c3c245a18bbd57b1682b099e14460eebf154cbdf
-        metrics:
-          - type: f1
-            value: 0.9310
-            name: F1
-          - type: precision
-            value: 0.9423
-            name: Precision
-          - type: recall
-            value: 0.9199
-            name: Recall
-datasets:
-  - acronym_identification
-language:
-  - en
+- generated_from_span_marker_trainer
 metrics:
-  - f1
-  - recall
-  - precision
+- precision
+- recall
+- f1
+widget: []
+pipeline_tag: token-classification
 ---
 
-# SpanMarker for Acronyms Named Entity Recognition
-
-This is a [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) model trained on the [acronym_identification](https://huggingface.co/datasets/acronym_identification) dataset. In particular, this SpanMarker model uses [bert-base-cased](https://huggingface.co/bert-base-cased) as the underlying encoder. See [train.py](train.py) for the training script.
+# SpanMarker
 
-Is your data not (always) capitalized correctly? Then consider using the uncased variant of this model instead for better performance: 
-[tomaarsen/span-marker-bert-base-uncased-acronyms](https://huggingface.co/tomaarsen/span-marker-bert-base-uncased-acronyms).
+This is a [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) model that can be used for Named Entity Recognition.
 
-## Metrics
+## Model Details
 
-It achieves the following results on the validation set:
-- Overall Precision: 0.9423
-- Overall Recall: 0.9199
-- Overall F1: 0.9310
-- Overall Accuracy: 0.9830
+### Model Description
+- **Model Type:** SpanMarker
+<!-- - **Encoder:** [Unknown](https://huggingface.co/unknown) -->
+- **Maximum Sequence Length:** 256 tokens
+- **Maximum Entity Length:** 8 words
+<!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
+<!-- - **Language:** Unknown -->
+<!-- - **License:** Unknown -->
 
-## Labels
+### Model Sources
 
-| **Label** | **Examples** |
-|-----------|--------------|
-| SHORT     | "NLP", "CoQA", "SODA", "SCA" | 
-| LONG      | "Natural Language Processing", "Conversational Question Answering", "Symposium on Discrete Algorithms", "successive convex approximation" |
+- **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
 
-## Usage
+### Direct Use for Inference
 
-To use this model for inference, first install the `span_marker` library:
+```python
+from span_marker import SpanMarkerModel
 
-```bash
-pip install span_marker
+# 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.")
 ```
 
-You can then run inference with this model like so:
+### Downstream Use
+You can finetune this model on your own dataset.
+
+<details><summary>Click to expand</summary>
 
 ```python
-from span_marker import SpanMarkerModel
+from span_marker import SpanMarkerModel, Trainer
 
 # Download from the 🤗 Hub
-model = SpanMarkerModel.from_pretrained("tomaarsen/span-marker-bert-base-acronyms")
-# Run inference
-entities = model.predict("Compression algorithms like Principal Component Analysis (PCA) can reduce noise and complexity.")
+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
+
+### Framework Versions
+- Python: 3.9.16
+- SpanMarker: 1.3.1.dev
+- Transformers: 4.30.0
+- PyTorch: 2.0.1+cu118
+- Datasets: 2.14.0
+- Tokenizers: 0.13.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}
+}
 ```
 
-See the [SpanMarker](https://github.com/tomaarsen/SpanMarkerNER) repository for documentation and additional information on this library.
-
-## Training procedure
-
-### Training hyperparameters
-
-The following hyperparameters were used during training:
-- learning_rate: 5e-05
-- train_batch_size: 32
-- eval_batch_size: 32
-- 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: 2
-
-### Training results
-
-| Training Loss | Epoch | Step | Validation Loss | Overall Precision | Overall Recall | Overall F1 | Overall Accuracy |
-|:-------------:|:-----:|:----:|:---------------:|:-----------------:|:--------------:|:----------:|:----------------:|
-| 0.0109        | 0.31  | 200  | 0.0079          | 0.9202            | 0.8962         | 0.9080     | 0.9765           |
-| 0.0075        | 0.62  | 400  | 0.0070          | 0.9358            | 0.8724         | 0.9030     | 0.9765           |
-| 0.0068        | 0.93  | 600  | 0.0059          | 0.9363            | 0.9203         | 0.9282     | 0.9821           |
-| 0.0057        | 1.24  | 800  | 0.0056          | 0.9372            | 0.9187         | 0.9278     | 0.9824           |
-| 0.0051        | 1.55  | 1000 | 0.0054          | 0.9381            | 0.9170         | 0.9274     | 0.9824           |
-| 0.0054        | 1.86  | 1200 | 0.0053          | 0.9424            | 0.9218         | 0.9320     | 0.9834           |
-| 0.0054        | 2.00  | 1290 | 0.0054          | 0.9423            | 0.9199         | 0.9310     | 0.9830           |
-
-### Framework versions
-
-- SpanMarker 1.2.4
-- Transformers 4.31.0
-- Pytorch 1.13.1+cu117
-- Datasets 2.14.3
-- Tokenizers 0.13.2
+<!--
+## 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.*
+-->

config.json

@@ -1,5 +1,5 @@
 {
-  "_name_or_path": "models\\span_marker_bert_base_acronyms\\checkpoint-final",
+  "_name_or_path": "models\\tomaarsen\\span-marker-bert-base-acronyms\\checkpoint-final",
   "architectures": [
     "SpanMarkerModel"
   ],
@@ -84,7 +84,7 @@
     "top_p": 1.0,
     "torch_dtype": null,
     "torchscript": false,
-    "transformers_version": "4.31.0",
+    "transformers_version": "4.30.0",
     "type_vocab_size": 2,
     "typical_p": 1.0,
     "use_bfloat16": false,
@@ -94,8 +94,8 @@
   "entity_max_length": 8,
   "id2label": {
     "0": "O",
-    "1": "LONG",
-    "2": "SHORT"
+    "1": "long",
+    "2": "short"
   },
   "id2reduced_id": {
     "0": 1,
@@ -105,9 +105,9 @@
     "4": 0
   },
   "label2id": {
-    "LONG": 1,
     "O": 0,
-    "SHORT": 2
+    "long": 1,
+    "short": 2
   },
   "marker_max_length": 128,
   "max_next_context": null,
@@ -115,9 +115,9 @@
   "model_max_length": 256,
   "model_max_length_default": 512,
   "model_type": "span-marker",
-  "span_marker_version": "1.2.5.dev",
+  "span_marker_version": "1.3.1.dev",
   "torch_dtype": "float32",
   "trained_with_document_context": false,
-  "transformers_version": "4.31.0",
+  "transformers_version": "4.30.0",
   "vocab_size": 28998
 }

pytorch_model.bin

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:b60063b813ab8a8a15e8c15c7258685cd21fe2ca6a5e0e3d2f347140b33f747e
-size 433331825
+oid sha256:30895143e4a162f4a27e493c5d56e7dc6928902762e1ff6b1d1c7522cb7e1f2e
+size 433336245