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

[Doc] actor docstrings #2626

Merged
merged 1 commit into from
Dec 3, 2024
Merged

Conversation

valterschutz
Copy link
Contributor

Description

Changed docstrings in ProbabilisticActor and SafeProbabilisticModule to clarify that the keyword argument default_interaction_type should take one of the enum values of tensordict.nn.InteractionType. Previous documentation made me think that I had to supply the literal string, e.g "InteractionType.RANDOM".

Motivation and Context

Clearer documentation.

Types of changes

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

  • 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)
  • I have updated the documentation accordingly.

Copy link

pytorch-bot bot commented Dec 3, 2024

🔗 Helpful Links

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

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

❌ 20 New Failures

As of commit 97196a0 with merge base b2e9f29 (image):

NEW FAILURES - The following jobs have failed:

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 Dec 3, 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 thanks

@vmoens vmoens changed the title docstrings [Doc] actor docstrings Dec 3, 2024
@vmoens vmoens added the documentation Improvements or additions to documentation label Dec 3, 2024
@vmoens vmoens merged commit 8257799 into pytorch:main Dec 3, 2024
28 of 48 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. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants