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

Qiskit Aqua 0.19 QuantumInstance file deletes some attributes when generating on macOS #769

Closed
Tracked by #479
Eric-Arellano opened this issue Feb 6, 2024 · 1 comment · Fixed by #770
Closed
Tracked by #479

Comments

@Eric-Arellano
Copy link
Collaborator

When on macOS, npm run gen-api -- -p qiskit -v 0.19.6 --historical results in removing 28 lines:

diff --git a/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.md
index f6ba6fe63..d21d20ebe 100644
--- a/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.md
+++ b/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.md
@@ -64,12 +64,6 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu
 
 `= ['statevector_sample_measure_opt', 'max_parallel_shots']`
 
-### COMPILE\_CONFIG
-
-<span id="qiskit.aqua.QuantumInstance.COMPILE_CONFIG" />
-
-`= ['pass_manager', 'initial_layout', 'seed_transpiler', 'optimization_level']`
-
 ### NOISE\_CONFIG
 
 <span id="qiskit.aqua.QuantumInstance.NOISE_CONFIG" />
@@ -82,28 +76,14 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu
 
 `= ['timeout', 'wait']`
 
-### RUN\_CONFIG
-
-<span id="qiskit.aqua.QuantumInstance.RUN_CONFIG" />
-
-`= ['shots', 'max_credits', 'memory', 'seed_simulator']`
-
 ### backend
 
 Return BaseBackend backend object.
 
-### backend\_config
-
-Getter of backend\_config.
-
 ### backend\_name
 
 Return backend name.
 
-### backend\_options
-
-Getter of backend\_options.
-
 ### cals\_matrix\_refresh\_period
 
 returns matrix refresh period
@@ -136,14 +116,6 @@ returns measurement error mitigation cls
 
 returns measurement error mitigation shots
 
-### noise\_config
-
-Getter of noise\_config.
-
-### qjob\_config
-
-Getter of qjob\_config.
-
 ### run\_config
 
 Getter of run\_config.

We reproduced that on 3 macOS machines. But the problem does not happen on Linux. Is it case insensitivity?

@arnaucasau
Copy link
Collaborator

arnaucasau commented Feb 6, 2024

Looking at my .out folder on Linux for the attributes that seem to be removed when regenerating qiskit 0.19.6, I found that there are two files for them that macOS is not able to download because of the case sensitivity. For example for COMPILE_CONFIG:

Captura desde 2024-02-06 17-30-13

Eric-Arellano pushed a commit that referenced this issue Feb 6, 2024
This PR regenerates the qiskit 0.19 API docs.

QuantumInstance had two HTML for some properties where a file in
ALL_CAPS defined the property itself and another file in lowercase was
the getter. Our script, when run on case-insensitive operating systems
like macOS, wasn't able to download both files, and we ended up losing
the getters.

The artifact stored on Box (https://ibm.ent.box.com/folder/246867920686)
was modified to preserve all the getters and remove the properties.

Closes #769
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
This PR regenerates the qiskit 0.19 API docs.

QuantumInstance had two HTML for some properties where a file in
ALL_CAPS defined the property itself and another file in lowercase was
the getter. Our script, when run on case-insensitive operating systems
like macOS, wasn't able to download both files, and we ended up losing
the getters.

The artifact stored on Box (https://ibm.ent.box.com/folder/246867920686)
was modified to preserve all the getters and remove the properties.

Closes Qiskit#769
@javabster javabster removed this from Docs Planning Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants