✨ gold with discretionary cost objectives (#525)

* working solution * 📝 Update pyfiction docstrings Signed-off-by: GitHub Actions <[email protected]> * structure * cost objectives * 📝 Update pyfiction docstrings Signed-off-by: GitHub Actions <[email protected]> * add bindings * clean-up * benchmark * 📝 Update pyfiction docstrings Signed-off-by: GitHub Actions <[email protected]> * increase coverage * clang-tidy * small fix * code review * 📝 Update pyfiction docstrings Signed-off-by: GitHub Actions <[email protected]> * bug fixes * 📝 Update pyfiction docstrings Signed-off-by: GitHub Actions <[email protected]> * formatting * missing header * 100% test coverage * more tests --------- Signed-off-by: GitHub Actions <[email protected]> Co-authored-by: GitHub Actions <[email protected]>
cda-tum · Sep 15, 2024 · 2957b0c · 2957b0c
1 parent ffeff24
commit 2957b0c
Show file tree

Hide file tree

Showing 10 changed files with 966 additions and 132 deletions.
diff --git a/...s/pyfiction/include/pyfiction/algorithms/physical_design/graph_oriented_layout_design.hpp b/...s/pyfiction/include/pyfiction/algorithms/physical_design/graph_oriented_layout_design.hpp
@@ -10,6 +10,7 @@
 
 #include <fiction/algorithms/physical_design/graph_oriented_layout_design.hpp>
 
+#include <pybind11/functional.h>  // Needed for std::function bindings
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
 
@@ -26,6 +27,32 @@ inline void graph_oriented_layout_design(pybind11::module& m)
     namespace py = pybind11;
     using namespace pybind11::literals;
 
+    py::enum_<fiction::graph_oriented_layout_design_params::effort_mode>(
+        m, "gold_effort_mode", DOC(fiction_graph_oriented_layout_design_params_effort_mode))
+        .value("HIGH_EFFICIENCY", fiction::graph_oriented_layout_design_params::effort_mode::HIGH_EFFICIENCY,
+               DOC(fiction_graph_oriented_layout_design_params_effort_mode_HIGH_EFFICIENCY))
+        .value("HIGH_EFFORT", fiction::graph_oriented_layout_design_params::effort_mode::HIGH_EFFORT,
+               DOC(fiction_graph_oriented_layout_design_params_effort_mode_HIGH_EFFORT))
+        .value("HIGHEST_EFFORT", fiction::graph_oriented_layout_design_params::effort_mode::HIGHEST_EFFORT,
+               DOC(fiction_graph_oriented_layout_design_params_effort_mode_HIGHEST_EFFORT))
+
+        ;
+
+    py::enum_<fiction::graph_oriented_layout_design_params::cost_objective>(
+        m, "gold_cost_objective", DOC(fiction_graph_oriented_layout_design_params_cost_objective))
+        .value("AREA", fiction::graph_oriented_layout_design_params::cost_objective::AREA,
+               DOC(fiction_graph_oriented_layout_design_params_cost_objective_AREA))
+        .value("WIRES", fiction::graph_oriented_layout_design_params::cost_objective::WIRES,
+               DOC(fiction_graph_oriented_layout_design_params_cost_objective_WIRES))
+        .value("CROSSINGS", fiction::graph_oriented_layout_design_params::cost_objective::CROSSINGS,
+               DOC(fiction_graph_oriented_layout_design_params_cost_objective_CROSSINGS))
+        .value("ACP", fiction::graph_oriented_layout_design_params::cost_objective::ACP,
+               DOC(fiction_graph_oriented_layout_design_params_cost_objective_ACP))
+        .value("CUSTOM", fiction::graph_oriented_layout_design_params::cost_objective::CUSTOM,
+               DOC(fiction_graph_oriented_layout_design_params_cost_objective_CUSTOM))
+
+        ;
+
     py::class_<fiction::graph_oriented_layout_design_params>(m, "graph_oriented_layout_design_params",
                                                              DOC(fiction_graph_oriented_layout_design_params))
         .def(py::init<>())
@@ -35,8 +62,10 @@ inline void graph_oriented_layout_design(pybind11::module& m)
                        DOC(fiction_graph_oriented_layout_design_params_num_vertex_expansions))
         .def_readwrite("verbose", &fiction::graph_oriented_layout_design_params::verbose,
                        DOC(fiction_graph_oriented_layout_design_params_verbose))
