Skip to content

Explain dashboard usage in README #521

@jonas4climate

Description

@jonas4climate
  • CodeCarbon version: master
  • Python version: 3.11
  • Operating System: macOS 14.2.1

Description

I wanted to test out the project, so I ran the initialization and wanted to view the emission tracking using the dashboard mentioned in the README. However, I don't understand how the dashboard works or how to view my currently running project on it.

What I Did

Step 1:

Ran Jupyter Notebook:

!codecarbon init
!echo "log_level = DEBUG\nsave_to_api = True" >> .codecarbon.config
!codecarbon monitor
# Happy with just testing it out without any code running

Step 2:
Go to https://dashboard.codecarbon.io/
Here I don't know how to proceed. The overview seems global but I assumed I will be able to track my local project, however not sure how to. Do I need to specify a name somewhere and select it from the projects list perhaps?

It would be nice if the mandatory steps to use the dashboard intuitively are explained in the README

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions