Add * to log_metrics signature

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

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,
     )
 ```
 

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:
         """