-        .def_readwrite("high_effort_mode", &fiction::graph_oriented_layout_design_params::high_effort_mode,
-                       DOC(fiction_graph_oriented_layout_design_params_high_effort_mode))
+        .def_readwrite("mode", &fiction::graph_oriented_layout_design_params::mode,
+                       DOC(fiction_graph_oriented_layout_design_params_mode))
+        .def_readwrite("cost", &fiction::graph_oriented_layout_design_params::cost,
+                       DOC(fiction_graph_oriented_layout_design_params_cost))
         .def_readwrite("return_first", &fiction::graph_oriented_layout_design_params::return_first,
                        DOC(fiction_graph_oriented_layout_design_params_return_first))
         .def_readwrite("planar", &fiction::graph_oriented_layout_design_params::planar,
@@ -70,7 +99,7 @@ inline void graph_oriented_layout_design(pybind11::module& m)
     m.def("graph_oriented_layout_design",
           &fiction::graph_oriented_layout_design<py_cartesian_gate_layout, py_logic_network>, "network"_a,
           "parameters"_a = fiction::graph_oriented_layout_design_params{}, "statistics"_a = nullptr,
-          DOC(fiction_graph_oriented_layout_design));
+          "custom_cost_objective"_a = nullptr, DOC(fiction_graph_oriented_layout_design));
 }
 
 }  // namespace pyfiction

diff --git a/bindings/pyfiction/include/pyfiction/layouts/gate_level_layout.hpp b/bindings/pyfiction/include/pyfiction/layouts/gate_level_layout.hpp
@@ -101,6 +101,7 @@ void gate_level_layout(pybind11::module& m, const std::string& topology)
         .def("num_pos", &GateLyt::num_pos, DOC(fiction_gate_level_layout_num_pos))
         .def("num_gates", &GateLyt::num_gates, DOC(fiction_gate_level_layout_num_gates))
         .def("num_wires", &GateLyt::num_wires, DOC(fiction_gate_level_layout_num_wires))
+        .def("num_crossings", &GateLyt::num_crossings, DOC(fiction_gate_level_layout_num_crossings))
         .def("is_empty", &GateLyt::is_empty, DOC(fiction_gate_level_layout_is_empty))
 
         .def(

diff --git a/bindings/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp b/bindings/pyfiction/include/pyfiction/pybind11_mkdoc_docstrings.hpp
@@ -5794,9 +5794,49 @@ Parameter ``ssg``:
 Parameter ``place_info``:
     The placement information.)doc";
 
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_best_acp_solution =
+R"doc(The current best solution with respect to the area-crossing product
+(ACP), initialized to the maximum possible value. This value will be
+updated as better solutions are found.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_best_area_solution =
+R"doc(The current best solution with respect to area, initialized to the
+maximum possible value. This value will be updated as better solutions
+are found.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_best_crossing_solution =
+R"doc(The current best solution with respect to the number of crossings,
+initialized to the maximum possible value. This value will be updated
+as better solutions are found.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_best_custom_solution =
+R"doc(The current best solution with respect to a custom cost objective,
+initialized to the maximum possible value. This value will be updated
+as better solutions are found.)doc";
+
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_best_optimized_solution = R"doc(Current best solution w.r.t. area after relocating POs.)doc";
 
-static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_best_solution = R"doc(Current best solution w.r.t. area.)doc";
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_best_wire_solution =
+R"doc(The current best solution with respect to the number of wire segments,
+initialized to the maximum possible value. This value will be updated
+as better solutions are found.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_calculate_cost = R"doc()doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_calculate_num_search_space_graphs =
+R"doc(Determines the number of search space graphs to generate based on the
+selected effort mode and cost objective.
+
+Parameter ``mode``:
+    The effort mode chosen for the layout design, determining the
+    level of computational effort.
+
+Parameter ``cost``:
+    The cost that specifies the optimization objective for the layout
+    design.
+
+Returns:
+    The number of search space graphs to be generated.)doc";
 
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_check_path =
 R"doc(Checks if there is a path between the source and destination tiles in
@@ -5821,6 +5861,8 @@ Parameter ``planar``:
 Returns:
     A path from `src` to `dest` if one exists.)doc";
 
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_custom_cost_objective = R"doc(Custom cost objective.)doc";
+
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_get_possible_positions =
 R"doc(Retrieves the possible positions for a given node in the layout based
 on its type and preceding nodes. It determines the type of the node
@@ -5947,9 +5989,33 @@ Parameter ``p``:
 Parameter ``st``:
     The statistics object to record execution details.)doc";
 
