maritalk

Code and documentation for the MariTalk API

https://github.com/maritaca-ai/maritalk-api

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (5.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Code and documentation for the MariTalk API

Basic Info
  • Host: GitHub
  • Owner: maritaca-ai
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage: https://docs.maritaca.ai
  • Size: 8.96 MB
Statistics
  • Stars: 296
  • Watchers: 15
  • Forks: 16
  • Open Issues: 7
  • Releases: 0
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README-Local.md

MariTalk Local

Conteúdo

Introdução

Além da API da Maritaca AI, é possível executar a MariTalk localmente em duas versões, small e large.

Para fazer download dos modelos e obter uma licença, consulte esta seção

O executável funciona em máquinas Linux de 64 bits com uma ou mais GPUs Nvidia. Veja as recomendações mínimas abaixo e as GPUs testadas até agora:

| Modelo | Memória Mínima GPU | Memória Mínima CPU | GPUs Testadas | |--|--|--|--| | Sabiá-2 Small | 24GB | 20GB | A100, A10, A6000, L4 | | Sabiá-2 Medium | 70GB | 70GB | 2xA100 40GB, 2xA6000 48GB |

A memória de GPU pode ser distribuída em vários dispositivos. Por exemplo, para o modelo Medium, que requer pelo menos 70GB, pode-se utilizar uma A100 de 80 GB, duas GPUs A100 de 40 GB ou quatro A10 de 24 GB.

As GPUs compatíveis são aquelas com capacidade de computação 8.0+ (nvidia-smi --query-gpu=compute_cap --format=csv).

A memória de CPU é necessária (por exemplo, 70GB para o Medium) para o processamento do modelo em CPU antes de ser transferido para a GPU. Após o carregamento, essa memória é liberada.

Executando em Python

Primeiro, instale a biblioteca da MariTalk: bash pip install maritalk

Uma vez obtida uma chave de licença, é possível fazer o download, inicializar e executar a MariTalk local utilizando a biblioteca em Python, conforme exemplo abaixo.

```python import maritalk

Criando uma instância do cliente MariTalkLocal

client = maritalk.MariTalkLocal()

Iniciando o servidor com uma chave de licença especificada. O executável será baixado em ~/bin/maritalk

client.start_server(license='000000-00000-00000-00000')

Verificando o status do servidor

status = client.status() print(status) # {'status': 'idle'}

Gerando uma resposta para classificar resenhas de filmes

response = client.generate("""Classifique a resenha de filme como "positiva" ou "negativa".

Resenha: Gostei muito do filme, é o melhor do ano! Classe: positiva

Resenha: O filme deixa muito a desejar. Classe: negativa

Resenha: Foi fantástico, valeu o ingresso.. Classe:""", maxtokens=2, dosample=False) print(response) # {'output': 'positiva', 'queuetime': 0, 'prompttime': 158, 'generation_time': 9}

Preparando uma série de mensagens para uma interação de chat

messages = [ {"role": "user", "content": "sugira três nomes para a minha cachorra"}, {"role": "assistant", "content": "nina, bela e luna."}, {"role": "user", "content": "e para o meu peixe?"}, ]

Gerando a resposta do chat

chatresponse = client.generate(messages) print(chatresponse) # {'output': 'nani, bento e leo.', 'queuetime': 0, 'prompttime': 185, 'generation_time': 127} ```

O retorno das chamadas contém o texto gerado e os tempos de espera, de execução do prompt e da geração do texto para fins de debug do usuário.

Caso receba um erro No libcublas.so found é necessário instalar o Cuda Toolkit. Se estiver usando Ubuntu e Cuda 12, use este comando: bash sudo apt update sudo apt-get install -y libnccl2 cuda-toolkit-12

Também existem 2 comandos para facilitar o gerenciamento do executável:

Download

Para fazer o download do exectuável para um determinado path, você pode executar:

console $ python -m maritalk.download --license <SUA LICENÇA> --path maritalk-small

Start

Para fazer o download automaticamente e iniciar o servidor da MariTalk Local, você pode executar:

console $ python -m maritalk.start --license <SUA LICENÇA>

Iniciando o executável diretamente

Também é possivel executar o servidor diretamente no terminal, sem o wrapper em Python.

Download

bash wget -O maritalk <link do executável recebido no email>

Dependências

As principais dependências são as bibliotecas CUDA para comunicação com a GPU e de SSL. Para instalar as bibliotecas da Nvidia compatíveis com seu driver, é recomendado instalar o CUDA Toolkit na versão 11 ou 12. Exemplo: apt install cuda-toolkit-12. Atualmente suportamos as versões de CUDA 11 e 12 e Ubuntu versões 20 e 22. Caso queria sobrescrever a detecção automática das versões locais na hora do download do binário compatível, utilize o argumento cuda_version ou ssl_version, exemplo: client.start_server('00000-00000-00000-00000', cuda_version=12).

Também é possível executar a MariTalk em um container Docker utilizando as imagens da Nvidia com as dependências necessárias já instaladas. Por exemplo, a imagem nvidia/cuda:11.8.0-devel-ubuntu22.04 pode ser utilizada para executar o binário compatível com Ubuntu 22 e CUDA 11.

Execução

bash $ ./maritalk [OPTIONS] --license <LICENSE>

--license <LICENSE>: Sua chave de licença.

-p, --port <PORT>: Porta HTTP para escutar. [padrão: 9000]

-h, --help: Mostra uma mensagem de ajuda com a descrição dos argumentos disponíveis.

-V, --version: Mostra a versão do executável.

Modo interativo

Também é possível utilizar a MariTalk Local no próprio terminal sem precisar fazer requisções à API através do modo interativo:

```bash $ ./maritalk [OPTIONS] --license --interactive (...)

olá MariTalk: Olá! Como posso ajudar você hoje? crie uma lista de compras para uma festa de aniversário MariTalk: Aqui está uma lista de itens que você pode precisar para uma festa de aniversário:

  1. Doces: cupcakes, brownies, bolos, etc
  2. Bebidas: água, refrigerante, cerveja, suco, etc
  3. Decorações: balões, confetes, fitas, etc
  4. Lembrancinhas: chaveiros, sacolas, canetas, etc
  5. Lanternas: para decorar o ambiente
  6. Mesa: guardanapos, copos, talheres, pratos
  7. Música: CD ou MP3 player com música, alto-falante
  8. Tendas: para proteger da chuva ou do sol
  9. Mesas e cadeiras: para os convidados se sentarem
  10. Utensílios de cozinha: panelas, talheres, copos, pratos, etc
  11. Acessórios: guarda-sol, guarda-chuva, toalhas, etc
  12. Lanterna: para levar para caminhar

Lembre-se de sempre incluir produtos de qualidade e que sejam suficientes para atender a todos os convidados. ```

Owner

  • Name: Maritaca AI
  • Login: maritaca-ai
  • Kind: organization
  • Location: Brazil

Citation (CITATION.bib)

@article{maritaca2024sabia2,
  title={Sabi{\'a}-2: A New Generation of Portuguese Large Language Models},
  author={Sales Almeida, Thales and Abonizio, Hugo and Nogueira, Rodrigo and Pires, Ramon},
  year={2024}
}

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 6
  • Total pull requests: 23
  • Average time to close issues: 3 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 6
  • Total pull request authors: 5
  • Average comments per issue: 0.83
  • Average comments per pull request: 0.13
  • Merged pull requests: 17
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 23
  • Average time to close issues: 24 days
  • Average time to close pull requests: 3 days
  • Issue authors: 5
  • Pull request authors: 5
  • Average comments per issue: 0.8
  • Average comments per pull request: 0.13
  • Merged pull requests: 17
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rrg92 (3)
  • rodrigo-f-nogueira (2)
  • arthurcbaia (1)
  • PetsuTHEPRO (1)
  • Joao620 (1)
  • anapaulagomes (1)
  • peq42 (1)
  • devalexandre (1)
  • Uriel29 (1)
  • Shnrqpdr (1)
  • Samuelplim (1)
  • stuaninauts (1)
  • math-sasso (1)
  • DaniloOliveira28 (1)
Pull Request Authors
  • rodrigo-f-nogueira (64)
  • giovanaBonas (22)
  • hugoabonizio (12)
  • piresramon (9)
  • thiagolaitz (4)
  • ZanezZephyrs (2)
  • rodrigonogueira4 (2)
  • guilhermegriloamorim (2)
  • deniseiras (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 391 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 24
  • Total maintainers: 3
pypi.org: maritalk

Client library for the MariTalk API

  • Homepage: https://github.com/maritaca-ai/maritalk-api
  • Documentation: https://maritalk.readthedocs.io/
  • License: The MIT License Copyright (c) Maritaca AI (https://maritaca.ai) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.2.7
    published 11 months ago
  • Versions: 24
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 391 Last month
Rankings
Dependent packages count: 7.5%
Stargazers count: 8.8%
Forks count: 23.0%
Average: 27.3%
Dependent repos count: 69.8%
Last synced: 6 months ago