Create README.md

README.md

@@ -0,0 +1,45 @@
+---
+language: "pt"
+---
+
+# CardioBERTpt - Portuguese Transformer-based Models for Clinical Language Representation in Cardiology
+
+The [BioBERTpt - A Portuguese Neural Language Model for Clinical Named Entity Recognition](https://www.aclweb.org/anthology/2020.clinicalnlp-1.7/) paper contains clinical and biomedical BERT-based models for Portuguese Language, initialized with BERT-Multilingual-Cased & trained on clinical notes and biomedical literature. 
+
+This model card describes the BioBERTpt(bio) model, a biomedical version of BioBERTpt, trained on Portuguese biomedical literature from scientific papers from Pubmed and Scielo. 
+
+## How to use the model
+
+Load the model via the transformers library:
+```
+from transformers import AutoTokenizer, AutoModel
+tokenizer = AutoTokenizer.from_pretrained("pucpr-br/cardiobertpt")
+model = AutoModel.from_pretrained("pucpr-br/cardiobertpt")
+```
+
+## More Information
+
+Refer to the original paper, [CardioBERTpt - Portuguese Transformer-based Models for Clinical Language Representation in Cardiology](https://ieeexplore.ieee.org/document/10178779/) for additional details and performance on Portuguese NER tasks.
+
+## Acknowledgements
+
+This study was financed in part by the Coordenação de Aperfeiçoamento de Pessoal de Nível Superior - Brasil (CAPES) - Finance Code 001, and by Foxconn Brazil and Zerbini Foundation as part of the research project Machine Learning in Cardiovascular Medicine.
+
+## Citation
+
+```
+@INPROCEEDINGS{10178779,
+  author={Schneider, Elisa Terumi Rubel and Gumiel, Yohan Bonescki and de Souza, João Vitor Andrioli and Mie Mukai, Lilian and Emanuel Silva e Oliveira, Lucas and de Sa Rebelo, Marina and Antonio Gutierrez, Marco and Eduardo Krieger, Jose and Teodoro, Douglas and Moro, Claudia and Paraiso, Emerson Cabrera},
+  booktitle={2023 IEEE 36th International Symposium on Computer-Based Medical Systems (CBMS)}, 
+  title={CardioBERTpt: Transformer-based Models for Cardiology Language Representation in Portuguese}, 
+  year={2023},
+  volume={},
+  number={},
+  pages={378-381},
+  doi={10.1109/CBMS58004.2023.00247}}
+}
+```
+
+## Questions?
+
+Post a Github issue on the [CardioBERTpt repo](https://github.com/HAILab-PUCPR/CardioBERTpt).