-static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_improve_current_solution =
-R"doc(Flag indicating if an initial solution was already found, and that
-other search space graphs should be pruned.)doc";
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_improve_acp_solution =
+R"doc(Flag indicating that an initial solution has been found with the area-
+crossings product as cost objective. When set to `true`, subsequent
+search space graphs with the area-crossing product as cost objective
+can be pruned.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_improve_area_solution =
+R"doc(Flag indicating that an initial solution has been found with the
+layout area as cost objective. When set to `true`, subsequent search
+space graphs with the layout area as cost objective can be pruned.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_improve_crossing_solution =
+R"doc(Flag indicating that an initial solution has been found with the
+number of crossings as cost objective. When set to `true`, subsequent
+search space graphs with the number of crossings as cost objective can
+be pruned.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_improve_custom_solution =
+R"doc(Flag indicating that an initial solution has been found with a custom
+cost objective. When set to `true`, subsequent search space graphs
+with a custom cost objective can be pruned.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_improve_wire_solution =
+R"doc(Flag indicating that an initial solution has been found with the
+number of wire segments as cost objective. When set to `true`,
+subsequent search space graphs with the number of wire segments as
+cost objective can be pruned.)doc";
 
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_initialize_layout =
 R"doc(Initializes the layout with minimum width
@@ -5971,6 +6037,24 @@ static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_num_ev
 
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_num_search_space_graphs = R"doc(Number of search space graphs.)doc";
 
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_num_search_space_graphs_high_efficiency = R"doc(In high-efficiency mode, only 2 search space graphs are used)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_num_search_space_graphs_high_effort =
+R"doc(In high-effort mode, 12 search space graphs are used: 3 (possible PI
+locations) * 2 (fanout substitution strategies) * 2 (topological
+orderings))doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_num_search_space_graphs_highest_effort =
+R"doc(In highest-effort mode, 48 search space graphs are used. This includes
+12 search space graphs for each of the four base cost objectives
+layout area, number of wire segments, number of wire crossings, and
+area-crossing product.)doc";
+
+static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_num_search_space_graphs_highest_effort_custom =
+R"doc(In highest-effort mode with a custom cost function, 60 search space
+graphs are used (48 with the standard cost objectives and 12 for the
+custom one).)doc";
+
 static const char *__doc_fiction_detail_graph_oriented_layout_design_impl_place_and_route =
 R"doc(Executes a single placement step in the layout for the given network
 node. It determines the type of the node, places it accordingly, and
@@ -7437,6 +7521,8 @@ Template parameter ``Lyt``:
 Template parameter ``Ntk``:
     The network type.)doc";
 
+static const char *__doc_fiction_detail_search_space_graph_cost = R"doc(The cost objective used to expand a vertex in the search space graph.)doc";
+
 static const char *__doc_fiction_detail_search_space_graph_current_vertex = R"doc(The current vertex in the search space graph.)doc";
 
 static const char *__doc_fiction_detail_search_space_graph_frontier = R"doc(Priority queue containing vertices of the search space graph.)doc";
@@ -10908,10 +10994,11 @@ based on where the first node in a topological sort of the logic
 network can be placed. Based on the position of this first node, a
 cost is assigned to each expansion based on the position of the placed
 node. The vertex with the lowest cost, which is the smallest layout
-w.r.t. area, is then chosen for the next expansion. This iterative
-process continues until a leaf node is found, which is a layout with
-all nodes placed. The algorithm then continues to backtrack through
-the search space graph to find other complete layouts with lower cost.
+w.r.t. the cost objective (e.g. area), is then chosen for the next
+expansion. This iterative process continues until a leaf node is
+found, which is a layout with all nodes placed. The algorithm then
+continues to backtrack through the search space graph to find other
+complete layouts with lower cost.
 
 Exclusively generates 2DDWave-clocked layouts.
 
@@ -10937,19 +11024,75 @@ Parameter ``pst``:
     A pointer to a statistics object to record execution details.
     Defaults to nullptr.
 
+Parameter ``custom_cost_objective``:
+    A custom cost objective that is evaluated at every expansion of
+    the search space graph. Should be a function that can be
+    calculated based on the current partial layout and returns an
+    uint64_t that should be minimized.
+
 Returns:
     The smallest layout yielded by the graph-oriented layout design
     algorithm under the given parameters.)doc";
 
 static const char *__doc_fiction_graph_oriented_layout_design_params = R"doc(Parameters for the graph-oriented layout design algorithm.)doc";
 
