Lista de tareas para la especificación de StableHLO

En este documento, resumimos los lineamientos para revisar los cambios en la especificación. Por el momento, estos cambios suelen implicar verificar varios elementos en varias fuentes, por lo que en este documento se resumen todos para simplificar las revisiones:

  1. Verifica que la columna “Specification” en status.md diga “yes” y, si agregas una nueva op, agrega una fila.
  2. Verifica si el título de la sección coincide con el valor mnemotécnico de la operación en la ODS.
  3. Verifica si la sección "Semántica" coincide con la Semántica de operaciones de XLA.
  4. Verifica si las secciones "Entradas" y "Salidas" tienen las siguientes características:
    1. Enumera los mismos elementos que la ODS.
    2. Enumera los mismos elementos que HloInstruction::CreateFromProto.
    3. Se ordenan exactamente como las ODS.
    4. Si hay alguna discrepancia, verifica que haya tickets correspondientes.
  5. Verifica si la sección "Restricciones" hace lo siguiente:
    1. Coincide con shape_inference.cc de XLA.
    2. Coincide con hlo_verifier.cc de XLA.
    3. Coincide con la ODS.
    4. Coincide con StablehloOps.cpp.
    5. Si hay alguna discrepancia, verifica que haya tickets correspondientes. Vincula todos los tickets en la especificación, en ubicaciones que sean lo más específicas posible (p.ej., si un ticket se trata de una restricción que no se implementó, vincula el ticket directamente en esa restricción).
    6. Si las partes correspondientes de ODS y StablehloOps.cpp coinciden con la especificación, comprueba que las columnas "Verificación" y "Inferencia de tipo" de status.md digan "sí".
  6. Verifica si la sección "Ejemplos" hace lo siguiente:
    1. Solo hay un ejemplo. (En el futuro, ofreceremos vínculos con más ejemplos del paquete de pruebas de intérprete StableHLO).
    2. Usa una sintaxis de MLIR válida mediante la ejecución de stablehlo-opt en los ejemplos de código.
    3. Usa la sintaxis genérica de MLIR que se puede obtener mediante la ejecución de stablehlo-opt -mlir-print-op-generic (nos mantenemos la sintaxis genérica en la especificación para evitar tener que cambiar la especificación de los cambios de Prettyprint).
  7. Verifica que description en el ODS de la operación cumpla con estos requisitos:
    1. Incluye la primera oración de la especificación.
    2. Luego, establece un vínculo a la sección correspondiente de la especificación.
    3. Luego, usa el mismo ejemplo que la especificación, pero con una sintaxis "bonita", que se puede obtener ejecutando stablehlo-opt.
  8. Comprueba que los archivos relacionados con la implementación de restricciones de inferencia de tipo y verificación sigan los lineamientos que se mencionan a continuación:
    1. Sigue el lineamiento n.o 1 para StablehloOps.td.
    2. Sigue el lineamiento n.o 2 para TypeInference.cpp y StablehloOps.cpp.
    3. Sigue el lineamiento n.o 5 para ops_stablehlo.mlir.
    4. Sigue el lineamiento n.o 6 para infer_stablehlo.mlir.
  9. Evalúa la operación en busca de efectos secundarios y especulación.
    1. Si la op no tiene efectos secundarios y siempre se puede especular, asígnale la característica Pure. Esto es poco frecuente, ya que la mayoría de las operaciones permiten formas dinámicas, lo que puede generar discrepancias de formas durante el tiempo de ejecución, lo que es un comportamiento indefinido. Algunas operaciones también pueden tener un comportamiento indefinido en otras situaciones. La gran mayoría de las operaciones no tienen efectos secundarios (deben tener la característica NoMemoryEffect).
    2. La mayoría de las operaciones se encuentran en una de las características HLO_SpeculatableIf*. Si la op no encaja en ninguno de esos elementos, asígnale la característica ConditionallySpeculatable e implementa los métodos de la interfaz. Agrega pruebas a stablehlo/tests/ops_speculatability.mlir para cubrir la lógica de especulabilidad.