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.

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

Standardize state diff stats in mdp datastore. Change variable name. #122

Merged
merged 10 commits into from
Feb 13, 2025

Conversation

SimonKamuk
Copy link
Contributor

@SimonKamuk SimonKamuk commented Feb 11, 2025

Describe your changes

This PR fixes a bug where the MDPDatastore returns non-normalized state_diff_mean and std, while NpyFilesDatastoreMEPS returns the normalized versions. See the linked issue for a discussion on this.

The fix updates the MDPDatastore to return state_diff_std_standardized and state_diff_mean_standardized in addition to the existing non-standardized versions. The NpyFilesDatastoreMEPS already only returned the standardized versions, so here the variable name has just been changed.

Also updated where get_standardization_dataarray is called to get the standardized versions.

Issue Link

Closes #112

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)

Checklist before requesting a review

  • My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the README to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form (context).
  • I have requested a reviewer and an assignee (assignee is responsible for merging). This applies only if you have write access to the repo, otherwise feel free to tag a maintainer to add a reviewer and assignee.

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change, in a section
    reflecting type of change (add section where missing):
    • added: when you have added new functionality
    • changed: when default behaviour of the code has been changed
    • fixes: when your contribution fixes a bug

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • author has added an entry to the changelog (and designated the change as added, changed or fixed)
  • Once the PR is ready to be merged, squash commits and merge the PR.

@SimonKamuk
Copy link
Contributor Author

I think this is ready for review. One question I have is whether I should keep both the normalized and non-normalized state_diff stats (this is what I've done), or if I should just remove them entirely.

@SimonKamuk SimonKamuk self-assigned this Feb 11, 2025
@SimonKamuk SimonKamuk added the bug Something isn't working label Feb 11, 2025
@SimonKamuk SimonKamuk added this to the v0.4.0 milestone Feb 11, 2025
@SimonKamuk
Copy link
Contributor Author

Also, this goes in v0.4.0, right?

Copy link
Collaborator

@joeloskarsson joeloskarsson left a comment

Choose a reason for hiding this comment

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

See small comments above (forgot to make them part of review)

@SimonKamuk
Copy link
Contributor Author

Done 👍 care to have a final look and then I'll merge?

Copy link
Collaborator

@joeloskarsson joeloskarsson left a comment

Choose a reason for hiding this comment

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

Perfect! lgtm

@SimonKamuk SimonKamuk merged commit 1c281a2 into mllam:main Feb 13, 2025
8 checks passed
@SimonKamuk SimonKamuk deleted the fix/diff_normalization branch February 13, 2025 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrong scaling of 1-step diff_std, should be standardized
2 participants