-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Comments
you mean linking https://stable-baselines3.readthedocs.io/en/master/modules/dqn.html#dqn-policies which is just below https://stable-baselines3.readthedocs.io/en/master/modules/dqn.html#parameters ? |
Okay, I agree that it's not completely unfindable. But yes, I still think a link would be helpful here. |
Could you do a PR that links the two ? (using rst command |
I've never done anything with rst before. I think it would be better if someone could do it who has experience with that |
I have never worked with rst before, so maybe someone more experienced could do it |
Hi @pstahlhofen, I worked with this since it was simple enough, so I would like to submit a PR for this. |
Yes, sure! Thank you :) |
π 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
The text was updated successfully, but these errors were encountered: