Commit 4cbcbc05 authored by Philippe SWARTVAGHER's avatar Philippe SWARTVAGHER
Browse files

Add documentation for attributes of CommCompGraph

parent b563bfc1
......@@ -561,6 +561,30 @@ class CommCompGraphFormat(Enum):
class CommCompGraph:
"""
A class used to build a plot with two Y-axis: communication performance on the left one and computation performance on the right one.
Attributes
----------
comm_top_limit : int|float
The top limit for the left Y-axis.
comp_top_limit : int|float
The top limit for the right Y-axis.
fig_size : CommCompGraphFormat
The format of the resulting plot.
legend_fontsize : int|str
The fontsize for the legend. Can be an integer or a string from {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}.
x_log_scale : bool
Set according to the x_type value, can be overriden by the user, to tell if the X-axis has to have a log scale or not.
x_start : int|float
The left limit of the X-axis.
x_end : int|float
The right limit of the X-axis.
display_legend : bool
Whether the legend has to be displayed or not, default to True.
title : str
The plot title.
"""
_X_LABELS = {
"byte": "Size of transmitted data",
"thread": "Number of computing Cores",
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment