Skip to content

Make documentation for forecasts signal agnostic #614

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.

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

Conversation

unitrium
Copy link
Contributor

@unitrium unitrium commented Feb 4, 2025

Pull Request

Issue Number: Link to Github Issue or Azure Dev Ops Task/Story)

Summary

Make the documentation for forecasts, signal agnostic.

Changes

  • In the carbon aware sdk documentation, remove the mention of marginal as if you use ElectricityMaps' signals, the signals you will get are not marginal forecasts but average carbon intensity. To avoid any confusion, making the documentation signal agnostic.
  • Update the carbon aware API documentation accordingly.

Checklist

  • Local Tests Passing?
  • CICD and Pipeline Tests Passing?
  • Added any new Tests?
  • Documentation Updates Made?
  • Are there any API Changes? If yes, please describe below.
  • This is not a breaking change. If it is, please describe it below.

Are there API Changes?

If yes, what are the expected API Changes? Please link to an API-Comparison
workflow with the API Diff.

Is this a breaking change?

No, only documentation changes.

Anything else?

Please follow
GitHub's suggested syntax
to link Pull Requests to Issues via keywords

This PR Closes #612

…eply.github.com>

I, Robin TROESCH <[email protected]>, hereby add my Signed-off-by to this commit: de988b0
I, Robin TROESCH <[email protected]>, hereby add my Signed-off-by to this commit: 137cd72

Signed-off-by: Robin TROESCH <[email protected]>
@savgoodman
Copy link

+1 for this pull request - I believe we've aligned through SCI discussions that we should not be exclusively highlighting marginal emissions metrics given the challenges and limitations of that data.

Copy link
Collaborator

@danuw danuw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Thank you

@danuw danuw merged commit 13e252d into Green-Software-Foundation:dev Feb 25, 2025
9 checks passed
@danuw danuw added the v1.8 label Apr 15, 2025
@danuw danuw mentioned this pull request Apr 28, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Update wording about marginal signal
3 participants