Instructions to use gefgu/modernbert-schedule-aligner with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- sentence-transformers
How to use gefgu/modernbert-schedule-aligner with sentence-transformers:
from sentence_transformers import CrossEncoder model = CrossEncoder("gefgu/modernbert-schedule-aligner") query = "Which planet is known as the Red Planet?" passages = [ "Venus is often called Earth's twin because of its similar size and proximity.", "Mars, known for its reddish appearance, is often referred to as the Red Planet.", "Jupiter, the largest planet in our solar system, has a prominent red spot.", "Saturn, famous for its rings, is sometimes mistaken for the Red Planet." ] scores = model.predict([(query, passage) for passage in passages]) print(scores) - Notebooks
- Google Colab
- Kaggle
CrossEncoder based on nomic-ai/modernbert-embed-base
This is a Cross Encoder model finetuned from nomic-ai/modernbert-embed-base using the sentence-transformers library. It computes scores for pairs of texts, which can be used for text reranking and semantic search.
CityBehavEx
This checkpoint is the macro-schedule aligner (SW-CRP profile-to-diary matching) in
CityBehavEx, a scalable, empirically
validated LLM-assisted urban mobility simulation platform. It is served
alongside CityBehavEx's other CrossEncoder aligners by
scripts/serve_aligners.py and referenced directly by repo id in scenario
configs (e.g. schedule.alignment_model, activities.alignment_model,
profiles.coherence_alignment_model, profiles.ownership_alignment_model,
activities.poi_type_alignment_model).
If you use this model, please cite CityBehavEx:
@misc{santos2026citybehavex,
title = {CityBehavEx: A Scalable and Empirically Validated LLM-Assisted Urban Simulation Platform},
author = {Santos, Gustavo H. and Viana, Aline and Silva, Thiago H.},
year = {2026},
eprint = {2607.12086},
archivePrefix = {arXiv},
primaryClass = {cs.CL},
url = {https://arxiv.org/abs/2607.12086}
}
Model Details
Model Description
- Model Type: Cross Encoder
- Base model: nomic-ai/modernbert-embed-base
- Maximum Sequence Length: 8192 tokens
- Number of Output Labels: 1 label
- Supported Modality: Text
Model Sources
- Documentation: Sentence Transformers Documentation
- Documentation: Cross Encoder Documentation
- Repository: Sentence Transformers on GitHub
- Hugging Face: Cross Encoders on Hugging Face
Full Model Architecture
CrossEncoder(
(0): Transformer({'transformer_task': 'sequence-classification', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'logits'}}, 'module_output_name': 'scores', 'architecture': 'ModernBertForSequenceClassification'})
)
Usage
Direct Usage (Sentence Transformers)
First install the Sentence Transformers library:
pip install -U sentence-transformers
Then you can load this model and run inference.
from sentence_transformers import CrossEncoder
# Download from the 🤗 Hub
model = CrossEncoder("cross_encoder_model_id")
# Get scores for pairs of inputs
pairs = [
['Thomas is a 28-year-old male working as a professional. They have vocational or technical level education and good health. They live as: single parent. They own a car and a bike.', 'Stays at home the entire day (24 hours).'],
['Pauline is a 33-year-old female working as a professional. They have secondary or less level education and good health. They live as: couple without children. They own a car and a bike.', 'Spends 11 hours at home; work from 07:00 to 08:30, other from 08:30 to 09:00, work from 09:00 to 12:00, other from 13:00 to 14:00, work from 14:00 to 18:00, other from 19:00 to 22:00.'],
['Zoé is a 18-year-old female working as a service or sales worker. They have secondary or less level education and good health. They live as: living alone. They own a car and a bike.', 'Spends 19 hours at home; work from 07:00 to 08:30, other from 08:30 to 09:00, other from 09:00 to 09:30, other from 10:00 to 11:00, other from 11:30 to 13:00.'],
['Manon is a 37-year-old female working as a manager. They have secondary or less level education and fair health. They live as: living alone. They own a car and a bike.', 'Spends 20 hours at home; other from 08:30 to 12:00.'],
['Emma is a 35-year-old female working as a professional. They have secondary or less level education and good health. They live as: living with parents. They own a car and a bike.', 'Spends 15 hours at home; other from 09:00 to 10:30, other from 10:30 to 11:45, other from 11:45 to 13:00, other from 14:00 to 17:00, other from 18:00 to 20:00.'],
]
scores = model.predict(pairs)
print(scores)
# [0.2354 0.8564 0.561 0.3906 0.8158]
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'Thomas is a 28-year-old male working as a professional. They have vocational or technical level education and good health. They live as: single parent. They own a car and a bike.',
[
'Stays at home the entire day (24 hours).',
'Spends 11 hours at home; work from 07:00 to 08:30, other from 08:30 to 09:00, work from 09:00 to 12:00, other from 13:00 to 14:00, work from 14:00 to 18:00, other from 19:00 to 22:00.',
'Spends 19 hours at home; work from 07:00 to 08:30, other from 08:30 to 09:00, other from 09:00 to 09:30, other from 10:00 to 11:00, other from 11:30 to 13:00.',
'Spends 20 hours at home; other from 08:30 to 12:00.',
'Spends 15 hours at home; other from 09:00 to 10:30, other from 10:30 to 11:45, other from 11:45 to 13:00, other from 14:00 to 17:00, other from 18:00 to 20:00.',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
Training Details
Training Dataset
Unnamed Dataset
- Size: 1,000 training samples
- Columns:
sentence_0,sentence_1, andlabel - Approximate statistics based on the first 100 samples:
sentence_0 sentence_1 label type string string float modality text text details - min: 38 tokens
- mean: 43.87 tokens
- max: 50 tokens
- min: 13 tokens
- mean: 33.4 tokens
- max: 69 tokens
- min: 0.0
- mean: 0.58
- max: 1.0
- Samples:
sentence_0 sentence_1 label Thomas is a 28-year-old male working as a professional. They have vocational or technical level education and good health. They live as: single parent. They own a car and a bike.Stays at home the entire day (24 hours).0.2Pauline is a 33-year-old female working as a professional. They have secondary or less level education and good health. They live as: couple without children. They own a car and a bike.Spends 11 hours at home; work from 07:00 to 08:30, other from 08:30 to 09:00, work from 09:00 to 12:00, other from 13:00 to 14:00, work from 14:00 to 18:00, other from 19:00 to 22:00.0.85Zoé is a 18-year-old female working as a service or sales worker. They have secondary or less level education and good health. They live as: living alone. They own a car and a bike.Spends 19 hours at home; work from 07:00 to 08:30, other from 08:30 to 09:00, other from 09:00 to 09:30, other from 10:00 to 11:00, other from 11:30 to 13:00.0.3 - Loss:
BinaryCrossEntropyLosswith these parameters:{ "activation_fn": "torch.nn.modules.linear.Identity", "pos_weight": null }
Training Hyperparameters
Non-Default Hyperparameters
num_train_epochs: 1
All Hyperparameters
Click to expand
overwrite_output_dir: Falsedo_predict: Falseprediction_loss_only: Trueper_device_train_batch_size: 8per_device_eval_batch_size: 8per_gpu_train_batch_size: Noneper_gpu_eval_batch_size: Nonegradient_accumulation_steps: 1eval_accumulation_steps: Nonetorch_empty_cache_steps: Nonelearning_rate: 5e-05weight_decay: 0.0adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1num_train_epochs: 1max_steps: -1lr_scheduler_type: linearlr_scheduler_kwargs: Nonewarmup_ratio: 0.0warmup_steps: 0log_level: passivelog_level_replica: warninglog_on_each_node: Truelogging_nan_inf_filter: Truesave_safetensors: Truesave_on_each_node: Falsesave_only_model: Falserestore_callback_states_from_checkpoint: Falseno_cuda: Falseuse_cpu: Falseuse_mps_device: Falseseed: 42data_seed: Nonejit_mode_eval: Falsebf16: Falsefp16: Falsefp16_opt_level: O1half_precision_backend: autobf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonelocal_rank: 0ddp_backend: Nonetpu_num_cores: Nonetpu_metrics_debug: Falsedebug: []dataloader_drop_last: Falsedataloader_num_workers: 0dataloader_prefetch_factor: Nonepast_index: -1disable_tqdm: Falseremove_unused_columns: Truelabel_names: Noneload_best_model_at_end: Falseignore_data_skip: Falsefsdp: []fsdp_min_num_params: 0fsdp_config: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}fsdp_transformer_layer_cls_to_wrap: Noneaccelerator_config: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}parallelism_config: Nonedeepspeed: Nonelabel_smoothing_factor: 0.0optim: adamw_torchoptim_args: Noneadafactor: Falsegroup_by_length: Falselength_column_name: lengthproject: huggingfacetrackio_space_id: trackioddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falsedataloader_pin_memory: Truedataloader_persistent_workers: Falseskip_memory_metrics: Trueuse_legacy_prediction_loop: Falsepush_to_hub: Falseresume_from_checkpoint: Nonehub_model_id: Nonehub_strategy: every_savehub_private_repo: Nonehub_always_push: Falsehub_revision: Nonegradient_checkpointing: Falsegradient_checkpointing_kwargs: Noneinclude_inputs_for_metrics: Falseinclude_for_metrics: []eval_do_concat_batches: Truefp16_backend: autopush_to_hub_model_id: Nonepush_to_hub_organization: Nonemp_parameters:auto_find_batch_size: Falsefull_determinism: Falsetorchdynamo: Noneray_scope: lastddp_timeout: 1800torch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneinclude_tokens_per_second: Falseinclude_num_input_tokens_seen: noneftune_noise_alpha: Noneoptim_target_modules: Nonebatch_eval_metrics: Falseeval_on_start: Falseuse_liger_kernel: Falseliger_kernel_config: Noneeval_use_gather_object: Falseaverage_tokens_across_devices: Trueprompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}
Training Time
- Training: 1.6 minutes
Framework Versions
- Python: 3.12.13
- Sentence Transformers: 5.6.0
- Transformers: 4.57.6
- PyTorch: 2.6.0+cu124
- Accelerate: 1.14.0
- Datasets: 5.0.0
- Tokenizers: 0.22.2
Additional Resources
- Training and Finetuning Reranker Models with Sentence Transformers: the end-to-end guide for training or finetuning Cross Encoder (reranker) models.
- Multimodal Embedding & Reranker Models with Sentence Transformers: use text, image, audio, and video reranker models through the same API.
- Training and Finetuning Multimodal Embedding & Reranker Models with Sentence Transformers: training multimodal Cross Encoders.
Citation
BibTeX
Sentence Transformers
@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",
}
- Downloads last month
- 135
Model tree for gefgu/modernbert-schedule-aligner
Base model
answerdotai/ModernBERT-base