diff --git a/CHANGELOG.md b/CHANGELOG.md index 0ebd0f7c1..8d7fc596f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,12 @@ ## [UNRELEASED] neptune 1.10.3 +### Fixes +- Clarified the `autoscale` parameter description in the `as_image()` docstring ([#1742](https://github.com/neptune-ai/neptune-client/pull/1742)) + ### Changes - Neptune now shows a warning instead of an error when the dependency tracking file is not found ([#1739](https://github.com/neptune-ai/neptune-client/pull/1739)) + ## neptune 1.10.2 ### Fixes diff --git a/src/neptune/types/atoms/file.py b/src/neptune/types/atoms/file.py index 8f2299cb4..f6677c55b 100644 --- a/src/neptune/types/atoms/file.py +++ b/src/neptune/types/atoms/file.py @@ -181,8 +181,9 @@ def as_image(image, autoscale: bool = True) -> "File": The input image pixel must be either in range [0.0, 1.0] (float) or [0, 255] (integer). Supported are PyTorch tensors, TensorFlow/Keras tensors, NumPy arrays, PIL images, Matplotlib figures and Seaborn figures. - autoscale: Whether Neptune should try to detect the pixel range automatically - and scale it to an acceptable format. + autoscale: Whether Neptune should try to scale image pixel values to better render them in the web app. + Scaling can distort images if their pixels lie outside the [0.0, 1.0] or [0, 255] range. + To disable auto-scaling, set the argument to False. Returns: `File`: value object with converted image