Python API debug symbols

CHANGELOG.md

@@ -31,6 +31,7 @@ Full documentation for MIGraphX is available at
 * Updated `argmin` and `argmax` ops to be implemented as reduction ops, so they now have JIT support and can fuse (#4620).
 * Replaced usages of `std::cout` and `std::cerr` with the logger (#4732)
 * Converted RNN variable sequence length operations (`rnn_var_sl_shift_sequence`, `rnn_var_sl_shift_output`, `rnn_var_sl_last_output`) from device implementation to JIT compilation (#4755).
+* Updated netron output to create an ONNX-like protobuff. Now also includes debug symbols if enabled. (#4701)
 
 ### Resolved issues
 

codecov.yml

@@ -2,4 +2,3 @@ ignore:
   - "test/"
   - "src/driver"
   - "build/" 
-  - "src/netron_output.cpp"

docs/driver/read.rst

@@ -80,7 +80,7 @@ Print out program as json.
 
 .. option::  --netron
 
-Print out program as a Netron viewable json file.
+Print out program as ONNX protobuf binary viewable in Netron.
 
 .. option::  --text
 

docs/migraphx-driver.rst

@@ -86,7 +86,7 @@ To learn which options can be used with which commands, see the :ref:`MIGraphX d
    *  - --binary
       - Prints the program in binary format
    *  - --netron
-      - Prints the program in Netron viewable JSON format
+      - Prints the program as ONNX protobuf binary viewable in Netron
    *  - --output | -o
       - Writes output in a file
    *  - --fill0

src/CMakeLists.txt

@@ -97,7 +97,6 @@ add_library(migraphx
     memory_coloring.cpp
     module.cpp
     msgpack.cpp
-    netron_output.cpp
     normalize_attributes.cpp
     normalize_ops.cpp
     op_enums.cpp

src/api/api.cpp

@@ -39,7 +39,9 @@
 #include <migraphx/json.hpp>
 #include <migraphx/convert_to_json.hpp>
 #include <migraphx/source_location.hpp>
+#include <migraphx/netron_output.hpp>
 #include <array>
+#include <fstream>
 #include <algorithm>
 #include <cstdarg>
 
@@ -337,6 +339,15 @@ static std::vector<shape> get_output_shapes(program& p) { return p.get_output_sh
 
 static void print_program(const program& p) { std::cout << p << std::endl; }
 
+static void write_netron_output_file(const program& p, const char* filename)
+{
+    std::ofstream os(filename, std::ios::binary);
+    if(not os.is_open())
+        MIGRAPHX_THROW(migraphx_status_bad_param,
+                       "Failed to open file for writing: " + std::string(filename));
+    write_netron_output(p, os);
+}
+
 static void print_module(const module& m) { std::cout << m << std::endl; }
 
 static migraphx::instruction_ref add_allocation(module& m, const migraphx::shape& s)
@@ -1756,6 +1767,17 @@ extern "C" migraphx_status migraphx_program_print(const_migraphx_program_t progr
     return api_error_result;
 }
 
+extern "C" migraphx_status migraphx_program_write_netron_output(const_migraphx_program_t program,
+                                                                const char* filename)
+{
+    auto api_error_result = migraphx::try_([&] {
+        if(program == nullptr)
+            MIGRAPHX_THROW(migraphx_status_bad_param, "Bad parameter program: Null pointer");
+        migraphx::write_netron_output_file((program->object), (filename));
+    });
+    return api_error_result;
+}
+
 extern "C" migraphx_status migraphx_program_sort(migraphx_program_t program)
 {
     auto api_error_result = migraphx::try_([&] {

src/api/include/migraphx/migraphx.h

@@ -464,6 +464,9 @@ MIGRAPHX_C_EXPORT migraphx_status migraphx_program_get_output_shapes(migraphx_sh
 
 MIGRAPHX_C_EXPORT migraphx_status migraphx_program_print(const_migraphx_program_t program);
 
+MIGRAPHX_C_EXPORT migraphx_status
+migraphx_program_write_netron_output(const_migraphx_program_t program, const char* filename);
+
 MIGRAPHX_C_EXPORT migraphx_status migraphx_program_sort(migraphx_program_t program);
 
 MIGRAPHX_C_EXPORT migraphx_status migraphx_program_run(migraphx_arguments_t* out,

src/api/include/migraphx/migraphx.hpp

@@ -1232,6 +1232,11 @@ struct program : MIGRAPHX_HANDLE_BASE(program)
 
     void print() const { call(&migraphx_program_print, this->get_handle_ptr()); }
 
+    void write_netron_output(const char* filename) const
+    {
+        call(&migraphx_program_write_netron_output, this->get_handle_ptr(), filename);
+    }
+
     program sort()
     {
         call(&migraphx_program_sort, this->get_handle_ptr());

src/api/migraphx.py

@@ -220,7 +220,10 @@ def shapes(h):
 
 @api.handle('migraphx_instruction', 'migraphx::instruction_ref')
 def instruction(h):
-    pass
+    h.method('get_debug_symbols',
+             fname='get_debug_symbols',
+             returns='const std::set<std::string>&',
+             const=True)
 
 
 @api.handle('migraphx_instructions', 'std::vector<migraphx::instruction_ref>')
@@ -265,6 +268,16 @@ def module(h):
              api.params(s='const migraphx::shape&'),
              invoke='migraphx::add_allocation($@)',
              returns='migraphx::instruction_ref')
+    h.method('has_debug_symbols',
+             fname='has_debug_symbols',
+             returns='bool',
+             const=True)
+    h.method('add_debug_symbols',
+             api.params(ins='migraphx::instruction_ref', symbols='std::set<std::string>'),
+             fname='add_debug_symbols')
+    h.method('remove_debug_symbols',
+             api.params(ins='migraphx::instruction_ref'),
+             fname='remove_debug_symbols')
 
 
 @auto_handle()
@@ -284,6 +297,10 @@ def program(h):
              invoke='migraphx::get_output_shapes($@)',
              returns='std::vector<migraphx::shape>')
     h.method('print', invoke='migraphx::print_program($@)', const=True)
+    h.method('write_netron_output',
+             api.params(filename='const char*'),
+             invoke='migraphx::write_netron_output_file($@)',
+             const=True)
     h.method('sort')
     h.method('run',
              api.params(

src/driver/main.cpp

@@ -279,7 +279,7 @@ struct loader
            ap.set_value("binary"));
         ap(output_type,
            {"--netron"},
-           ap.help("Print out program as Netron readable json."),
+           ap.help("Print out program as ONNX protobuf binary viewable in Netron."),
            ap.set_value("netron"));
         ap(output, {"--output", "-o"}, ap.help("Output to file."));
     }
@@ -543,7 +543,7 @@ struct loader
         else if(type == "binary")
             write(*os, save_buffer(p));
         else if(type == "netron")
-            *os << make_netron_output(p) << std::endl;
+            write_netron_output(p, *os);
     }
 };
 

src/include/migraphx/netron_output.hpp

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2015-2024 Advanced Micro Devices, Inc. All rights reserved.
+ * Copyright (c) 2015-2026 Advanced Micro Devices, Inc. All rights reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -24,14 +24,15 @@
 #ifndef MIGRAPHX_GUARD_RTGLIB_NETRON_OUTPUT_HPP
 #define MIGRAPHX_GUARD_RTGLIB_NETRON_OUTPUT_HPP
 
-#include <string>
+#include <ostream>
 #include <migraphx/config.hpp>
 #include <migraphx/program.hpp>
+#include <migraphx/onnx/export.h>
 
 namespace migraphx {
 inline namespace MIGRAPHX_INLINE_NS {
 
-MIGRAPHX_EXPORT std::string make_netron_output(const program& prog);
+MIGRAPHX_ONNX_EXPORT void write_netron_output(const program& prog, std::ostream& os);
 
 } // namespace MIGRAPHX_INLINE_NS
 } // namespace migraphx

src/include/migraphx/program.hpp

@@ -1,7 +1,7 @@
 /*
  * The MIT License (MIT)
  *
- * Copyright (c) 2015-2025 Advanced Micro Devices, Inc. All rights reserved.
+ * Copyright (c) 2015-2026 Advanced Micro Devices, Inc. All rights reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -56,6 +56,7 @@ struct marker;
  */
 struct MIGRAPHX_EXPORT program
 {
+
     program();
 
     explicit program(module m);
@@ -79,6 +80,8 @@ struct MIGRAPHX_EXPORT program
 
     std::unordered_map<std::string, shape> get_parameter_shapes() const;
 
+    int get_program_file_version() const;
+
     std::size_t total_instructions() const;
 
     std::vector<argument> eval(const parameter_map& params,
@@ -165,6 +168,9 @@ struct MIGRAPHX_EXPORT program
     private:
     void assign(const program& p);
     std::unique_ptr<program_impl> impl;
+    // program file version is for the data structure or format of the MXR file. Version should be bumped
+    // if any changes occur to the format of the MXR file.
+    static constexpr int program_file_version = 8;
 };
 } // namespace MIGRAPHX_INLINE_NS
 } // namespace migraphx