Skip to content

docs: clarify reward kernel flags#761

Open
william-xue wants to merge 1 commit into
Grid2op:dev_1.12.6from
william-xue:docs/clarify-reward-kernel
Open

docs: clarify reward kernel flags#761
william-xue wants to merge 1 commit into
Grid2op:dev_1.12.6from
william-xue:docs/clarify-reward-kernel

Conversation

@william-xue

Copy link
Copy Markdown

Summary

  • Clarify how Grid2Op reward classes receive contextual flags in addition to the usual MDP reward-kernel inputs.
  • Explain that these flags distinguish the agent-submitted action from the action effectively applied by the environment, e.g. when an out-of-bounds redispatching action is replaced by do-nothing.

Validation

  • git diff --check
  • python3 content check for the added reward documentation note

Closes #737

@sonarqubecloud

Copy link
Copy Markdown

@codacy-production

codacy-production Bot commented May 31, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@BDonnot

BDonnot commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator

Hello,

Thanks again for this fix.

Same (minor) issue as for the your other one. You did not signoff (Developer Certificate of Origin (DCO) ) your commit.

Doing it is really easy in your case, you simply need, locally to type:

git commit --amend -s
git push --force

should do the trick.

The first line will simply add a "signed off by " in the message commit, which is required to contribute to open source projects hosted by the linux fundation. See https://developercertificate.org/ for more information.

Thanks again and let me know if you encounter any issues

@william-xue

Copy link
Copy Markdown
Author

Thanks for pointing this out. I amended the commit locally with a DCO sign-off; pushing the rewritten branch requires force-with-lease, so I will update the PR branch as soon as that guarded push is allowed.

Signed-off-by: william-xue <1596180987+william-xue@users.noreply.github.com>
@william-xue william-xue force-pushed the docs/clarify-reward-kernel branch from abc4ae3 to c8ed646 Compare June 19, 2026 02:24
@BDonnot BDonnot changed the base branch from master to dev_1.12.6 June 23, 2026 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reward Kernel Formulation - incorrect in docs

2 participants