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

policy_kwargs not documented in DQN #2035

Closed
2 tasks done
pstahlhofen opened this issue Nov 6, 2024 · 7 comments Β· Fixed by #2050
Closed
2 tasks done

policy_kwargs not documented in DQN #2035

pstahlhofen opened this issue Nov 6, 2024 · 7 comments Β· Fixed by #2050
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Help from contributors is welcomed

Comments

@pstahlhofen
Copy link

πŸ“š Documentation

Currently, the documentation of DQN on the policy_kwargs parameter states the following:

policy_kwargs (Dict[str, Any] | None) – additional arguments to be passed to the policy on creation

A list of policy keyword arguments and their default settings would be very helpful here. If you think that this would take to much space, please at least add a hint to the possible policy classes and document the keyword arguments there. Spending some time reading the source code, I found the following keyword arguments for MlpPolicy:

  • net_arch
  • activation_fn
  • featuers_extractor_class
  • features_extractor_kwargs
  • normalize_images
  • optimizer_class
  • optimizer_kwargs

For other people interested in customizing those parameters: In dqn/policies.py you will find the relevant code for DQN. This can be used as a starting point as long as the documentation is not complete.

Checklist

@pstahlhofen pstahlhofen added the documentation Improvements or additions to documentation label Nov 6, 2024
@pstahlhofen
Copy link
Author

Okay, I agree that it's not completely unfindable. But yes, I still think a link would be helpful here.

@araffin
Copy link
Member

araffin commented Nov 7, 2024

Could you do a PR that links the two ? (using rst command :ref: probably and for all algorithms)

@araffin araffin added the help wanted Help from contributors is welcomed label Nov 7, 2024
@pstahlhofen
Copy link
Author

I've never done anything with rst before. I think it would be better if someone could do it who has experience with that

@araffin araffin added the good first issue Good for newcomers label Nov 8, 2024
@pstahlhofen
Copy link
Author

I have never worked with rst before, so maybe someone more experienced could do it

@kplers
Copy link
Contributor

kplers commented Dec 2, 2024

Hi @pstahlhofen,

I worked with this since it was simple enough, so I would like to submit a PR for this.
Is it OK?
Thank you.

@pstahlhofen
Copy link
Author

Yes, sure! Thank you :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Help from contributors is welcomed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants