---
language:
- yrl
pipeline_tag: fill-mask
license: cc-by-4.0
widget:
- text: "Se aría [MASK] retana."
- text: "Aé urikú takuwa yawé [MASK] ti usú upinaitika."
- text: "Ũbawa puxuwera wa asui [MASK] resé"
---
# Canarim-Bert-Nheengatu
## Introdução
Canarim-Bert-Nheengatu é um modelo BERT pré-treinado para o idioma Nheengatu, uma língua indígena falada no Brasil. O modelo foi treinado com o objetivo de ser utilizado em tarefas de PNL (Processamento de Linguagem Natural) para o idioma Nheengatu, ajudando assim a formenção de recursos para o idioma.
## Nheengatu
O nheengatu, também conhecido como tupi moderno e Língua Geral Amazônica, entre outras designações, é uma das dezenas de línguas indígenas brasileiras ainda vivas. O termo nheengatu surgiu por volta de meados do século XIX, significando originalmente "língua boa", resultado da composição do substantivo nheenga 'língua' e do adjetivo katú 'bom'. No padrão ISO 639-3, representa-se pelo código `yrl`, derivado de yeral (geral em português), um dos termos com que é designado em espanhol.
O estudo do nheengatu reveste-se de grande importância histórica, uma vez que foi, durante dois séculos e meio, nas palavras de José Ribamar Bessa Freire, “a principal língua da Amazônia”, posição que perderia para o português apenas na segunda metade do século XIX. É talvez a única língua indígena brasileira cujo desenvolvimento ao longo de mais de quatro séculos pode ser acompanhado por meio de textos que documentam os seus vários estágios de evolução. (Fonte: [CompLin](https://github.com/CompLin/nheengatu/blob/main/nheengatu.md))
## Dados de Treinamento
Para treinar o modelo foi feita uma extensa coleta de dados de textos em Nheengatu, que foram extraídos de diversas fontes, como livros, artigos, sites, etc. Os dados foram limpos e preparados para o treinamento do modelo. Abaixo segue uma tabela com todas as fontes que foram utilizadas para o treinamento do modelo.
Referência (ABNT)
```
AMORIM, DE. Lendas em nheengatu e em português. [s.l.] Fundo Editorial-ACA, 1987.
ARGOLO, W. Colonização e língua geral: o caso do sul da bahia. Papia, v. 23, p. 75–96, 2013.
ÁVILA, M. T.; TREVISAN, R. G. Jaguanhenhém: um estudo sobre a linguagem do iauaretê. Magma, v. 22, p. 297–335, 2015.
AYROSA, P. Diccionario portuguez-brasiliano e brasiliano-portuguez. [s.l.] Imprensa official do estado, 1934.
AYROSA, P. Orações e diálogos da doutrina cristã na língua brasílica: Mss. do séc. XVIII. [s.l.] Universidade de São Paulo, Faculdade de Filosofia, Ciências e Letras, 1950.
AYROSA, P. Apontamentos para a bibliografia da língua tupi-guarani. [s.l.] Universidade de São Paulo, 1954.
BARROS, C.; LESSA, A. L. Dicionário da língua geral do brasil. [s.l.] MPEG, 2015.
BASTOS, A. A pantofagia, ou, As estranhas práticas alimentares na selva: estudo na região amazônica. [s.l.] Companhia Editora Nacional, 1987.
BORGES, L. C. A lingua geral amazonica : aspectos de sua fonemica. Disponível em: . Acesso em: 29 dez. 2023.
BRASIL. [CONSTITUIÇÃO (1988)]. “MUNDU SA TURUSU” WAÁ ŨBÊUWA MAYÉ MÍRA ITÁ UIKÚ ARÃMA PURÃGA IKÉ BRAZIU UPÉ. Brasília, DF: Presidente Da República, 19 jul. 2023. Disponível em: . Acesso em: 29 dez. 2023.
CÂNDIDA, M. A relação entre manuscritos e impressos em tupi como forma de estudo da política linguística jesuítica no século XVIII na Amazônia. Revista Letras, v. 61, 2003.
CÂNDIDA, M.; MARQUES, M. Passagens do livro “Itinerário para Párocos de Índios”, de Peña Montenegro (1668), em um confessionário jesuítico setecentista da Amazônia. Boletim do Museu Paraense Emílio Goeldi. Ciências Humanas, v. 5, n. 3, p. 669–679, 1 dez. 2010.
COSTA, A. Doutrina christã destinada aos naturaes do Amazonas em nhihingatu: com tradução portugueza em face. [s.l.] Pacheco Silva, 1898.
DA CRUZ, A. O Estatuto das Fricativas na Língua Geral Amazônica: IX Encontro dos Alunos de Pós-Graduação em Lingüística da Universidade de São Paulo. Afinal, o que, nós, fazemos? Seleção de textos proferidos durante o IX Encontro dos Alunos de Pós-Graduação em Lingüística da Universidade de São Paulo., 2007.
DA CRUZ, A. Fonologia e gramática do nheengatú. [s.l.] LOT, 2011.
DE FARIA, F. R. C. Compendio da lingua brazilica para uzo dos que a ella se quizerem dedicar. [s.l.] Typ. de Santos & Filhos, 1858.
DE MAGALHÃES, C. O selvagem: I. Curso da lingua geral segundo Ollendorf, comprehendendo o texto original de lendas tupìs. II. Origens, costumes, região selvagem, methodo a empregar para amansalos por intermedio das colonias militares e do interprete militar. [s.l.] Livrària Popular, 1876.
ECKART, A.; PLATZMANN, J. Anselmi eckarti specimen linguae brasilicae vulgaris. [s.l.] B.G. Teubner, 1890.
EDELWEISS, F. G. Estudos tupis e tupi-guaranis: confrontos e revisões. [s.l.] Livraria Brasiliana Editôra, 1969.
ERMANNO, S. Leggenda dell’Jurupary. Bolletino Della Societá Geografica Italiana, v. 3, p. 659–689, 1890.
FERNANDES, A. Grammatica tupy. [s.l.] Livraria Araripe, 1924.
FREIRE, J. R. B.; ROSA, M. C. Línguas Gerais: política linguística e Catequese na América do Sul no período colonial. [s.l.] Editora da Universidade do Estado do Rio de Janeiro, 2003.
HARTT, C. F. Notes on the Lingoa geral or modern Tupí of the Amazonas. Boston: [s.n.].
HARTT, C. F. Contribuicões para a ethnologia do valle do Amazonas. [s.l.] Typ. e lith. economica, de Machado & c., 1885.
HARTT, C. F.; BIBLIOTECA NACIONAL (BRAZIL). Notas sobre a língua geral, ou tupí moderno do Amazonas. [s.l.] Serviço gráfico do Ministério da educação e saude, 1938.
ISHIKAWA, N. K.; MORGANS, S. Brilhos na floresta. [s.l.] Selene Morgans, 2019.
KITTIYA, L. M. Conversing in colony: the Brasílica and the Vulgar in Portuguese America, 1500–1759. [s.l.] The Johns Hopkins University, 2006.
MASUCCI, O. Dicionário tupi portugués e vice-versa: com um dicionário de topográficos. [s.l.] Brasilivros, 1979.
MELLO, O. Dicionário tupi (nheengatu) português e vice-versa: comum dicionário de rimas tupi. [s.l.] F. Masucci, 1967.
MICHAELE, F. A. S. Manual de conversação de lingua tupi: 1a. série, 20 lições. [s.l.] Centro Cultural “Euclides da Cunha”, 1951.
MOORE, D.; FACUNDES, S.; PIRES, N. Nheengatu (Língua Geral Amazônica), its History, and the Effects of Language Contact. escholarship.org, 1994.
MULLER, J. C. et al. Dicionário de língua geral amazônica: 1a parte: Português–Língua geral - 2a parte: Língua Geral–Português. [s.l.] Universitat Potsdam, 2019.
NIMUENDAJÚ, C.; ATHIAS, R. Reconhecimento dos rios içána, ayarí e uaupés: apontamentos linguísticos e ensaio fotográfico. [s.l.] Museo do Indio FUNAI, 2015.
OLIVEIRA, R. L. G. DE. Natureza e direções das mudanças lexicais ocorridas na língua geral Amazônica do século XVII. icts.unb.br, 11 out. 2010.
ORICO, O. Mitos ameríndios e crendices amazônicas. [s.l.] Civilização Brasileira, 1975.
PLATZMANN, J. O diccionario anonymo da lingua geral do Brasil publicado de novo com o seu reverso por Julio Platzmann. [s.l.] B.G. Teubner, 1896.
QUEIXALÓS, F.; GOMES, D. M. O sintagma nominal em línguas amazônicas. [s.l.] Pontes, 2016.
RODRIGUES, A. D.; SUELLY, A. A contribution to the linguistic history of the língua geral amazônica. Alfa: Revista de Linguística (São José do Rio Preto), v. 55, p. 613–639, 2011.
RODRIGUES, J. B. Vocabulario indigena com a orthographia correcta: (complemento da Poranduba amazonense). [s.l.] Bibliotheca Nacional, 1893.
RODRIGUES, J. B. Mbaé kaá tapyiyetá enoyndaua ou A botanica ea nomenclatura indigena. [s.l.] Imprensa Nacional, 1905.
SILVA, DA; DE, C. Discoteca etno-linguístico-musical das tribos dos rios uaupés, içana e cauaburi. [s.l.] Centro de Pesquisas de Iauareté, 1961.
VERÍSSIMO, J. As populações Indigenas e Mestiças da Amazonia: linguagem, crenças e costumes. Rio de Janeiro: [s.n.].
VERÍSSIMO, J. Estudos amazônicos. [s.l.] Universidade Federal do Pará, 1970. v. 1.
```
## Modelos Disponiveis
| Modelo | Arquitetura | #Layers | #Params |
| ------ | ----------- | ------- | ------- |
| [Canarim-Bert-Nheengatu](https://huggingface.co/dominguesm/canarim-bert-nheengatu) | Bert | 12 | 110M |
## Como usar
```python
from transformers import pipeline
pipe = pipeline('fill-mask', "dominguesm/canarim-bert-nheengatu")
# ptbr: Ele tinha febre, por isso não foi pescar.
# yrl: Aé urikú takuwa yawé resewara ti usú upinaitika.
pipe('Aé urikú takuwa yawé [MASK] ti usú upinaitika.')
# [{'score': 0.41232067346572876,
# 'token': 460,
# 'token_str': 'tẽ',
# 'sequence': 'Aé urikú takuwa yawé tẽ ti usú upinaitika.'},
# {'score': 0.1178387925028801,
# 'token': 665,
# 'token_str': 'resewara',
# 'sequence': 'Aé urikú takuwa yawé resewara ti usú upinaitika.'},
# {'score': 0.029453271999955177,
# 'token': 2168,
# 'token_str': 'artigu',
# 'sequence': 'Aé urikú takuwa yawé artigu ti usú upinaitika.'},
# {'score': 0.027277836576104164,
# 'token': 669,
# 'token_str': 'sikuyaára',
# 'sequence': 'Aé urikú takuwa yawé sikuyaára ti usú upinaitika.'},
# {'score': 0.020948367193341255,
# 'token': 642,
# 'token_str': 'akayu',
# 'sequence': 'Aé urikú takuwa yawé akayu ti usú upinaitika.'}]
```
## Desempenho em Tarefas de PNL - POSTAG
O modelo foi avaliado na tarefa de classificação de tokens (POSTAG), utilizando o dataset [UD_Nheengatu-CompLin](https://github.com/UniversalDependencies/UD_Nheengatu-CompLin/), abaixo segue o resultado da avaliação.
```
precision recall f1-score support
ADJ 0.7895 0.6522 0.7143 23
ADP 0.9355 0.9158 0.9255 95
ADV 0.8261 0.8172 0.8216 93
AUX 0.9444 0.9189 0.9315 37
CCONJ 0.7778 0.8750 0.8235 8
DET 0.8776 0.9149 0.8958 47
INTJ 0.5000 0.5000 0.5000 4
NOUN 0.9257 0.9222 0.9239 270
NUM 1.0000 0.6667 0.8000 6
PART 0.9775 0.9062 0.9405 96
PRON 0.9568 1.0000 0.9779 155
PROPN 0.6429 0.4286 0.5143 21
PUNCT 0.9963 1.0000 0.9981 267
SCONJ 0.8000 0.7500 0.7742 32
VERB 0.8651 0.9347 0.8986 199
micro avg 0.9202 0.9202 0.9202 1353
macro avg 0.8543 0.8135 0.8293 1353
weighted avg 0.9191 0.9202 0.9187 1353
```
Mais detalhes sobre o modelo e a avaliação podem ser encontrados no repositorio [dominguesm/canarim-bert-postag-nheengatu](https://huggingface.co/dominguesm/canarim-bert-postag-nheengatu).