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

[Docs] Documentation improvements #535

Open
jpmoutinho opened this issue Aug 15, 2024 · 1 comment
Open

[Docs] Documentation improvements #535

jpmoutinho opened this issue Aug 15, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jpmoutinho
Copy link
Collaborator

jpmoutinho commented Aug 15, 2024

Here we list a few things that need to be made more explicit in the docs:

  • The usage of set_trainable to change between feature and variational parameters in blocks. Maybe can be added in the Parameters section.
  • A few things on the usage of QuantumModel:
    • How to reset quantum model parameter values to specific value (model.reset_vparams(...))
    • How to get derivatives with respect to trainable parameters (e.g., autograd.grad(loss, qnn.parameters())).
    • How to obtain the parameter dict at a given training epoch (model._params)
  • The whole "model config" options need documentation, e.g., the quantum circuit dropout.
@jpmoutinho jpmoutinho added the documentation Improvements or additions to documentation label Aug 15, 2024
@mlahariya
Copy link
Collaborator

@jpmoutinho - Please review if a mega-issue could be created for cleaning up documentation.

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
Projects
None yet
Development

No branches or pull requests

2 participants