Sentence Similarity
sentence-transformers
Safetensors
bert
feature-extraction
Generated from Trainer
dataset_size:991580
loss:MultipleNegativesRankingLoss
text-embeddings-inference
Instructions to use blackmlengineer/occucoder-en-small-v0 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- sentence-transformers
How to use blackmlengineer/occucoder-en-small-v0 with sentence-transformers:
from sentence_transformers import SentenceTransformer model = SentenceTransformer("blackmlengineer/occucoder-en-small-v0") sentences = [ "Draw Off Worker", "Computer Systems Analysts", "Meat, Poultry, and Fish Cutters and Trimmers", "Food Preparation Workers" ] embeddings = model.encode(sentences) similarities = model.similarity(embeddings, embeddings) print(similarities.shape) # [4, 4] - Notebooks
- Google Colab
- Kaggle
|
Download README.md from blackmlengineer/occucoder-en-small-v0: direct link, hf CLI and curl.
- Browser
- Download file 14.4 kB
-
https://huggingface.co/blackmlengineer/occucoder-en-small-v0/resolve/main/README.md
- Command line
-
hf download hf://blackmlengineer/occucoder-en-small-v0/README.md
-
curl -L -o README.md https://huggingface.co/blackmlengineer/occucoder-en-small-v0/resolve/main/README.md
14.4 kB
| tags: | |
| - sentence-transformers | |
| - sentence-similarity | |
| - feature-extraction | |
| - generated_from_trainer | |
| - dataset_size:991580 | |
| - loss:MultipleNegativesRankingLoss | |
| widget: | |
| - source_sentence: Draw Off Worker | |
| sentences: | |
| - Computer Systems Analysts | |
| - Meat, Poultry, and Fish Cutters and Trimmers | |
| - Food Preparation Workers | |
| - source_sentence: College Tutor | |
| sentences: | |
| - Endoscopy Technicians | |
| - Mathematical Science Teachers, Postsecondary | |
| - Tutors | |
| - source_sentence: Carbon Plant Grinder | |
| sentences: | |
| - Crushing, Grinding, and Polishing Machine Setters, Operators, and Tenders | |
| - Coating, Painting, and Spraying Machine Setters, Operators, and Tenders | |
| - Adhesive Bonding Machine Operators and Tenders | |
| - source_sentence: Roofing Supervisor | |
| sentences: | |
| - Solar Energy Installation Managers | |
| - First-Line Supervisors of Construction Trades and Extraction Workers | |
| - Agricultural Inspectors | |
| - source_sentence: Meat Wrapper | |
| sentences: | |
| - Laundry and Dry-Cleaning Workers | |
| - Printing Press Operators | |
| - Packers and Packagers, Hand | |
| pipeline_tag: sentence-similarity | |
| library_name: sentence-transformers | |
| # SentenceTransformer | |
| This is a [sentence-transformers](https://www.SBERT.net) model trained on the train dataset. It maps sentences & paragraphs to a 128-dimensional dense vector space and can be used for retrieval. | |
| ## Model Details | |
| ### Model Description | |
| - **Model Type:** Sentence Transformer | |
| <!-- - **Base model:** [Unknown](https://huggingface.co/unknown) --> | |
| - **Maximum Sequence Length:** 32 tokens | |
| - **Output Dimensionality:** 128 dimensions | |
| - **Similarity Function:** Cosine Similarity | |
| - **Supported Modality:** Text | |
| - **Training Dataset:** | |
| - train | |
| <!-- - **Language:** Unknown --> | |
| <!-- - **License:** Unknown --> | |
| ### Model Sources | |
| - **Documentation:** [Sentence Transformers Documentation](https://sbert.net) | |
| - **Repository:** [Sentence Transformers on GitHub](https://github.com/huggingface/sentence-transformers) | |
| - **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers) | |
| ### Full Model Architecture | |
| ``` | |
| SentenceTransformer( | |
| (0): Transformer({'transformer_task': 'feature-extraction', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'last_hidden_state'}}, 'module_output_name': 'token_embeddings', 'architecture': 'BertModel'}) | |
| (1): Pooling({'embedding_dimension': 128, 'pooling_mode': 'mean', 'include_prompt': True}) | |
| ) | |
| ``` | |
| ## Usage | |
| ### Direct Usage (Sentence Transformers) | |
| First install the Sentence Transformers library: | |
| ```bash | |
| pip install -U sentence-transformers | |
| ``` | |
| Then you can load this model and run inference. | |
| ```python | |
| from sentence_transformers import SentenceTransformer | |
| # Download from the 🤗 Hub | |
| model = SentenceTransformer("blackmlengineer/occucoder-en-small-v0") | |
| # Run inference | |
| sentences = [ | |
| 'Meat Wrapper', | |
| 'Packers and Packagers, Hand', | |
| 'Laundry and Dry-Cleaning Workers', | |
| ] | |
| embeddings = model.encode(sentences) | |
| print(embeddings.shape) | |
| # [3, 128] | |
| # Get the similarity scores for the embeddings | |
| similarities = model.similarity(embeddings, embeddings) | |
| print(similarities) | |
| # tensor([[1.0000, 0.7078, 0.3098], | |
| # [0.7078, 1.0000, 0.4332], | |
| # [0.3098, 0.4332, 1.0000]]) | |
| ``` | |
| <!-- | |
| ### Direct Usage (Transformers) | |
| <details><summary>Click to see the direct usage in Transformers</summary> | |
| </details> | |
| --> | |
| <!-- | |
| ### Downstream Usage (Sentence Transformers) | |
| You can finetune this model on your own dataset. | |
| <details><summary>Click to expand</summary> | |
| </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 Dataset | |
| #### train | |
| * Dataset: train | |
| * Size: 991,580 training samples | |
| * Columns: <code>anchor</code>, <code>positive</code>, and <code>negative</code> | |
| * Approximate statistics based on the first 100 samples: | |
| | | anchor | positive | negative | | |
| |:---------|:--------------------------------------------------------------------------------|:--------------------------------------------------------------------------------|:---------------------------------------------------------------------------------| | |
| | type | string | string | string | | |
| | modality | text | text | text | | |
| | details | <ul><li>min: 3 tokens</li><li>mean: 4.61 tokens</li><li>max: 8 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 7.7 tokens</li><li>max: 19 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 7.95 tokens</li><li>max: 22 tokens</li></ul> | | |
| * Samples: | |
| | anchor | positive | negative | | |
| |:--------------------------------------|:------------------------------------------------------------|:---------------------------------------------------------------------------| | |
| | <code>Personnel Psychologist</code> | <code>Industrial-Organizational Psychologists</code> | <code>Educational, Guidance, and Career Counselors and Advisors</code> | | |
| | <code>Property Claims Adjuster</code> | <code>Claims Adjusters, Examiners, and Investigators</code> | <code>Administrative Law Judges, Adjudicators, and Hearing Officers</code> | | |
| | <code>Assistant Professor</code> | <code>Art, Drama, and Music Teachers, Postsecondary</code> | <code>Area, Ethnic, and Cultural Studies Teachers, Postsecondary</code> | | |
| * Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters: | |
| ```json | |
| { | |
| "scale": 20.0, | |
| "similarity_fct": "cos_sim", | |
| "gather_across_devices": false, | |
| "directions": [ | |
| "query_to_doc" | |
| ], | |
| "partition_mode": "joint", | |
| "hardness_mode": null, | |
| "hardness_strength": 0.0 | |
| } | |
| ``` | |
| ### Training Hyperparameters | |
| #### Non-Default Hyperparameters | |
| - `per_device_train_batch_size`: 128 | |
| - `num_train_epochs`: 5 | |
| #### All Hyperparameters | |
| <details><summary>Click to expand</summary> | |
| - `per_device_train_batch_size`: 128 | |
| - `num_train_epochs`: 5 | |
| - `max_steps`: -1 | |
| - `learning_rate`: 5e-05 | |
| - `lr_scheduler_type`: linear | |
| - `lr_scheduler_kwargs`: None | |
| - `warmup_steps`: 0 | |
| - `optim`: adamw_torch_fused | |
| - `optim_args`: None | |
| - `weight_decay`: 0.0 | |
| - `adam_beta1`: 0.9 | |
| - `adam_beta2`: 0.999 | |
| - `adam_epsilon`: 1e-08 | |
| - `optim_target_modules`: None | |
| - `gradient_accumulation_steps`: 1 | |
| - `average_tokens_across_devices`: True | |
| - `max_grad_norm`: 1.0 | |
| - `label_smoothing_factor`: 0.0 | |
| - `bf16`: False | |
| - `fp16`: False | |
| - `bf16_full_eval`: False | |
| - `fp16_full_eval`: False | |
| - `tf32`: None | |
| - `gradient_checkpointing`: False | |
| - `gradient_checkpointing_kwargs`: None | |
| - `torch_compile`: False | |
| - `torch_compile_backend`: None | |
| - `torch_compile_mode`: None | |
| - `use_liger_kernel`: False | |
| - `liger_kernel_config`: None | |
| - `use_cache`: False | |
| - `neftune_noise_alpha`: None | |
| - `torch_empty_cache_steps`: None | |
| - `auto_find_batch_size`: False | |
| - `log_on_each_node`: True | |
| - `logging_nan_inf_filter`: True | |
| - `include_num_input_tokens_seen`: no | |
| - `log_level`: passive | |
| - `log_level_replica`: warning | |
| - `disable_tqdm`: False | |
| - `project`: huggingface | |
| - `trackio_space_id`: None | |
| - `trackio_bucket_id`: None | |
| - `trackio_static_space_id`: None | |
| - `per_device_eval_batch_size`: 8 | |
| - `prediction_loss_only`: True | |
| - `eval_on_start`: False | |
| - `eval_do_concat_batches`: True | |
| - `eval_use_gather_object`: False | |
| - `eval_accumulation_steps`: None | |
| - `include_for_metrics`: [] | |
| - `batch_eval_metrics`: False | |
| - `save_only_model`: False | |
| - `save_on_each_node`: False | |
| - `enable_jit_checkpoint`: False | |
| - `push_to_hub`: False | |
| - `hub_private_repo`: None | |
| - `hub_model_id`: None | |
| - `hub_strategy`: every_save | |
| - `hub_always_push`: False | |
| - `hub_revision`: None | |
| - `load_best_model_at_end`: False | |
| - `ignore_data_skip`: False | |
| - `restore_callback_states_from_checkpoint`: False | |
| - `full_determinism`: False | |
| - `seed`: 42 | |
| - `data_seed`: None | |
| - `use_cpu`: False | |
| - `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None} | |
| - `parallelism_config`: None | |
| - `dataloader_drop_last`: False | |
| - `dataloader_num_workers`: 0 | |
| - `dataloader_pin_memory`: True | |
| - `dataloader_persistent_workers`: False | |
| - `dataloader_prefetch_factor`: None | |
| - `remove_unused_columns`: True | |
| - `label_names`: None | |
| - `train_sampling_strategy`: random | |
| - `length_column_name`: length | |
| - `ddp_find_unused_parameters`: None | |
| - `ddp_bucket_cap_mb`: None | |
| - `ddp_broadcast_buffers`: False | |
| - `ddp_static_graph`: None | |
| - `ddp_backend`: None | |
| - `ddp_timeout`: 1800 | |
| - `fsdp`: None | |
| - `fsdp_config`: None | |
| - `deepspeed`: None | |
| - `debug`: [] | |
| - `skip_memory_metrics`: True | |
| - `do_predict`: False | |
| - `resume_from_checkpoint`: None | |
| - `warmup_ratio`: None | |
| - `local_rank`: -1 | |
| - `prompts`: None | |
| - `batch_sampler`: batch_sampler | |
| - `multi_dataset_batch_sampler`: proportional | |
| - `router_mapping`: {} | |
| - `learning_rate_mapping`: {} | |
| </details> | |
| ### Training Logs | |
| | Epoch | Step | Training Loss | | |
| |:------:|:-----:|:-------------:| | |
| | 0.0645 | 500 | 4.4764 | | |
| | 0.1291 | 1000 | 3.6698 | | |
| | 0.1936 | 1500 | 3.2978 | | |
| | 0.2582 | 2000 | 3.0057 | | |
| | 0.3227 | 2500 | 2.7970 | | |
| | 0.3872 | 3000 | 2.6114 | | |
| | 0.4518 | 3500 | 2.4757 | | |
| | 0.5163 | 4000 | 2.3466 | | |
| | 0.5809 | 4500 | 2.2433 | | |
| | 0.6454 | 5000 | 2.1685 | | |
| | 0.7100 | 5500 | 2.0893 | | |
| | 0.7745 | 6000 | 2.0204 | | |
| | 0.8390 | 6500 | 1.9742 | | |
| | 0.9036 | 7000 | 1.9140 | | |
| | 0.9681 | 7500 | 1.8665 | | |
| | 1.0327 | 8000 | 1.8241 | | |
| | 1.0972 | 8500 | 1.7827 | | |
| | 1.1617 | 9000 | 1.7489 | | |
| | 1.2263 | 9500 | 1.7071 | | |
| | 1.2908 | 10000 | 1.6893 | | |
| | 1.3554 | 10500 | 1.6828 | | |
| | 1.4199 | 11000 | 1.6533 | | |
| | 1.4844 | 11500 | 1.6357 | | |
| | 1.5490 | 12000 | 1.6031 | | |
| | 1.6135 | 12500 | 1.5903 | | |
| | 1.6781 | 13000 | 1.5694 | | |
| | 1.7426 | 13500 | 1.5630 | | |
| | 1.8072 | 14000 | 1.5445 | | |
| | 1.8717 | 14500 | 1.5282 | | |
| | 1.9362 | 15000 | 1.5208 | | |
| | 2.0008 | 15500 | 1.5121 | | |
| | 2.0653 | 16000 | 1.4799 | | |
| | 2.1299 | 16500 | 1.4785 | | |
| | 2.1944 | 17000 | 1.4618 | | |
| | 2.2589 | 17500 | 1.4591 | | |
| | 2.3235 | 18000 | 1.4514 | | |
| | 2.3880 | 18500 | 1.4448 | | |
| | 2.4526 | 19000 | 1.4302 | | |
| | 2.5171 | 19500 | 1.4267 | | |
| | 2.5816 | 20000 | 1.4095 | | |
| | 2.6462 | 20500 | 1.4136 | | |
| | 2.7107 | 21000 | 1.4104 | | |
| | 2.7753 | 21500 | 1.4022 | | |
| | 2.8398 | 22000 | 1.3916 | | |
| | 2.9044 | 22500 | 1.3886 | | |
| | 2.9689 | 23000 | 1.3802 | | |
| | 3.0334 | 23500 | 1.3769 | | |
| | 3.0980 | 24000 | 1.3668 | | |
| | 3.1625 | 24500 | 1.3581 | | |
| | 3.2271 | 25000 | 1.3490 | | |
| | 3.2916 | 25500 | 1.3557 | | |
| | 3.3561 | 26000 | 1.3555 | | |
| | 3.4207 | 26500 | 1.3497 | | |
| | 3.4852 | 27000 | 1.3471 | | |
| | 3.5498 | 27500 | 1.3418 | | |
| | 3.6143 | 28000 | 1.3421 | | |
| | 3.6788 | 28500 | 1.3375 | | |
| | 3.7434 | 29000 | 1.3366 | | |
| | 3.8079 | 29500 | 1.3411 | | |
| | 3.8725 | 30000 | 1.3298 | | |
| | 3.9370 | 30500 | 1.3269 | | |
| | 4.0015 | 31000 | 1.3250 | | |
| | 4.0661 | 31500 | 1.3134 | | |
| | 4.1306 | 32000 | 1.3080 | | |
| | 4.1952 | 32500 | 1.3140 | | |
| | 4.2597 | 33000 | 1.3134 | | |
| | 4.3243 | 33500 | 1.3108 | | |
| | 4.3888 | 34000 | 1.3218 | | |
| | 4.4533 | 34500 | 1.3068 | | |
| | 4.5179 | 35000 | 1.2998 | | |
| | 4.5824 | 35500 | 1.3115 | | |
| | 4.6470 | 36000 | 1.3002 | | |
| | 4.7115 | 36500 | 1.3084 | | |
| | 4.7760 | 37000 | 1.3090 | | |
| | 4.8406 | 37500 | 1.3027 | | |
| | 4.9051 | 38000 | 1.3122 | | |
| | 4.9697 | 38500 | 1.3104 | | |
| ### Training Time | |
| - **Training**: 25.3 minutes | |
| ### Framework Versions | |
| - Python: 3.14.5 | |
| - Sentence Transformers: 5.6.0 | |
| - Transformers: 5.12.1 | |
| - PyTorch: 2.12.0 | |
| - Accelerate: 1.14.0 | |
| - Datasets: 5.0.0 | |
| - Tokenizers: 0.22.2 | |
| ## Citation | |
| ### BibTeX | |
| #### Sentence Transformers | |
| ```bibtex | |
| @inproceedings{reimers-2019-sentence-bert, | |
| title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks", | |
| author = "Reimers, Nils and Gurevych, Iryna", | |
| booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing", | |
| month = "11", | |
| year = "2019", | |
| publisher = "Association for Computational Linguistics", | |
| url = "https://arxiv.org/abs/1908.10084", | |
| } | |
| ``` | |
| #### MultipleNegativesRankingLoss | |
| ```bibtex | |
| @misc{oord2019representationlearningcontrastivepredictive, | |
| title={Representation Learning with Contrastive Predictive Coding}, | |
| author={Aaron van den Oord and Yazhe Li and Oriol Vinyals}, | |
| year={2019}, | |
| eprint={1807.03748}, | |
| archivePrefix={arXiv}, | |
| primaryClass={cs.LG}, | |
| url={https://arxiv.org/abs/1807.03748}, | |
| } | |
| ``` | |
| <!-- | |
| ## 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.* | |
| --> |