-static const char *__doc_fiction_graph_oriented_layout_design_params_high_effort_mode =
-R"doc(In high effort mode, 12 search space graphs are created with varying
-fanout substitution strategies, allowed PI placements, and other
-parameters, compared to only 2 graphs in high efficiency mode. This
-broader exploration increases the likelihood of discovering optimal
-layouts, but also increases runtime. When a solution is found in any
-graph, its cost is used to prune the search in the remaining graphs.)doc";
+static const char *__doc_fiction_graph_oriented_layout_design_params_cost = R"doc(The cost objective used. Defaults to AREA)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_cost_objective =
+R"doc(The `cost_objective` enum defines various cost objectives that can be
+used in the graph-oriented layout design process. Each cost objective
+represents a different metric used to expand a vertex in the search
+space graph.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_cost_objective_ACP =
+R"doc(ACP (Area-Crossings Product): Optimizes for a combination of layout
+area and the number of crossings.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_cost_objective_AREA =
+R"doc(AREA: Optimizes for the total area of the layout, aiming to minimize
+the space required for the design.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_cost_objective_CROSSINGS = R"doc(CROSSINGS: Optimizes for the number of wire crossings in the layout.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_cost_objective_CUSTOM =
+R"doc(CUSTOM: Allows for a user-defined cost objective, enabling
+optimization based on specific criteria outside the predefined
+options.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_cost_objective_WIRES =
+R"doc(WIRES: Optimizes for the number of wire segments in the layout,
+reducing the delay and increasing throughput.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_effort_mode =
+R"doc(The `effort_mode` enum defines different levels of computational
+effort for generating and exploring search space graphs for during the
+graph-oriented layout design process. Each mode varies in the number
+of search space graphs generated and the strategies employed,
+balancing between runtime efficiency and the likelihood of finding
+optimal solutions.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_effort_mode_HIGHEST_EFFORT =
+R"doc(HIGHEST_EFFORT mode builds upon HIGH_EFFORT by duplicating the 12
+search space graphs for different cost objectives. If the cost
+objective involves layout area, number of crossings, number of wire
+segments, or a combination of area and crossings, a total of 48 search
+space graphs are generated. For a custom cost objective, an additional
+12 graphs are created, resulting in 60 graphs in total. This mode
+provides the best guarantee of finding optimal solutions but
+significantly increases runtime.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_effort_mode_HIGH_EFFICIENCY =
+R"doc(HIGH_EFFICIENCY mode generates 2 search space graphs. This option
+minimizes runtime but may not always yield the optimal results.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_effort_mode_HIGH_EFFORT =
+R"doc(HIGH_EFFORT mode generates 12 search space graphs using various fanout
+substitution strategies, PI placements, and other parameters. This
+wider exploration increases the chance of finding optimal layouts but
+also extends runtime. When a solution is found in any graph, its cost
+is used to prune the remaining graphs.)doc";
+
+static const char *__doc_fiction_graph_oriented_layout_design_params_mode = R"doc(The effort mode used. Defaults to HIGH_EFFORT.)doc";
 
 static const char *__doc_fiction_graph_oriented_layout_design_params_num_vertex_expansions =
 R"doc(Number of expansions for each vertex that should be explored. For each

diff --git a/bindings/pyfiction/test/algorithms/physical_design/test_graph_oriented_layout_design.py b/bindings/pyfiction/test/algorithms/physical_design/test_graph_oriented_layout_design.py
@@ -45,6 +45,36 @@ def test_graph_oriented_layout_design_with_stats_and_parameters(self):
 
         self.assertNotEqual(equivalence_checking(network, layout), eq_type.NO)
 
+    def test_graph_oriented_layout_design_with_different_parameters(self):
+        network = read_technology_network(dir_path + "/../../resources/mux21.v")
+
+        params = graph_oriented_layout_design_params()
+        params.return_first = True
+        params.mode = gold_effort_mode.HIGH_EFFORT
+        params.timeout = 10000
+        params.verbose = True
+        params.num_vertex_expansions = 5
+        params.planar = False
+        params.cost = gold_cost_objective.WIRES
+
+        layout = graph_oriented_layout_design(network, params)
+
+        self.assertNotEqual(equivalence_checking(network, layout), eq_type.NO)
+
+    def test_graph_oriented_layout_design_with_custom_cost_function(self):
+        network = read_technology_network(dir_path + "/../../resources/mux21.v")
+
+        params = graph_oriented_layout_design_params()
+        params.return_first = True
+        params.mode = gold_effort_mode.HIGH_EFFORT
+        params.cost = gold_cost_objective.CUSTOM
+
+        def custom_cost_objective(layout):
+            return layout.num_wires() * 2 + layout.num_crossings()
+
+        layout = graph_oriented_layout_design(network, params, custom_cost_objective=custom_cost_objective)
+
+        self.assertNotEqual(equivalence_checking(network, layout), eq_type.NO)
 
 if __name__ == '__main__':
     unittest.main()