
# {MODEL_NAME}

This is a [sentence-transformers](https://www.SBERT.net) model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.

<!--- Describe your model here -->
This model is trained on a dataset containing questions for specialists in three areas: 
neurology, psychiatry, psychotherapy (psychology). 
It quite well determines which of these specialties the question (described problem) belongs to. 
The model "understands" the text in Russian, Ukrainian and English languages best of all, 
but is not limited only by it.

If you want to experiment with this model, use the dictionary:
```
dict = {0:'neurology', 1:'psychiatry', 2:'psychotherapy'} 
```
and also this simple code:
```
preds = model(["Bla-bla-bla"]) 

dict.get(int(str(list(preds))[1:-1]))
```

```
Warning: This model cannot be used for medical diagnosis and is not a substitute for a physician!
```
## Usage (Sentence-Transformers)

Using this model becomes easy when you have [sentence-transformers](https://www.SBERT.net) installed:

```
pip install -U sentence-transformers
```

Then you can use the model like this:

```python
from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]

model = SentenceTransformer('{MODEL_NAME}')
embeddings = model.encode(sentences)
print(embeddings)
```



## Usage (HuggingFace Transformers)
Without [sentence-transformers](https://www.SBERT.net), you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings.

```python
from transformers import AutoTokenizer, AutoModel
import torch


#Mean Pooling - Take attention mask into account for correct averaging
def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output[0] #First element of model_output contains all token embeddings
    input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
    return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)


# Sentences we want sentence embeddings for
sentences = ['This is an example sentence', 'Each sentence is converted']

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
model = AutoModel.from_pretrained('{MODEL_NAME}')

# Tokenize sentences
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')

# Compute token embeddings
with torch.no_grad():
    model_output = model(**encoded_input)

# Perform pooling. In this case, mean pooling.
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])

print("Sentence embeddings:")
print(sentence_embeddings)
```



## Evaluation Results

<!--- Describe how your model was evaluated -->

For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: [https://seb.sbert.net](https://seb.sbert.net?model_name={MODEL_NAME})


## Training
The model was trained with the parameters:

**DataLoader**:

`torch.utils.data.dataloader.DataLoader` of length 120 with parameters:
```
{'batch_size': 16, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}
```

**Loss**:

`sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss` 

Parameters of the fit()-Method:
```
{
    "epochs": 2,
    "evaluation_steps": 0,
    "evaluator": "NoneType",
    "max_grad_norm": 1,
    "optimizer_class": "<class 'torch.optim.adamw.AdamW'>",
    "optimizer_params": {
        "lr": 2e-05
    },
    "scheduler": "WarmupLinear",
    "steps_per_epoch": 240,
    "warmup_steps": 24,
    "weight_decay": 0.01
}
```


## Full Model Architecture
```
SentenceTransformer(
  (0): Transformer({'max_seq_length': 128, 'do_lower_case': False}) with Transformer model: XLMRobertaModel 
  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
)
```

## Citing & Authors
```
@misc{Uaritm,
      title={SetFit: Classification of medical texts}, 
      author={Vitaliy Ostashko},
      year={2022},
      url={https://esemi.org}
}

<!--- Describe where people can find more information -->
{"language": ["uk", "ru", "en", "multilingual"], "license": "creativeml-openrail-m", "tags": ["sentence-transformers", "feature-extraction", "sentence-similarity", "transformers"], "pipeline_tag": "sentence-similarity"}
sentence-transformers pytorch xlm-roberta feature-extraction sentence-similarity transformers uk ru en multilingual license:creativeml-openrail-m endpoints_compatible region:us
TAGS
#sentence-transformers #pytorch #xlm-roberta #feature-extraction #sentence-similarity #transformers #uk #ru #en #multilingual #license-creativeml-openrail-m #endpoints_compatible #region-us 


# {MODEL_NAME}

This is a sentence-transformers model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.


This model is trained on a dataset containing questions for specialists in three areas: 
neurology, psychiatry, psychotherapy (psychology). 
It quite well determines which of these specialties the question (described problem) belongs to. 
The model "understands" the text in Russian, Ukrainian and English languages best of all, 
but is not limited only by it.

If you want to experiment with this model, use the dictionary:

and also this simple code:



## Usage (Sentence-Transformers)

Using this model becomes easy when you have sentence-transformers installed:



Then you can use the model like this:





## Usage (HuggingFace Transformers)
Without sentence-transformers, you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings.





## Evaluation Results



For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: URL


## Training
The model was trained with the parameters:

DataLoader:

'URL.dataloader.DataLoader' of length 120 with parameters:


Loss:

'sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss' 

Parameters of the fit()-Method:



## Full Model Architecture


## Citing & Authors
'''
@misc{Uaritm,
      title={SetFit: Classification of medical texts}, 
      author={Vitaliy Ostashko},
      year={2022},
      url={URL}
}


# {MODEL_NAME}

This is a sentence-transformers model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.


This model is trained on a dataset containing questions for specialists in three areas: 
neurology, psychiatry, psychotherapy (psychology). 
It quite well determines which of these specialties the question (described problem) belongs to. 
The model "understands" the text in Russian, Ukrainian and English languages best of all, 
but is not limited only by it.

If you want to experiment with this model, use the dictionary:

and also this simple code: ## Usage (Sentence-Transformers)

Using this model becomes easy when you have sentence-transformers installed:



Then you can use the model like this: ## Usage (HuggingFace Transformers)
Without sentence-transformers, you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings. ## Evaluation Results



For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: URL ## Training
The model was trained with the parameters:

DataLoader:

'URL.dataloader.DataLoader' of length 120 with parameters:


Loss:

'sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss' 

Parameters of the fit()-Method: ## Full Model Architecture ## Citing & Authors
'''
@misc{Uaritm,
      title={SetFit: Classification of medical texts}, 
      author={Vitaliy Ostashko},
      year={2022},
      url={URL}
}
TAGS
#sentence-transformers #pytorch #xlm-roberta #feature-extraction #sentence-similarity #transformers #uk #ru #en #multilingual #license-creativeml-openrail-m #endpoints_compatible #region-us 
 # {MODEL_NAME}

This is a sentence-transformers model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.


This model is trained on a dataset containing questions for specialists in three areas: 
neurology, psychiatry, psychotherapy (psychology). 
It quite well determines which of these specialties the question (described problem) belongs to. 
The model "understands" the text in Russian, Ukrainian and English languages best of all, 
but is not limited only by it.

If you want to experiment with this model, use the dictionary:

and also this simple code: ## Usage (Sentence-Transformers)

Using this model becomes easy when you have sentence-transformers installed:



Then you can use the model like this: ## Usage (HuggingFace Transformers)
Without sentence-transformers, you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings. ## Evaluation Results



For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: URL ## Training
The model was trained with the parameters:

DataLoader:

'URL.dataloader.DataLoader' of length 120 with parameters:


Loss:

'sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss' 

Parameters of the fit()-Method: ## Full Model Architecture ## Citing & Authors
'''
@misc{Uaritm,
      title={SetFit: Classification of medical texts}, 
      author={Vitaliy Ostashko},
      year={2022},
      url={URL}
}
TAGS
#sentence-transformers #pytorch #xlm-roberta #feature-extraction #sentence-similarity #transformers #uk #ru #en #multilingual #license-creativeml-openrail-m #endpoints_compatible #region-us 
# {MODEL_NAME}

This is a sentence-transformers model: It maps sentences & paragraphs to a 768 dimensional dense vector space and can be used for tasks like clustering or semantic search.


This model is trained on a dataset containing questions for specialists in three areas: 
neurology, psychiatry, psychotherapy (psychology). 
It quite well determines which of these specialties the question (described problem) belongs to. 
The model "understands" the text in Russian, Ukrainian and English languages best of all, 
but is not limited only by it.

If you want to experiment with this model, use the dictionary:

and also this simple code:## Usage (Sentence-Transformers)

Using this model becomes easy when you have sentence-transformers installed:



Then you can use the model like this:## Usage (HuggingFace Transformers)
Without sentence-transformers, you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings.## Evaluation Results



For an automated evaluation of this model, see the *Sentence Embeddings Benchmark*: URL## Training
The model was trained with the parameters:

DataLoader:

'URL.dataloader.DataLoader' of length 120 with parameters:


Loss:

'sentence_transformers.losses.CosineSimilarityLoss.CosineSimilarityLoss' 

Parameters of the fit()-Method:## Full Model Architecture## Citing & Authors
'''
@misc{Uaritm,
      title={SetFit: Classification of medical texts}, 
      author={Vitaliy Ostashko},
      year={2022},
      url={URL}
}