Política de documentación

En esta página, se describe la política de IA de la AML para diferentes artefactos de documentación.

Tipo de artefacto Descripción Frecuencia de generación
Guías para el usuario, guías prácticas y la referencia de la API

Esta documentación comprende la definición del producto y se actualiza a medida que cambian las funciones. Esto incluye lo siguiente:

  • Guías del usuario: Manuales paso a paso para usar el producto de IA de AML
  • Guías de instrucciones: Documentos que indican a los usuarios cómo completar tareas importantes
  • Referencia de la API: Descripciones exhaustivas de las funciones, las clases y los métodos

Se actualiza con cada lanzamiento del producto y periódicamente según sea necesario.
Notas de la versión En esta documentación, se proporcionan anuncios de cambios en las funciones y la funcionalidad de los productos, incluidas las métricas y los resultados de rendimiento compatibles. Se proporciona con cada versión del producto, incluidas las APIs y las versiones del motor
Documentos de conceptos (incluye documentación de asistencia para la administración de modelos)

Un documento que describe los casos de uso, los enfoques, las soluciones seleccionadas y las metodologías que se siguieron para tomar decisiones significativas que afectan el modelo.

Cuando la funcionalidad es propietaria, un documento de concepto describe lo anterior, pero puede excluir áreas de solución específicas si son IP protegidas. En este caso, se presenta el enfoque general, la metodología y la validación de la técnica.

Se proporciona cuando hay una versión principal del motor, que incluye cambios significativos en el diseño del producto o las metodologías de evaluación que pueden requerir la actualización de los materiales de asistencia de la gobernanza (disponibles a pedido para los clientes de IA de AML).
Informes automáticos Resultados cuantitativos o registros de auditoría Se genera cuando se realiza una llamada a la API.