---
license: apache-2.0
tags:
- sentence-transformers
- modchembert
- cheminformatics
- smiles
- molecular-similarity
- feature-extraction
- dense
- generated_from_trainer
- dataset_size:19381001
- loss:Matryoshka2dLoss
- loss:MatryoshkaLoss
- loss:TanimotoSentLoss
base_model: Derify/ModChemBERT-IR-BASE
widget:
- source_sentence: COC(=O)c1sc(-c2ccc(C)cc2)c2c1NC(=O)C2(c1ccccc1)c1ccccc1
sentences:
- COC(=O)c1sc(Nc2ccc(Br)cn2)c2c1NC(=O)C2(c1ccccc1)c1ccccc1
- CC[NH+]1CCOC(C(NN)c2ccccc2Br)C1
- CC([NH2+]C(C)c1ccccc1)C(=O)P(C)C(C)(C)C
- source_sentence: O=C(C=Cc1ccccc1)CC(=O)c1ccccc1O
sentences:
- COCCN(NCc1c(C)n(C(C)=O)c2ccc(OC)cc12)c1nccs1
- CCN(CCC(N)=O)C(=O)c1ccc(=O)[nH]n1
- N=CCC(=Cc1ccccc1)C(=O)COc1ccccc1O
- source_sentence: COc1cccc(-c2sc3ccccc3c2C#N)c1
sentences:
- COCC(C)(C)c1cnnn1CCCI
- N#Cc1c(-c2cccc(CN)c2)sc2ccccc12
- COc1ccccc1NC(=O)c1cc(NCc2ccco2)cc[nH+]1
- source_sentence: Nc1nc(-c2ccccc2)c2nc(N)c(N)nc2n1
sentences:
- CC(C)CC1NC(=O)C(Cc2ccccc2)NC(=O)c2ccc(cc2)CN(C(=O)CC2CCOCC2)CCCCNC(=O)C(C)NC1=O
- O=Nc1cccc(OCCC(F)F)c1
- CCCCNCc1nc(N)nc2nc(N)c(N)nc12
- source_sentence: OCCCc1cc(F)cc(F)c1
sentences:
- CCC(C)C(=O)C1(C(NN)C(C)C)CCCC1
- Cc1[nH]c2c(C(N)=O)ccc(C(=O)N3CCCCC3)c2c1C
- Fc1cc(F)cc(-n2cc[o+]n2)c1
datasets:
- Derify/pubchem_10m_genmol_similarity
pipeline_tag: sentence-similarity
library_name: sentence-transformers
metrics:
- spearman
co2_eq_emissions:
emissions: 6350.153020081601
energy_consumed: 30.935740629629628
source: codecarbon
training_type: fine-tuning
on_cloud: false
cpu_model: AMD Ryzen 7 3700X 8-Core Processor
ram_total_size: 62.69887161254883
hours_used: 116.388
hardware_used: 2 x NVIDIA GeForce RTX 3090
model-index:
- name: 'ChemMRL: SMILES Matryoshka Representation Learning Embedding Transformer'
results:
- task:
type: semantic-similarity
name: Semantic Similarity
dataset:
name: pubchem 10m genmol similarity (validation)
type: pubchem_10m_genmol_similarity_validation
metrics:
- type: spearman
value: 0.989142152637452
name: Spearman
- task:
type: semantic-similarity
name: Semantic Similarity
dataset:
name: pubchem 10m genmol similarity (test)
type: pubchem_10m_genmol_similarity_test
metrics:
- type: spearman
value: 0.9891625268496924
name: Spearman
---
# ChemMRL: SMILES Matryoshka Representation Learning Embedding Transformer
This is a [Chem-MRL](https://github.com/emapco/chem-mrl) ([sentence-transformers](https://www.SBERT.net)) model finetuned from [Derify/ModChemBERT-IR-BASE](https://huggingface.co/Derify/ModChemBERT-IR-BASE) on the [pubchem_10m_genmol_similarity](https://huggingface.co/datasets/Derify/pubchem_10m_genmol_similarity) dataset. It maps SMILES to a 1024-dimensional dense vector space and can be used for molecular similarity, semantic search, database indexing, molecular classification, clustering, and more.
## Model Details
### Model Description
- **Model Type:** ChemMRL (Sentence Transformer)
- **Base model:** [Derify/ModChemBERT-IR-BASE](https://huggingface.co/Derify/ModChemBERT-IR-BASE)
- **Maximum Sequence Length:** 512 tokens
- **Output Dimensionality:** 1024 dimensions
- **Similarity Function:** Tanimoto
- **Training Dataset:**
- [pubchem_10m_genmol_similarity](https://huggingface.co/datasets/Derify/pubchem_10m_genmol_similarity)
- **License:** apache-2.0
### Model Sources
- **Repository:** [Chem-MRL on GitHub](https://github.com/emapco/chem-mrl)
- **Demo App Repository:** [Chem-MRL-demo on GitHub](https://github.com/emapco/chem-mrl-demo)
### Full Model Architecture
```
SentenceTransformer(
(0): Transformer({'max_seq_length': 512, 'do_lower_case': False, 'architecture': 'ModChemBertModel'})
(1): Pooling({'word_embedding_dimension': 1024, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
(2): Normalize()
)
```
## Usage
### Direct Usage (Chem-MRL)
First install the Chem-MRL library:
```bash
pip install -U chem-mrl>=0.7.3
pip install -U "transformers>=4.56.1,<5.0.0"
```
Then you can load this model and run inference.
```python
from chem_mrl import ChemMRL
# Download from the 🤗 Hub
model = ChemMRL(
"Derify/ChemMRL",
trust_remote_code=True,
model_kwargs={"torch_dtype": "bfloat16"},
)
# Run inference
sentences = [
'OCCCc1cc(F)cc(F)c1',
'Fc1cc(F)cc(-n2cc[o+]n2)c1',
'CCC(C)C(=O)C1(C(NN)C(C)C)CCCC1',
]
embeddings = model.backbone.encode(sentences)
print(embeddings.shape)
# [3, 1024]
# Get the similarity scores for the embeddings
similarities = model.backbone.similarity(embeddings, embeddings)
print(similarities)
# tensor([[1.0000, 0.3876, 0.0078],
# [0.3876, 1.0000, 0.0028],
# [0.0078, 0.0028, 1.0000]])
```
### Direct Usage (Sentence Transformers)
Click to see the direct usage in 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(
"Derify/ChemMRL",
# SentenceTransformer doesn't support tanimoto similarity natively so we set a different similarity function here
similarity_fn_name="cosine",
trust_remote_code=True,
model_kwargs={"torch_dtype": "bfloat16"},
)
# Run inference
sentences = [
'OCCCc1cc(F)cc(F)c1',
'Fc1cc(F)cc(-n2cc[o+]n2)c1',
'CCC(C)C(=O)C1(C(NN)C(C)C)CCCC1',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 1024]
# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[1.0000, 0.5587, 0.0155],
# [0.5587, 1.0000, 0.0055],
# [0.0155, 0.0055, 1.0000]])
```
chem_mrl.evaluation.EmbeddingSimilarityEvaluator.EmbeddingSimilarityEvaluator with these parameters:
```json
{
"precision": "float32"
}
```
| Split | Metric | Value |
| :------------- | :----------- | :---------- |
| **validation** | **spearman** | **0.98914** |
| **test** | **spearman** | **0.98916** |
## Training Details
### Training Dataset
#### pubchem_10m_genmol_similarity
* Dataset: [pubchem_10m_genmol_similarity](https://huggingface.co/datasets/Derify/pubchem_10m_genmol_similarity) at [9aec8fd](https://huggingface.co/datasets/Derify/pubchem_10m_genmol_similarity/tree/9aec8fd3ed70c21a0e39a3164830879a9929b052)
* Size: 19,381,001 training samples
* Columns: smiles_a, smiles_b, and label
* Approximate statistics based on the first 1000 samples:
| | smiles_a | smiles_b | label |
| :------ | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------- | :-------------------------------------------------------------- |
| type | string | string | float |
| details |
COc1ccc(NC(=O)C2CC\[NH+\](C(C)C(=O)Nc3ccc(C(=O)Nc4ccc(F)c(F)c4)cc3C)CC2)cc1NC(=O)C1CCCCC1 | Cc1cc(C(=O)Nc2ccc(F)c(F)c2)ccc1NC(=O)C(C)\[NH+\]1CCC(C(=O)Nc2cccc(NC(=O)C3CCCCC3)c2)CC1 | 0.8495575189590454 |
| OCCN1CC\[NH+\](Cc2ccccc2OC2CC2)CC1 | OCCN1CC\[NH+\](Cc2ccccc2On2cccn2)CC1 | 0.6615384817123413 |
| CC1CN(C(=O)C2CC\[NH+\](Cc3cccc(C(N)=O)c3)CC2)CC(C)O1 | CC1CN(C(=O)C2CC\[NH+\](Cc3ccccc3)CC2)CC(C)O1 | 0.7123287916183472 |
* Loss: [Matryoshka2dLoss](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#matryoshka2dloss) with these parameters:
```json
{
"loss": "TanimotoSentLoss",
"n_layers_per_step": -1,
"last_layer_weight": 2.0,
"prior_layers_weight": 1.0,
"kl_div_weight": 0.0,
"kl_temperature": 0.0,
"matryoshka_dims": [
1024,
512,
256,
128,
64,
32,
16,
8
],
"matryoshka_weights": [
1,
1,
1,
1,
1,
1,
1,
1
],
"n_dims_per_step": -1
}
```
### Evaluation Dataset
#### pubchem_10m_genmol_similarity
* Dataset: [pubchem_10m_genmol_similarity](https://huggingface.co/datasets/Derify/pubchem_10m_genmol_similarity) at [9aec8fd](https://huggingface.co/datasets/Derify/pubchem_10m_genmol_similarity/tree/9aec8fd3ed70c21a0e39a3164830879a9929b052)
* Size: 1,080,394 evaluation samples
* Columns: smiles_a, smiles_b, and label
* Approximate statistics based on the first 1000 samples:
| | smiles_a | smiles_b | label |
| :------ | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------- | :------------------------------------------------------------- |
| type | string | string | float |
| details | N#CCCN(Cc1cnc(N)cn1)C1CC1 | N#CCCN(Cc1cnc(N)cn1)C1CCCC1 | 0.8600000143051147 |
| N#CCCN(Cc1cnc(N)cn1)C1CC1 | N#CCCN(Cc1cnc(N)cn1)C1CCOCC1 | 0.7962962985038757 |
| N#CCCN(Cc1cnc(N)cn1)C1CC1 | N#CCCN(Cc1cnc(N)cn1)CC(F)F | 0.5517241358757019 |
* Loss: [Matryoshka2dLoss](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#matryoshka2dloss) with these parameters:
```json
{
"loss": "TanimotoSentLoss",
"n_layers_per_step": -1,
"last_layer_weight": 2.0,
"prior_layers_weight": 1.0,
"kl_div_weight": 0.0,
"kl_temperature": 0.0,
"matryoshka_dims": [
1024,
512,
256,
128,
64,
32,
16,
8
],
"matryoshka_weights": [
1,
1,
1,
1,
1,
1,
1,
1
],
"n_dims_per_step": -1
}
```
### Training Hyperparameters
#### Non-Default Hyperparameters
- `eval_strategy`: steps
- `per_device_train_batch_size`: 192
- `per_device_eval_batch_size`: 512
- `learning_rate`: 8e-06
- `weight_decay`: 1e-05
- `max_grad_norm`: None
- `lr_scheduler_type`: warmup_stable_decay
- `lr_scheduler_kwargs`: {'num_decay_steps': 100943, 'warmup_type': 'linear', 'decay_type': '1-sqrt'}
- `warmup_steps`: 100943
- `data_seed`: 42
- `bf16`: True
- `bf16_full_eval`: True
- `tf32`: True
- `optim`: stable_adamw
- `optim_args`: decouple_lr=True,max_lr=8.0e-6
- `gradient_checkpointing`: True
- `eval_on_start`: True
#### All Hyperparameters