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

circuit.parameters_ and circuit.conf_ attributes not referenced in documentation #293

Open
mathew9710 opened this issue Jun 20, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@mathew9710
Copy link

mathew9710 commented Jun 20, 2024

First of all, thanks for creating this excellent tool.

I had the exact same issue as @kmylrea (described in issue #285 )

The confusion arises from the fact that attribute circuit.parameters_ is not explicitly referenced anywhere I've looked inside the documentation, unless you go digging in the source code of the circuit class.
image

So it would be nice (and time saving) if there was a reference to this attribute explicitly in the 'Circuits' page of the documentation as a way to obtain fit parameters as an iterable and not just as a console output as in print(circuit) option referenced in the examples.

The same happens with circuit.conf_ , not listed nor explained anywhere in the documentation unless you dig into the source.

@mathew9710 mathew9710 added the enhancement New feature or request label Jun 20, 2024
@mathew9710 mathew9710 changed the title circuit.parameters_ attribute not referenced in documentation circuit.parameters_ and circuit.conf_ attributes not referenced in documentation Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant