Política de documentação

Esta página descreve a política de IA de AML para diferentes artefatos de documentação.

Tipo de artefato Descrição Frequência de geração
Guias do usuário, guias de instruções e a referência da API

Esta documentação compreende a definição do produto. A documentação é atualizada conforme os recursos mudam. Isso inclui o seguinte:

  • Guias do usuário: manuais detalhados sobre como usar o produto de IA de AML
  • Guias de instruções: documentos que informam aos usuários como concluir tarefas importantes
  • Referência da API: descrições completas de funções, classes e métodos

Atualizadas com cada lançamento do produto e periodicamente conforme necessário
Notas da versão Esta documentação apresenta avisos de mudanças nos recursos e nas funcionalidades do produto, incluindo o suporte a métricas e resultados de performance. Fornecido com cada versão do produto, incluindo APIs e versões do mecanismo
Documentos de conceito (inclui documentação de suporte à governança de modelos)

Um documento que descreve casos de uso, abordagens, soluções selecionadas e metodologias seguidas para decisões importantes que afetam o modelo.

Quando a funcionalidade é reservada, um documento de conceito descreve o anterior, mas pode excluir áreas de solução específicas se elas forem protegidas por IP. Nesse caso, a abordagem geral, a metodologia e a validação da técnica são apresentadas.

Fornecido quando há uma versão principal do mecanismo, que inclui mudanças significativas no design do produto ou nas metodologias de avaliação que podem exigir a atualização de materiais de suporte à governança (disponível mediante solicitação para clientes de IA de AML)
Relatórios automáticos Saídas quantitativas e/ou registros de auditoria Gerado na chamada de API