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

[Feature] Add modules.OrnsteinUhlenbeckProcessModule #2297

Merged
merged 1 commit into from
Jul 19, 2024

Conversation

kurtamohler
Copy link
Collaborator

Description

Add OrnsteinUhlenbeckProcessModule, which serves the same purpose as OrnsteinUhlenbeckProcessWrapper, but derives from TensorDictModuleBase rather than TensorDictModuleWrapper

Motivation and Context

part of #2295

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Remove all that do not apply:

  • New feature (non-breaking change which adds core functionality)
  • Documentation (update in the documentation)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.

@kurtamohler kurtamohler requested a review from vmoens July 19, 2024 04:09
Copy link

pytorch-bot bot commented Jul 19, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/rl/2297

Note: Links to docs will display an error until the docs builds have been completed.

❌ 11 New Failures, 1 Pending, 2 Unrelated Failures

As of commit 04b1511 with merge base c4b2eb0 (image):

NEW FAILURES - The following jobs have failed:

BROKEN TRUNK - The following jobs failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jul 19, 2024
@vmoens vmoens changed the title Add modules.OrnsteinUhlenbeckProcessModule [Feature] Add modules.OrnsteinUhlenbeckProcessModule Jul 19, 2024
Copy link
Contributor

@vmoens vmoens left a comment

Choose a reason for hiding this comment

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

LGTM
nit: Since we want to deprecate the OU wrapper, can you add a deprecation warning? 2 releases from 0.5, so it will be in 0.7!
Thanks!

Comment on lines +78 to 79
OrnsteinUhlenbeckProcessModule
OrnsteinUhlenbeckProcessWrapper
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
OrnsteinUhlenbeckProcessModule
OrnsteinUhlenbeckProcessWrapper
OrnsteinUhlenbeckProcessModule

since we want to deprecate it

Copy link
Contributor

Choose a reason for hiding this comment

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

hmm upon reflection, let's keep this one, people may still see it in their code

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah I'd think it's typically a good idea to keep the old documentation and only remove it at the point when the deprecated feature is actually removed

@kurtamohler kurtamohler force-pushed the convert-wrappers-to-modules-1 branch from f7ca3f5 to 04b1511 Compare July 19, 2024 16:07
@kurtamohler
Copy link
Collaborator Author

I've added the deprecation warning

@vmoens vmoens merged commit c771e6e into pytorch:main Jul 19, 2024
41 of 54 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants