From e6d25a4e877b64cfdead1780fa8593a1d51930dd Mon Sep 17 00:00:00 2001 From: Krzysztof Godlewski Date: Mon, 21 Oct 2024 17:41:16 +0200 Subject: [PATCH 1/3] Add `*` to `log_metrics` signature --- src/neptune_scale/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/neptune_scale/__init__.py b/src/neptune_scale/__init__.py index 930134bf..8230bee2 100644 --- a/src/neptune_scale/__init__.py +++ b/src/neptune_scale/__init__.py @@ -408,6 +408,7 @@ def log_metrics( self, data: Dict[str, Union[float, int]], step: Union[float, int], + *, timestamp: Optional[datetime] = None, ) -> None: """ From 6b3fd2c06575489fe55ccd7647e5ac9597260099 Mon Sep 17 00:00:00 2001 From: Krzysztof Godlewski Date: Tue, 22 Oct 2024 14:42:44 +0200 Subject: [PATCH 2/3] Update CHANGELOG.md --- CHANGELOG.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2084cd12..54755f36 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,34 +5,48 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.7.0] + +### Changed + +- Changed the signature of `Run.log_metrics`: + - `date` is now the first parameter in line with other logging methods + - `step` is now mandatory + ## [0.6.0] - 2024-09-09 ### Added + - Dedicated exceptions for missing project or API token ([#44](https://github.com/neptune-ai/neptune-client-scale/pull/44)) ### Changed + - Removed `timestamp` parameter from `add_tags()`, `remove_tags()` and `log_configs()` methods ([#37](https://github.com/neptune-ai/neptune-client-scale/pull/37)) - Performance improvements of metadata logging ([#42](https://github.com/neptune-ai/neptune-client-scale/pull/42)) ## [0.5.0] - 2024-09-05 ### Added + - Added docstrings to logging methods ([#40](https://github.com/neptune-ai/neptune-client-scale/pull/40)) ## [0.4.0] - 2024-09-03 ### Added + - Added support for integer values when logging metric values ([#33](https://github.com/neptune-ai/neptune-client-scale/pull/33)) - Added support for async lag threshold ([#22](https://github.com/neptune-ai/neptune-client-scale/pull/22)) ## [0.3.0] - 2024-09-03 ### Added + - Package renamed to `neptune-scale` ([#31](https://github.com/neptune-ai/neptune-client-scale/pull/31)) ## [0.2.0] - 2024-09-02 ### Added + - Added minimal Run classes ([#6](https://github.com/neptune-ai/neptune-client-scale/pull/6)) - Added support for `max_queue_size` and `max_queue_size_exceeded_callback` parameters in `Run` ([#7](https://github.com/neptune-ai/neptune-client-scale/pull/7)) - Added support for logging metadata ([#8](https://github.com/neptune-ai/neptune-client-scale/pull/8)) @@ -47,8 +61,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Initial package release [unreleased]: https://github.com/neptune-ai/neptune-api/compare/0.5.0...HEAD + [0.5.0]: https://github.com/neptune-ai/neptune-api/compare/0.4.0...0.5.0 + [0.4.0]: https://github.com/neptune-ai/neptune-api/compare/0.3.0...0.4.0 + [0.3.0]: https://github.com/neptune-ai/neptune-api/compare/0.2.0...0.3.0 + [0.2.0]: https://github.com/neptune-ai/neptune-api/compare/0.1.0...0.2.0 + [0.1.0]: https://github.com/neptune-ai/neptune-api/commits/0.1.0 From 3ed1132c8a584a5e7bf3e28902fe50cb6ba23d98 Mon Sep 17 00:00:00 2001 From: Krzysztof Godlewski Date: Tue, 22 Oct 2024 14:51:09 +0200 Subject: [PATCH 3/3] Update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 583026f5..44bdaa8c 100644 --- a/README.md +++ b/README.md @@ -76,8 +76,8 @@ Inside a training loop or other iteration, use [`log_metrics()`](#log_metrics) t # inside a loop for step in range(100): run.log_metrics( - step=step, data={"acc": 0.89, "loss": 0.17}, + step=step, ) ```