Update README.md

README.md

@@ -2,11 +2,12 @@
 tags:
 - spacy
 - token-classification
+- ner
 language:
 - en
 license: mit
 model-index:
-- name: en_core_web_sm_job
+- name: en_core_web_sm_job 
   results:
   - task:
       name: NER
@@ -14,55 +15,79 @@ model-index:
     metrics:
     - name: NER Precision
       type: precision
-      value: 0.8454836771
+      value: 0.7516398746
     - name: NER Recall
       type: recall
-      value: 0.8456530449
+      value: 0.6069711538
     - name: NER F Score
       type: f_score
-      value: 0.8455683525
+      value: 0.6742971968
   - task:
       name: TAG
       type: token-classification
     metrics:
     - name: TAG (XPOS) Accuracy
       type: accuracy
-      value: 0.97246532
-  - task:
-      name: UNLABELED_DEPENDENCIES
-      type: token-classification
-    metrics:
-    - name: Unlabeled Attachment Score (UAS)
-      type: f_score
-      value: 0.9175304332
-  - task:
-      name: LABELED_DEPENDENCIES
-      type: token-classification
-    metrics:
-    - name: Labeled Attachment Score (LAS)
-      type: f_score
-      value: 0.89874821
-  - task:
-      name: SENTS
-      type: token-classification
-    metrics:
-    - name: Sentences F-Score
-      type: f_score
-      value: 0.9059485531
+      value: 0.7334810915
+
+library_name: spacy
+pipeline_tag: text-classification
 ---
-English pipeline optimized for CPU. Components: tok2vec, tagger, parser, senter, ner, attribute_ruler, lemmatizer.
+# Custom spaCy NER Model for "Profession," "Facility," and "Experience" Entities
+
+### Overview
+This spaCy-based Named Entity Recognition (NER) model has been custom-trained to recognize and classify entities related to "profession," "facility," and "experience." It is designed to enhance your text analysis capabilities by identifying these specific entity types in unstructured text data.
+
+### Key Features
+Custom-trained for high accuracy in recognizing "profession," "facility," and "experience" entities.
+Suitable for various NLP tasks, such as information extraction, content categorization, and more.
+Can be easily integrated into your existing spaCy-based NLP pipelines.
+
+### Usage
+#### Installation
+##### You can install the custom spaCy NER model using pip:
+
+```bash
+pip install https://huggingface.co/DaFull/en_core_web_sm_job /resolve/main/en_core_web_sm_job -any-py3-none-any.whl
+
+```
+#### Example Usage
+Here's how you can use the model for entity recognition in Python:
+
+```python
+
+import spacy
+
+# Load the custom spaCy NER model
+nlp = spacy.load("en_core_web_sm_job ")
+
+# Process your text
+text = "HR Specialist needed at Google, Dallas, TX, with expertise in employee relations and a minimum of 4 years of HR experience."
+doc = nlp(text)
+
+# Extract named entities
+for ent in doc.ents:
+    print(f"Entity: {ent.text}, Type: {ent.label_}")
+
+```
+
+####  Entity Types
+The model recognizes the following entity types:
+
+- PROFESSION: Represents professions or job titles.
+- FACILITY: Denotes facilities, buildings, or locations.
+- EXPERIENCE: Identifies mentions of work experience, durations, or qualifications.
 
 | Feature | Description |
 | --- | --- |
-| **Name** | `en_core_web_sm_job` |
+| **Name** | `en_core_web_sm_job ` |
 | **Version** | `3.6.0` |
 | **spaCy** | `>=3.6.0,<3.7.0` |
 | **Default Pipeline** | `tok2vec`, `tagger`, `parser`, `attribute_ruler`, `lemmatizer`, `ner` |
 | **Components** | `tok2vec`, `tagger`, `parser`, `senter`, `attribute_ruler`, `lemmatizer`, `ner` |
-| **Vectors** | 0 keys, 0 unique vectors (0 dimensions) |
-| **Sources** | [OntoNotes 5](https://catalog.ldc.upenn.edu/LDC2013T19) (Ralph Weischedel, Martha Palmer, Mitchell Marcus, Eduard Hovy, Sameer Pradhan, Lance Ramshaw, Nianwen Xue, Ann Taylor, Jeff Kaufman, Michelle Franchini, Mohammed El-Bachouti, Robert Belvin, Ann Houston)<br>[ClearNLP Constituent-to-Dependency Conversion](https://github.com/clir/clearnlp-guidelines/blob/master/md/components/dependency_conversion.md) (Emory University)<br>[WordNet 3.0](https://wordnet.princeton.edu/) (Princeton University) |
+| **Vectors** | 514157 keys, 514157 unique vectors (300 dimensions) |
 | **License** | `MIT` |
-| **Author** | [Explosion](https://explosion.ai) |
+
 
 ### Label Scheme
 
@@ -82,16 +107,7 @@ English pipeline optimized for CPU. Components: tok2vec, tagger, parser, senter,
 
 | Type | Score |
 | --- | --- |
-| `TOKEN_ACC` | 99.86 |
-| `TOKEN_P` | 99.57 |
-| `TOKEN_R` | 99.58 |
-| `TOKEN_F` | 99.57 |
-| `TAG_ACC` | 97.25 |
-| `SENTS_P` | 92.02 |
-| `SENTS_R` | 89.21 |
-| `SENTS_F` | 90.59 |
-| `DEP_UAS` | 91.75 |
-| `DEP_LAS` | 89.87 |
-| `ENTS_P` | 84.55 |
-| `ENTS_R` | 84.57 |
-| `ENTS_F` | 84.56 |
+| `TOKEN_P` | 75.57 |
+| `TOKEN_R` | 60.58 |
+| `TOKEN_F` | 67.57 |
+| `CUSTOM_TAG_ACC` | 73.35 |