📝 Add docstrings to gpu-telemetry-cli
#317
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=80&v=4){kind=small}
Docstrings generation was requested by @ilana-n. * #316 (comment) The following files were modified: * `aiperf/common/config/user_config.py` * `aiperf/common/enums/metric_enums.py` * `aiperf/common/messages/telemetry_messages.py` * `aiperf/common/models/telemetry_models.py` * `aiperf/common/protocols.py` * `aiperf/controller/system_controller.py` * `aiperf/exporters/console_metrics_exporter.py` * `aiperf/exporters/csv_exporter.py` * `aiperf/exporters/exporter_manager.py` * `aiperf/exporters/gpu_telemetry_console_exporter.py` * `aiperf/exporters/json_exporter.py` * `aiperf/gpu_telemetry/telemetry_data_collector.py` * `aiperf/gpu_telemetry/telemetry_manager.py` * `aiperf/metrics/base_metric.py` * `aiperf/metrics/base_telemetry_metric.py` * `aiperf/metrics/gpu_telemetry_types/energy_consumption_metric.py` * `aiperf/metrics/gpu_telemetry_types/gpu_memory_used_metric.py` * `aiperf/metrics/gpu_telemetry_types/gpu_power_usage_metric.py` * `aiperf/metrics/gpu_telemetry_types/gpu_temperature_metric.py` * `aiperf/metrics/gpu_telemetry_types/gpu_utilization_metric.py` * `aiperf/metrics/gpu_telemetry_types/memory_clock_frequency_metric.py` * `aiperf/metrics/gpu_telemetry_types/memory_temperature_metric.py` * `aiperf/metrics/gpu_telemetry_types/sm_clock_frequency_metric.py` * `aiperf/post_processors/telemetry_results_processor.py` * `aiperf/records/records_manager.py` * `tests/gpu_telemetry/conftest.py` * `tests/gpu_telemetry/test_telemetry_data_collector.py`
|
Important Review skippedCodeRabbit bot authored PR detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ilana-n
approved these changes
Sep 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docstrings generation was requested by @ilana-n.
The following files were modified:
aiperf/common/config/user_config.pyaiperf/common/enums/metric_enums.pyaiperf/common/messages/telemetry_messages.pyaiperf/common/models/telemetry_models.pyaiperf/common/protocols.pyaiperf/controller/system_controller.pyaiperf/exporters/console_metrics_exporter.pyaiperf/exporters/csv_exporter.pyaiperf/exporters/exporter_manager.pyaiperf/exporters/gpu_telemetry_console_exporter.pyaiperf/exporters/json_exporter.pyaiperf/gpu_telemetry/telemetry_data_collector.pyaiperf/gpu_telemetry/telemetry_manager.pyaiperf/metrics/base_metric.pyaiperf/metrics/base_telemetry_metric.pyaiperf/metrics/gpu_telemetry_types/energy_consumption_metric.pyaiperf/metrics/gpu_telemetry_types/gpu_memory_used_metric.pyaiperf/metrics/gpu_telemetry_types/gpu_power_usage_metric.pyaiperf/metrics/gpu_telemetry_types/gpu_temperature_metric.pyaiperf/metrics/gpu_telemetry_types/gpu_utilization_metric.pyaiperf/metrics/gpu_telemetry_types/memory_clock_frequency_metric.pyaiperf/metrics/gpu_telemetry_types/memory_temperature_metric.pyaiperf/metrics/gpu_telemetry_types/sm_clock_frequency_metric.pyaiperf/post_processors/telemetry_results_processor.pyaiperf/records/records_manager.pytests/gpu_telemetry/conftest.pytests/gpu_telemetry/test_telemetry_data_collector.pyThese files were kept as they were
tests/gpu_telemetry/test_telemetry_models.pyThese file types are not supported
pyproject.tomlℹ️ Note