Merge pull request #36 from george0st/changes

Improve documentation
george0st · Sep 17, 2024 · d436f8c · d436f8c
2 parents 8216f6a + 4b17138
commit d436f8c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -99,8 +99,12 @@ generator.create_graph_perf()
 ```
 
 ## Graphs generated from qgate-graph based on outputs from qgate-perf
-#### 512 executors (128 processes x 4 threads)
+The performance graph with 512 executors (128 processes x 4 threads). 
+You can see performance visualisation:
+ - calls per second for different amount of executors
+ - response time in seconds with standard deviation for different amount of executors 
 ![graph](https://github.com/george0st/qgate-perf/blob/main/assets/PRF-Calc-2023-05-06_18-22-19-bulk-1x10.png?raw=true)
+The executor graph, you can see amount of executors in time.
 ![graph](https://github.com/george0st/qgate-perf/blob/main/assets/EXE-Calc-2023-05-06_18-22-19-bulk-1x10-plan-128x4.png?raw=true)
 
 #### 32 executors (8 processes x 4 threads)

diff --git a/qgate_perf/parallel_executor.py b/qgate_perf/parallel_executor.py
@@ -476,7 +476,7 @@ def create_graph_static(input_file, output_graph_dir="output", scope: GraphScope
         :param scope:               definition of scope generation (default ExecutorGraph.all)
         :param picture_dpi:         quality of picture (default is 100 DPI)
         :param suppress_error:      suppress error (default is False)
-        :return:                    list of output files
+        :return:                    list of generated files
         """
         output_file=[]
 
@@ -505,7 +505,7 @@ def create_graph(self, output_graph_dir="output", scope: GraphScope = GraphScope
         :param scope:               definition of scope generation (default ExecutorGraph.all)
         :param picture_dpi:         quality of picture (default is 100 DPI)
         :param suppress_error:      suppress error (default is False)
-        :return:                    list of output files
+        :return:                    list of generated files
         """
         return ParallelExecutor.create_graph_static(self._output_file,
                                       output_graph_dir,
@@ -521,7 +521,7 @@ def create_graph_perf(self, output_graph_dir="output", picture_dpi=100, suppress
         :param output_graph_dir:    directory for graph outputs (with subdirectory 'graph-perf')
         :param picture_dpi:         quality of picture (default is 100 DPI)
         :param suppress_error:      suppress error (default is False)
-        :return:                    list of output files
+        :return:                    list of generated files
         """
         return ParallelExecutor.create_graph_static(self._output_file,
                                       os.path.join(output_graph_dir,"graph-perf"),
@@ -537,7 +537,7 @@ def create_graph_exec(self, output_graph_dir="output", picture_dpi=100, suppress
         :param output_graph_dir:    directory for graph outputs (with subdirectory 'graph-exec')
         :param picture_dpi:         quality of picture (default is 100 DPI)
         :param suppress_error:      suppress error (default is False)
-        :return:                    list of output files
+        :return:                    list of generated files
         """
         return ParallelExecutor.create_graph_static(self._output_file,
                                       os.path.join(output_graph_dir,"graph-exec"),

diff --git a/tests/test_graph.py b/tests/test_graph.py
@@ -156,7 +156,6 @@ def test_graph_scope(self):
         today = datetime.datetime.now().strftime("%Y-%m-%d")
         file=glob.glob(path.join(self.OUTPUT_ADR, "graph-perf", "1 sec", today, f"PRF-test_graph_scope-*-bulk-10x10.png"))
         self.assertTrue(len(file) == 1)
-        print(file[0])
         file=glob.glob(path.join(self.OUTPUT_ADR, "graph-exec", "1 sec", today, f"EXE-test_graph_scope-*-bulk-10x10-*.png"))
         self.assertTrue(len(file) == 0) # without these file
 
@@ -166,4 +165,3 @@ def test_graph_scope(self):
         today = datetime.datetime.now().strftime("%Y-%m-%d")
         file=glob.glob(path.join(self.OUTPUT_ADR, "graph-exec", "1 sec", today, f"EXE-test_graph_scope-*-bulk-10x10-*.png"))
         self.assertTrue(len(file) == 2)
-        print(file[0])