Checklist Penerjemah StableHLO

Dalam dokumen ini, kami merangkum pedoman untuk menerapkan dan meninjau untuk penafsir. Kami sengaja menyertakan beberapa tindakan tambahan item yang terkait dengan pemverifikasi dan inferensi jenis, dengan gagasan untuk membuat kemajuan hal-hal tersebut di samping implementasi penerjemah.

Saat menerapkan operasi

  1. Menyediakan strategi pengujian yang ditulis secara eksplisit (dalam deskripsi PR) mirip dengan ini untuk menggunakan sebagai referensi saat meninjau verifikasi dan inferensi jenis metode, dan pengujian yang sesuai. Peninjau akan memeriksa ulang apakah deskripsinya komprehensif.
  2. Konsultasi hlo_evaluator untuk mengidentifikasi detail implementasi yang rumit dan potensi kesenjangan fungsi.
  3. Ajukan tiket untuk komponen software terkait jika Anda menemukan bug atau kehilangan fungsi.

Setelah mengimplementasikan operasi

  1. Di StablehloOps.td:

    1. Pastikan summary di ODS operasi mengikuti format standar. (tiket terkait)
    2. Menambahkan komentar yang merujuk ke label batasan (misalnya Cn atau In) dari spesifikasi dalam format xyz_cn atau xyz_in, untuk operasi XyzOp, guna mengidentifikasi korespondensi antara batasan dalam ODS dan spesifikasinya. Tujuan contoh berikut menunjukkan cara menambahkan label batasan sebagai komentar bersama mlir Traits dan TypeConstraints. Catatan xyz_c4 merujuk pada batasan yang ditentukan dalam class StableHLO_FooOp (misalnya, StableHLO_ShapedInterfaceOp, StableHLO_UnaryElementwiseOp, StableHLO_Op, dll.).

       def StableHLO_XyzOp: StableHLO_FooOp<"xyz", [Trait1,
           Trait2 /*xyz_c1, xyz_c2*/, InferTensorType /*xyz_c3*/]> { /*xyz_c4*/
            ...
         let summary = "Xyz operation";
         let arguments = (ins
            1DTensorOf<[HLO_Float]>:$a, /*xyz_c5, xyz_i1*/
            HLO_Tensor:$b, /*xyz_i2*/
            ....
         );
      );
      
  2. Di TypeInference.cpp dan StablehloOps.cpp:

    1. Hapus komentar yang bertuliskan hal-hal seperti "Verifikasi properti berikut: ...".
    2. Menambahkan komentar yang merujuk ke label batasan (misalnya Cn atau In) dari spesifikasi dalam format xyz_cn atau xyz_in, untuk operasi XyzOp, guna mengidentifikasi bagian mana dari pemverifikasi dan fungsi bentuk yang sesuai dengan kendala-kendala dalam spesifikasi.
      1. Diperbolehkan untuk memiliki komentar dengan beberapa label batasan atau memiliki beberapa komentar dengan label batasan yang sama. Itu semua tergantung pada bagaimana batasan diimplementasikan. Jika ada batasan berturut-turut, meringkasnya menjadi xyz_cn...xyz_cm, xyz_in...xyz_jn.
      2. Jika ada ketidakcocokan antara batasan dalam implementasi VS dan yang ada dalam spesifikasi, pastikan masalah terbuka yang mencerminkan perbedaan tersebut.
  3. Dalam pengujian penafsir:

    1. Tambahkan file bernama <op_mnemonic>.mlir.
    2. Tulis pengujian dengan mengikuti panduan pengujian.
  4. Di direktori testdata:

    1. Menjalankan pengujian nonaktif apa pun yang dicakup oleh operasi yang baru ditambahkan.
    2. Jika lulus pengujian, aktifkan pengujian dengan mengonversi RUN-DISABLED menjadi RUN.
    3. Jika pengujian gagal karena alasan selain ketidakcocokan presisi, perbaiki implementasi/pengujian.
    4. Untuk ketidakcocokan presisi, beri tag pada pengujian dengan RUN-DISABLED(#1278) (jika hal ini belum dilakukan).
  5. Di ops_stablehlo.mlir:

    1. Pastikan setidaknya ada satu tes (positif atau negatif) untuk setiap pengujian batasan dalam metode inferensi pemverifikasi dan jenis; batasan-batasan yang tercakup dalam ODS tidak akan diuji. Tes ini sebagian besar akan bernilai negatif, pengujian bahwa batasan tidak terpenuhi atau positif, menguji bahwa bentuk yang disimpulkan sudah benar.
    2. Pastikan semua pengujian yang terkait dengan op yang sedang diuji ditempatkan secara bersamaan.
    3. Pastikan semua pengujian yang terkait dengan operasi yang diuji ditambahkan dengan makro menyala CHECK-LABEL.
    4. Memilih nama fungsi pengujian menggunakan format xyz_cn_im_... untuk pengujian fungsi batasan Cn, Im, dll. untuk operasi XyzOp. Apabila format yang diusulkan tidak terapkan, pertahankan nama yang ada.
    5. Setelah langkah di atas selesai, urutkan semua pengujian yang terkait dengan operasi dalam pengujian menurut abjad berdasarkan nama fungsi.
    6. Terus tambahkan pengujian sampai ccov menunjukkan cakupan >= 90% untuk operasi.
  6. Di infer_stablehlo.mlir:

    1. Pastikan semua batasan yang terkait dengan uji inferensi bentuk ada dalam file ini, dengan mengikuti panduan penamaan yang sama dengan yang disebutkan di atas.
    2. Pindahkan pengujian inferensi bentuk dari ops_stablehlo.mlir ke file ini.
  7. Di spec.md:

    1. Tambahkan link ke stablehlo/tests/interpret/<op_mnemonic>.mlir ke "Contoh" bagian (misalnya, Contoh Lainnya).
    2. Pastikan spesifikasi hanya memiliki 1 contoh.
    3. Pastikan contoh spesifikasi mengikuti panduan pengujian.
    4. Pastikan pengujian contoh spesifikasi dapat ditafsirkan.
    5. Pastikan contoh spesifikasi sama dengan yang ada di ODS.
  8. Dalam status.md:

    1. Perbarui "Penerjemah" kolom ke yes.