Skip to content

fix: docs for ContextMatch and CurriculumMatchModel. #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mattdl merged 1 commit into from
Jan 6, 2026
Merged

fix: docs for ContextMatch and CurriculumMatchModel. #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,12 +216,13 @@ lang_result_ci = summary["mean_per_language/en/f1_macro/ci_margin"]


### Models
| Model Name | Description | Fixed Classifier |
| Model Name | Description | Adaptive Targets |
| --- | --- | --- |
| BiEncoderModel | BiEncoder model using sentence-transformers for ranking and classification tasks. | ❌ |
| JobBERTModel | Job-Normalization BiEncoder from Techwolf: https://huggingface.co/TechWolf/JobBERT-v2 | ❌ |
| RndESCOClassificationModel | Random baseline for multi-label classification with random prediction head for ESCO. | ✅ |

| BiEncoderModel | BiEncoder model using sentence-transformers for ranking and classification tasks. | ✅ |
| JobBERTModel | Job-Normalization BiEncoder from Techwolf: https://huggingface.co/TechWolf/JobBERT-v2 | ✅ |
| ConTeXTMatchModel | ConTeXT-Skill-Extraction-base from Techwolf: https://huggingface.co/TechWolf/ConTeXT-Skill-Extraction-base | ✅ |
| CurriculumMatchModel | CurriculumMatch bi-encoder from Aleksandruz: https://huggingface.co/Aleksandruz/skillmatch-mpnet-curriculum-retriever | ✅ |
| RndESCOClassificationModel | Random baseline for multi-label classification with random prediction head for ESCO. | ❌ |


## Contributing
Expand Down
4 changes: 2 additions & 2 deletions examples/list_available_tasks_and_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def get_model_properties(model_class: type, registry_name: str, load_full: bool)
if load_full:
model = ModelRegistry.create(registry_name)
props["Model Name"] = model.name
props["Fixed Classifier"] = "✅" if model.classification_label_space is not None else "❌"
props["Adaptive Targets"] = "✅" if model.classification_label_space is None else "❌"
props["Description"] = model.description

return props
Expand Down Expand Up @@ -167,7 +167,7 @@ def format_markdown(df: pd.DataFrame) -> str:

# Models
model_cols = (
["Class Name", "Description", "Fixed Classifier"]
["Class Name", "Description", "Adaptive Targets"]
if load_models
else ["Class Name", "Description"]
)
Expand Down
2 changes: 2 additions & 0 deletions src/workrb/models/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
from workrb.models.base import ModelInterface
from workrb.models.bi_encoder import BiEncoderModel, ConTeXTMatchModel, JobBERTModel
from workrb.models.classification_model import RndESCOClassificationModel
from workrb.models.curriculum_encoder import CurriculumMatchModel

__all__ = [
"BiEncoderModel",
"ConTeXTMatchModel",
"CurriculumMatchModel",
"JobBERTModel",
"ModelInterface",
"RndESCOClassificationModel",
Expand Down