Merge branch 'master' into 215-make-memory-a-parameter

Author: JavierCladellas

.github/workflows/ci.yml

@@ -30,7 +30,7 @@ jobs:
         CXX: clang++
 
     - name: Upload Artifact
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: wheel-artifacts
         path: dist/*.whl
@@ -43,7 +43,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Download packages
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: wheel-artifacts
         path: dist/
@@ -95,7 +95,7 @@ jobs:
     - name: Install NPM dependencies
       run: npm install
     - name: Download
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: wheel-artifacts
         path: dist/
@@ -151,7 +151,7 @@ jobs:
       run: |
         cmake --build --preset default -t package
     - name: Upload Artifact
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: benchmarking-artifacts
         path: build/default/assets/benchmarking-*
@@ -163,7 +163,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Download
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         # Artifact name
         name: benchmarking-artifacts
@@ -206,12 +206,12 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Download Deb Packages
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: benchmarking-artifacts
           path: artifacts/
       - name: Download Wheel Packages
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: wheel-artifacts
           path: dist/

docs/modules/tutorial/pages/configurationfiles/plots.adoc

@@ -202,7 +202,7 @@ Considering the same example axis as above, the software can generate the follow
 
 [%dynamic%open%hide_code,python]
 ----
-from feelpp.benchmarking.report.figureFactory import FigureFactory
+from feelpp.benchmarking.report.figures.figureFactory import FigureFactory
 figures = FigureFactory.create(Plot(**{
     "title": "Absolute performance",
     "plot_types": [ "scatter" ],

requirements.txt

@@ -15,5 +15,4 @@ traitlets
 tabulate
 typing-extensions>=4.12.2
 python-dotenv
-tikzplotly
 .

src/feelpp/benchmarking/report/base/controller.py

@@ -1,4 +1,5 @@
-from feelpp.benchmarking.report.dataGenerationFactory import DataGeneratorFactory
+
+
 class Controller:
     """ Controller component , it orchestrates the model with the view"""
     def __init__(self, model, view):
@@ -10,6 +11,41 @@ def __init__(self, model, view):
         self.model = model
         self.view = view
 
+    def generatePlotly(self):
+        """ Creates plotly figures for each plot specified on the view config file
+        Returns a list of plotly figures.
+        """
+        return [ figure.createFigure(self.model.master_df) for figure in self.view.figures ]
+
+    def generatePlotlyHtml(self):
+        """ Creates plotly figures in html for each plot specified on the view config file
+        Returns a list of plotly HTML figures
+        """
+        return [ figure.createFigureHtml(self.model.master_df) for figure in self.view.figures ]
+
+    def generateTikz(self):
+        """ Creates Tikz/Pgf figures for each plot specified on the view config file
+        Returns:
+            list[str] LaTeX pgf plots.
+        """
+        return [ figure.createTex(self.model.master_df) for figure in self.view.figures ]
+
+    def generateCsv(self):
+        """ Create a list containing the data for each plot specified on the view config in CSV format.
+        Returns (list[str]): List of csv data.
+        """
+        return [ figure.createCsv(self.model.master_df) for figure in self.view.figures ]
+
+
     def generateData(self,format):
         """ Creates a list of data depending on the desired format, using the plot configuration and the model's master dataframe"""
-        return DataGeneratorFactory.create(format).generate(self.view.plots_config,self.model.master_df)
+        if format == "plotly":
+            return self.generatePlotly()
+        elif format == "html":
+            return self.generatePlotlyHtml()
+        elif format in ["tikz", "pgf"]:
+            return self.generateTikz()
+        elif format == "csv":
+            return self.generateCsv()
+        else:
+            raise NotImplementedError

src/feelpp/benchmarking/report/base/view.py

@@ -1,4 +1,5 @@
 from feelpp.benchmarking.reframe.config.configSchemas import Plot
+from feelpp.benchmarking.report.figures.figureFactory import FigureFactory
 
 class View:
     """ Abstract view component"""
@@ -8,3 +9,7 @@ def __init__(self,plots_config):
             plots_config list[dict]. List with dictionaries specifying plots configuration.
         """
         self.plots_config = [Plot(**d) for d in plots_config]
+
+        self.figures = []
+        for plot_config in self.plots_config:
+            self.figures.extend(FigureFactory.create(plot_config))

src/feelpp/benchmarking/report/dataGenerationFactory.py

@@ -0,0 +1,54 @@
+from pandas import MultiIndex
+
+class Figure:
+    def __init__(self,plot_config,transformation_strategy):
+        self.config = plot_config
+        self.transformation_strategy = transformation_strategy
+
+    def getIdealRange(self,df):
+        """ Computes the [(min - eps), (max+eps)] interval for optimal y-axis display
+        Args:
+            - df (pd.DataFrame): The dataframe for which the interval should be computed
+        Returns list[float, float]: The  [(min - eps), (max+eps)] interval
+        """
+        range_epsilon= 0.01
+        return [ df.min().min() - df.min().min()*range_epsilon, df.max().max() + df.min().min()*range_epsilon ]
+
+    def createMultiindexFigure(self,df):
+        raise NotImplementedError("Pure virtual function. Not to be called from the base class")
+
+    def createSimpleFigure(self,df):
+        raise NotImplementedError("Pure virtual function. Not to be called from the base class")
+
+    def createCsv(self,df):
+        return self.transformation_strategy.calculate(df).to_csv()
+
+    def createFigure(self,df, **args):
+        """ Creates a figure from the master dataframe
+        Args:
+            df (pd.DataFrame). The master dataframe containing all reframe test data
+        Returns:
+            go.Figure: Plotly figure corresponding to the grouped Bar type
+        """
+        df = self.transformation_strategy.calculate(df)
+
+        if isinstance(df.index,MultiIndex):
+            figure = self.createMultiindexFigure(df, **args)
+        else:
+            figure = self.createSimpleFigure(df, **args)
+
+        return figure
+
+
+class CompositeFigure:
+    def createFigure(self, df):
+        return self.plotly_figure.createFigure(df)
+
+    def createTex(self, df):
+        return self.tikz_figure.createFigure(df)
+
+    def createCsv(self,df):
+        return self.plotly_figure.createCsv(df)
+
+    def createFigureHtml(self,df):
+        return self.plotly_figure.createHtml(df)

src/feelpp/benchmarking/report/figures/__init__.py

@@ -0,0 +1,59 @@
+from feelpp.benchmarking.report.transformationFactory import TransformationStrategyFactory
+
+from feelpp.benchmarking.report.figures.base import CompositeFigure
+from feelpp.benchmarking.report.figures.tikzFigures import TikzScatterFigure, TikzGroupedBarFigure, TikzStackedBarFigure, TikzTableFigure
+from feelpp.benchmarking.report.figures.plotlyFigures import PlotlyScatterFigure, PlotlyGroupedBarFigure, PlotlyStackedBarFigure, PlotlyTableFigure
+
+
+
+class ScatterFigure(CompositeFigure):
+    """ Composite figure class for scatter figures"""
+    def __init__(self, plot_config, transformation_strategy, fill_lines=[]):
+        self.plotly_figure = PlotlyScatterFigure(plot_config,transformation_strategy,fill_lines)
+        self.tikz_figure = TikzScatterFigure(plot_config,transformation_strategy,fill_lines)
+
+class TableFigure(CompositeFigure):
+    """ Composite figure class for table figures"""
+    def __init__(self, plot_config, transformation_strategy):
+        self.plotly_figure = PlotlyTableFigure(plot_config,transformation_strategy)
+        self.tikz_figure = TikzTableFigure(plot_config,transformation_strategy)
+
+class StackedBarFigure(CompositeFigure):
+    """ Composite figure class for stacked bar figures"""
+    def __init__(self, plot_config, transformation_strategy):
+        self.plotly_figure = PlotlyStackedBarFigure(plot_config,transformation_strategy)
+        self.tikz_figure = TikzStackedBarFigure(plot_config,transformation_strategy)
+
+class GroupedBarFigure(CompositeFigure):
+    """ Composite figure class for grouped bar figures"""
+    def __init__(self, plot_config, transformation_strategy):
+        self.plotly_figure = PlotlyGroupedBarFigure(plot_config,transformation_strategy)
+        self.tikz_figure = TikzGroupedBarFigure(plot_config,transformation_strategy)
+
+
+class FigureFactory:
+    """ Factory class to dispatch concrete figure elements"""
+    @staticmethod
+    def create(plot_config):
+        """ Creates a concrete composite figure element
+        Args:
+            plot_config (Plot). Pydantic object with the plot configuration information
+        """
+        strategy = TransformationStrategyFactory.create(plot_config)
+        figures = []
+        for plot_type in plot_config.plot_types:
+            if plot_type ==  "scatter":
+                fill_lines = []
+                if plot_config.transformation=="speedup":
+                    fill_lines = ["optimal","half-optimal"]
+                figures.append(ScatterFigure(plot_config,strategy, fill_lines))
+            elif plot_type == "table":
+                figures.append(TableFigure(plot_config,strategy))
+            elif plot_type == "stacked_bar":
+                figures.append(StackedBarFigure(plot_config,strategy))
+            elif plot_type == "grouped_bar":
+                figures.append(GroupedBarFigure(plot_config,strategy))
+            else:
+                raise NotImplementedError
+
+        return figures