Merge pull request #92 from george0st/changes

Extend README and typo

README.md

@@ -6,14 +6,18 @@
 
 # QGate-Perf
 
-The QGate Performance is enabler for performance test execution. Key benefits:
+The QGate Performance is enabler for python performance test execution. Key benefits:
  - **easy performance testing** your python code (key parts - init, start, stop, return)
  - **measure only specific part** of your code 
  - scalability **without limits** (e.g. from 1 to 1k executors)
  - scalability **in level of processes and threads** (easy way, how to avoid GIL in python)
  - **sequences for execution and data bulk**
  - relation to graph generator
 
+NOTE: The recommendations are:
+ - use Python >= 3.11
+ - use the 'QGate-Perf-cs' (C# implementation of QGate-Perf), in case of bigger parallelism and lower lateness 
+
 ## Usage
 
 ```python
@@ -26,7 +30,7 @@ def prf_GIL_impact(run_setup: RunSetup):
     """ Your own function for performance testing, you have to add
     only part INIT, START, STOP and RETURN"""
 
-    # INIT - contain executor synchonization, if needed
+    # INIT - contain executor synchronization, if needed
     probe=ParallelProbe(run_setup)
 
     while (True):

qgate_perf/output_result.py

@@ -280,7 +280,7 @@ def print_detail(self, run_setup: RunSetup, return_dict, processes, threads, gro
             out[FileMarker.PRF_CORE_MAX + suffix] = result.max                                  # ok
         out[FileMarker.PRF_CORE_TIME_END] = datetime.utcnow().isoformat(' ')
 
-        # human readable form
+        # human-readable form
         readable_out = {}
         readable_out[FileMarker.HM_PRF_CORE_PLAN_EXECUTOR_ALL] = f"{processes * threads} [{processes},{threads}]"
         readable_out[FileMarker.HM_PRF_CORE_REAL_EXECUTOR] = percentile_summaries[1].executors # executors

qgate_perf/percentile_heap.py

@@ -18,7 +18,7 @@ def __init__(self, call_fn, close_fn, percentile = 0.99, heap_init_size = 127):
         :param close_fn:        function for close processing
         :param percentile:      requested percentile (smaller value will affect bigger memory allocation),
                                 recommendation is to use 0.99 or 0.95 (0.99 is default). Accepted values are
-                                higher then 0 and lower than 1.
+                                higher than 0 and lower than 1.
         :param heap_init_size:  init size for heap (default is 127)
         """
         self._init_size = heap_init_size