Create README.md

README.md

@@ -0,0 +1,61 @@
+---
+license: apache-2.0
+language:
+- pt
+pipeline_tag: text-classification
+library_name: transformers
+widget:
+- text: |
+    As palavras "feliz" e "alegre" são sinônimos?'
+tags:
+- portuguese
+- bert
+- sinônimos
+model-index:
+- name: simnonym
+  results:
+  - task:
+      type: text-generation
+    dataset:
+      type: lrds-code/sym-pair
+      name: sym-pair
+      config: pt
+      split: validation
+    metrics:
+    - type: Accuracy
+      value: 91.07
+datasets:
+- lrds-code/sym-pair
+---
+
+<hr>
+
+# Simnonym
+
+Simnonym é um classificador BERT-based de sinônimos da língua portuguesa.
+
+## Entrada
+
+A entrada deve sempre seguir o template do prompt 
+ - **'As palavras "{}" e "{}" são sinônimos?'**
+
+## Dados de Treinamento
+
+O modelo foi treinado e avaliado no conjunto de dados [Sym-Pair](lrds-code/sym-pair).
+
+Sym-Pair possui aproximadamente 1.5 milhões de sentenças que comparam pares de palavras. Esses pares podem ser sinônimos ou não.
+
+Sym-Pair é composto por:
+- Pares de sinônimos e antônimos obtidos de dois datasets ([DicSin](https://github.com/fititnt/DicSin-dicionario-sinonimos-portugues-brasileiro) e [Portuguese Brazilian Synonyms](https://github.com/stavarengo/portuguese-brazilian-synonyms)).
+- Pares aleatórios de palavras não relacionadas. Obtidos através de combinação aleatória do conjunto de sinônimos.
+
+## Descrição do Modelo
+
+- **Desenvolvido por:** [Leonardo Souza](https://huggingface.co/lrds-code)
+- **Tipo do modelo:** BERT
+- **Licença:** Apache 2.0
+- **Fine-tunado do modelo:** [BERTimbau Base](https://huggingface.co/neuralmind/bert-base-portuguese-cased)
+
+## Como Usar
+
+TODO