Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft: Fixed wrong return type hint and updated doc string #511

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Draft: Fixed wrong return type hint and updated doc string #511

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
571bc20
Added missing return type hint and updated doc string
MyGodItsFull0fStars Mar 6, 2024
30e57cb
Merge branch 'master' into fix-stop-task-signature-and-comment
SaboniAmine Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions codecarbon/emissions_tracker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,11 +451,11 @@ def start_task(self, task_name=None) -> None:
)
self._active_task = task_name

def stop_task(self, task_name: str = None) -> float:
def stop_task(self, task_name: str = None) -> EmissionsData:
"""
Stop tracking a dedicated execution task. Delta energy is computed by task, to isolate its contribution to total
emissions.
:return: None
:return: EmissionData for an execution task
"""
task_name = task_name if task_name else self._active_task
self._measure_power_and_energy()
Expand All @@ -472,6 +472,7 @@ def stop_task(self, task_name: str = None) -> float:
self._tasks[task_name].emissions_data = task_emission_data
self._tasks[task_name].is_active = False
self._active_task = None

return task_emission_data

@suppress(Exception)
Expand Down
Loading