Skip to content

Adicionar informações sobre Performance e Limitações no README #18

@bdcdo

Description

@bdcdo

Descrição

O README não menciona aspectos importantes sobre performance, limitações de tamanho de dataset ou expectativas de uso, o que pode gerar dúvidas nos usuários sobre a adequação da biblioteca para seus projetos.

Proposta

Adicionar uma seção "Performance e Limitações" que inclua:

Performance

  • Tempo de processamento esperado para diferentes tamanhos de dataset
  • Uso de memória (aproximado) para diferentes volumes de dados
  • Recomendações para otimização com datasets grandes

Limitações

  • Tamanho máximo recomendado de dataset
  • Limitações do algoritmo K-Means (clusters esféricos, sensibilidade à escala)
  • Dependência da qualidade dos textos de entrada
  • Limitações específicas do TF-IDF para textos muito curtos ou muito longos

Recomendações

  • Boas práticas para preparação dos dados
  • Quando considerar outras técnicas de clusterização
  • Como interpretar os resultados adequadamente

Benefícios

  • Define expectativas realistas para os usuários
  • Evita frustrações com uso inadequado
  • Demonstra transparência e maturidade técnica
  • Orienta usuários na escolha da ferramenta adequada

Localização sugerida

Após a seção "Funcionalidades Principais (API)" e antes da "Documentação"

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions