Change Logger plot iteration argument default to 0 (or None)

Breaking changes! arguments order changed in Logger.report_line_plot(), Logger.report_plotly() and Logger.report_matplotlib_figure()
This commit is contained in:
allegroai 2021-04-25 10:38:38 +03:00
parent 1637c1a270
commit b64c43ba54

View File

@ -170,7 +170,7 @@ class Logger(object):
title, # type: str title, # type: str
series, # type: str series, # type: str
values, # type: Sequence[Union[int, float]] values, # type: Sequence[Union[int, float]]
iteration, # type: int iteration=None, # type: Optional[int]
labels=None, # type: Optional[List[str]] labels=None, # type: Optional[List[str]]
xlabels=None, # type: Optional[List[str]] xlabels=None, # type: Optional[List[str]]
xaxis=None, # type: Optional[str] xaxis=None, # type: Optional[str]
@ -207,7 +207,7 @@ class Logger(object):
example: extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}} example: extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}
""" """
self._touch_title_series(title, series) self._touch_title_series(title, series)
return self.report_histogram(title, series, values, iteration, labels=labels, xlabels=xlabels, return self.report_histogram(title, series, values, iteration or 0, labels=labels, xlabels=xlabels,
xaxis=xaxis, yaxis=yaxis, mode=mode, extra_layout=extra_layout) xaxis=xaxis, yaxis=yaxis, mode=mode, extra_layout=extra_layout)
def report_histogram( def report_histogram(
@ -215,7 +215,7 @@ class Logger(object):
title, # type: str title, # type: str
series, # type: str series, # type: str
values, # type: Sequence[Union[int, float]] values, # type: Sequence[Union[int, float]]
iteration, # type: int iteration=None, # type: Optional[int]
labels=None, # type: Optional[List[str]] labels=None, # type: Optional[List[str]]
xlabels=None, # type: Optional[List[str]] xlabels=None, # type: Optional[List[str]]
xaxis=None, # type: Optional[str] xaxis=None, # type: Optional[str]
@ -265,7 +265,7 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
histogram=values, histogram=values,
iter=iteration, iter=iteration or 0,
labels=labels, labels=labels,
xlabels=xlabels, xlabels=xlabels,
xtitle=xaxis, xtitle=xaxis,
@ -278,7 +278,7 @@ class Logger(object):
self, self,
title, # type: str title, # type: str
series, # type: str series, # type: str
iteration, # type: int iteration=None, # type: Optional[int]
table_plot=None, # type: Optional[pd.DataFrame, Sequence[Sequence]] table_plot=None, # type: Optional[pd.DataFrame, Sequence[Sequence]]
csv=None, # type: Optional[str] csv=None, # type: Optional[str]
url=None, # type: Optional[str] url=None, # type: Optional[str]
@ -351,7 +351,7 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
table=reporter_table, table=reporter_table,
iteration=iteration, iteration=iteration or 0,
layout_config=extra_layout, layout_config=extra_layout,
) )
@ -359,10 +359,10 @@ class Logger(object):
self, self,
title, # type: str title, # type: str
series, # type: Sequence[SeriesInfo] series, # type: Sequence[SeriesInfo]
iteration, # type: int
xaxis, # type: str xaxis, # type: str
yaxis, # type: str yaxis, # type: str
mode='lines', # type: str mode='lines', # type: str
iteration=None, # type: Optional[int]
reverse_xaxis=False, # type: bool reverse_xaxis=False, # type: bool
comment=None, # type: Optional[str] comment=None, # type: Optional[str]
extra_layout=None, # type: Optional[dict] extra_layout=None, # type: Optional[dict]
@ -405,7 +405,7 @@ class Logger(object):
return self._task._reporter.report_line_plot( return self._task._reporter.report_line_plot(
title=title, title=title,
series=series, series=series,
iter=iteration, iter=iteration or 0,
xtitle=xaxis, xtitle=xaxis,
ytitle=yaxis, ytitle=yaxis,
mode=mode, mode=mode,
@ -419,7 +419,7 @@ class Logger(object):
title, # type: str title, # type: str
series, # type: str series, # type: str
scatter, # type: Union[Sequence[Tuple[float, float]], np.ndarray] scatter, # type: Union[Sequence[Tuple[float, float]], np.ndarray]
iteration, # type: int iteration=None, # type: Optional[int]
xaxis=None, # type: Optional[str] xaxis=None, # type: Optional[str]
yaxis=None, # type: Optional[str] yaxis=None, # type: Optional[str]
labels=None, # type: Optional[List[str]] labels=None, # type: Optional[List[str]]
@ -485,7 +485,7 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
data=scatter, data=scatter,
iter=iteration, iter=iteration or 0,
mode=mode, mode=mode,
xtitle=xaxis, xtitle=xaxis,
ytitle=yaxis, ytitle=yaxis,
@ -499,7 +499,7 @@ class Logger(object):
title, # type: str title, # type: str
series, # type: str series, # type: str
scatter, # type: Union[Sequence[Tuple[float, float, float]], np.ndarray] scatter, # type: Union[Sequence[Tuple[float, float, float]], np.ndarray]
iteration, # type: int iteration=None, # type: Optional[int]
xaxis=None, # type: Optional[str] xaxis=None, # type: Optional[str]
yaxis=None, # type: Optional[str] yaxis=None, # type: Optional[str]
zaxis=None, # type: Optional[str] zaxis=None, # type: Optional[str]
@ -580,7 +580,7 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
data=scatter, data=scatter,
iter=iteration, iter=iteration or 0,
labels=labels, labels=labels,
mode=mode, mode=mode,
fill=fill, fill=fill,
@ -596,7 +596,7 @@ class Logger(object):
title, # type: str title, # type: str
series, # type: str series, # type: str
matrix, # type: np.ndarray matrix, # type: np.ndarray
iteration, # type: int iteration=None, # type: Optional[int]
xaxis=None, # type: Optional[str] xaxis=None, # type: Optional[str]
yaxis=None, # type: Optional[str] yaxis=None, # type: Optional[str]
xlabels=None, # type: Optional[List[str]] xlabels=None, # type: Optional[List[str]]
@ -641,7 +641,7 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
data=matrix.astype(np.float32), data=matrix.astype(np.float32),
iter=iteration, iter=iteration or 0,
xtitle=xaxis, xtitle=xaxis,
ytitle=yaxis, ytitle=yaxis,
xlabels=xlabels, xlabels=xlabels,
@ -656,7 +656,7 @@ class Logger(object):
title, # type: str title, # type: str
series, # type: str series, # type: str
matrix, # type: np.ndarray matrix, # type: np.ndarray
iteration, # type: int iteration=None, # type: Optional[int]
xaxis=None, # type: Optional[str] xaxis=None, # type: Optional[str]
yaxis=None, # type: Optional[str] yaxis=None, # type: Optional[str]
xlabels=None, # type: Optional[List[str]] xlabels=None, # type: Optional[List[str]]
@ -683,7 +683,7 @@ class Logger(object):
example: extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}} example: extra_layout={'xaxis': {'type': 'date', 'range': ['2020-01-01', '2020-01-31']}}
""" """
self._touch_title_series(title, series) self._touch_title_series(title, series)
return self.report_confusion_matrix(title, series, matrix, iteration, return self.report_confusion_matrix(title, series, matrix, iteration or 0,
xaxis=xaxis, yaxis=yaxis, xlabels=xlabels, ylabels=ylabels, xaxis=xaxis, yaxis=yaxis, xlabels=xlabels, ylabels=ylabels,
yaxis_reversed=yaxis_reversed, yaxis_reversed=yaxis_reversed,
extra_layout=extra_layout) extra_layout=extra_layout)
@ -693,7 +693,7 @@ class Logger(object):
title, # type: str title, # type: str
series, # type: str series, # type: str
matrix, # type: np.ndarray matrix, # type: np.ndarray
iteration, # type: int iteration=None, # type: Optional[int]
xaxis=None, # type: Optional[str] xaxis=None, # type: Optional[str]
yaxis=None, # type: Optional[str] yaxis=None, # type: Optional[str]
zaxis=None, # type: Optional[str] zaxis=None, # type: Optional[str]
@ -742,7 +742,7 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
data=matrix.astype(np.float32), data=matrix.astype(np.float32),
iter=iteration, iter=iteration or 0,
xlabels=xlabels, xlabels=xlabels,
ylabels=ylabels, ylabels=ylabels,
xtitle=xaxis, xtitle=xaxis,
@ -757,7 +757,7 @@ class Logger(object):
self, self,
title, # type: str title, # type: str
series, # type: str series, # type: str
iteration, # type: int iteration=None, # type: Optional[int]
local_path=None, # type: Optional[str] local_path=None, # type: Optional[str]
image=None, # type: Optional[Union[np.ndarray, Image.Image]] image=None, # type: Optional[Union[np.ndarray, Image.Image]]
matrix=None, # type: Optional[np.ndarray] matrix=None, # type: Optional[np.ndarray]
@ -833,7 +833,7 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
src=url, src=url,
iter=iteration, iter=iteration or 0,
) )
else: else:
@ -854,7 +854,7 @@ class Logger(object):
series=series, series=series,
path=local_path, path=local_path,
image=image, image=image,
iter=iteration, iter=iteration or 0,
upload_uri=upload_uri, upload_uri=upload_uri,
max_image_history=max_image_history, max_image_history=max_image_history,
delete_after_upload=delete_after_upload, delete_after_upload=delete_after_upload,
@ -864,7 +864,7 @@ class Logger(object):
self, self,
title, # type: str title, # type: str
series, # type: str series, # type: str
iteration, # type: int iteration=None, # type: Optional[int]
local_path=None, # type: Optional[str] local_path=None, # type: Optional[str]
stream=None, # type: Optional[Union[six.BytesIO, six.StringIO]] stream=None, # type: Optional[Union[six.BytesIO, six.StringIO]]
file_extension=None, # type: Optional[str] file_extension=None, # type: Optional[str]
@ -919,7 +919,7 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
src=url, src=url,
iter=iteration, iter=iteration or 0,
) )
else: else:
@ -937,7 +937,7 @@ class Logger(object):
series=series, series=series,
path=local_path, path=local_path,
stream=stream, stream=stream,
iter=iteration, iter=iteration or 0,
upload_uri=upload_uri, upload_uri=upload_uri,
max_history=max_history, max_history=max_history,
delete_after_upload=delete_after_upload, delete_after_upload=delete_after_upload,
@ -948,8 +948,8 @@ class Logger(object):
self, self,
title, # type: str title, # type: str
series, # type: str series, # type: str
iteration, # type: int
figure, # type: Union[Dict, "Figure"] # noqa: F821 figure, # type: Union[Dict, "Figure"] # noqa: F821
iteration=None, # type: Optional[int]
): ):
""" """
Report a ``Plotly`` figure (plot) directly Report a ``Plotly`` figure (plot) directly
@ -977,15 +977,15 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
plot=plot, plot=plot,
iter=iteration, iter=iteration or 0,
) )
def report_matplotlib_figure( def report_matplotlib_figure(
self, self,
title, # type: str title, # type: str
series, # type: str series, # type: str
iteration, # type: int
figure, # type: Union[MatplotlibFigure, pyplot] figure, # type: Union[MatplotlibFigure, pyplot]
iteration=None, # type: Optional[int]
report_image=False, # type: bool report_image=False, # type: bool
): ):
""" """
@ -1008,7 +1008,7 @@ class Logger(object):
title=title, title=title,
series=series, series=series,
figure=figure, figure=figure,
iter=iteration, iter=iteration or 0,
logger=self, logger=self,
force_save_as_image='png' if report_image else False, force_save_as_image='png' if report_image else False,
) )
@ -1091,7 +1091,7 @@ class Logger(object):
self, self,
title, # type: str title, # type: str
series, # type: str series, # type: str
iteration, # type: int iteration=None, # type: Optional[int]
path=None, # type: Optional[str] path=None, # type: Optional[str]
matrix=None, # type: Optional[Union[np.ndarray, Image.Image]] matrix=None, # type: Optional[Union[np.ndarray, Image.Image]]
max_image_history=None, # type: Optional[int] max_image_history=None, # type: Optional[int]
@ -1101,7 +1101,7 @@ class Logger(object):
.. deprecated:: 0.13.0 .. deprecated:: 0.13.0
Use :meth:`Logger.report_image` instead Use :meth:`Logger.report_image` instead
""" """
self.report_image(title=title, series=series, iteration=iteration, local_path=path, image=matrix, self.report_image(title=title, series=series, iteration=iteration or 0, local_path=path, image=matrix,
max_image_history=max_image_history, delete_after_upload=delete_after_upload) max_image_history=max_image_history, delete_after_upload=delete_after_upload)
def capture_logging(self): def capture_logging(self):
@ -1234,7 +1234,7 @@ class Logger(object):
self, self,
title, # type: str title, # type: str
series, # type: str series, # type: str
iteration, # type: int iteration=None, # type: Optional[int]
path=None, # type: Optional[str] path=None, # type: Optional[str]
matrix=None, # type: Optional[np.ndarray] matrix=None, # type: Optional[np.ndarray]
max_image_history=None, # type: Optional[int] max_image_history=None, # type: Optional[int]
@ -1280,7 +1280,7 @@ class Logger(object):
series=series, series=series,
path=path, path=path,
matrix=matrix, matrix=matrix,
iter=iteration, iter=iteration or 0,
upload_uri=upload_uri, upload_uri=upload_uri,
max_image_history=max_image_history, max_image_history=max_image_history,
delete_after_upload=delete_after_upload, delete_after_upload=delete_after_upload,
@ -1290,7 +1290,7 @@ class Logger(object):
self, self,
title, # type: str title, # type: str
series, # type: str series, # type: str
iteration, # type: int iteration=None, # type: Optional[int]
path=None, # type: Optional[str] path=None, # type: Optional[str]
max_file_history=None, # type: Optional[int] max_file_history=None, # type: Optional[int]
delete_after_upload=False # type: bool delete_after_upload=False # type: bool
@ -1332,7 +1332,7 @@ class Logger(object):
series=series, series=series,
path=path, path=path,
image=None, image=None,
iter=iteration, iter=iteration or 0,
upload_uri=upload_uri, upload_uri=upload_uri,
max_image_history=max_file_history, max_image_history=max_file_history,
delete_after_upload=delete_after_upload, delete_after_upload=delete_after_upload,