Added README.md file to qml_lfe 6/7. (#245)

* Add shadows I + P datataking module. 5/n

* remove p39 feature.

* Doug feedback.

* Doug feedback p2.

* Added qml_lfe Readme.md 6/7.

* reverted import practices.

* missed moves.

recirq/qml_lfe/README.md

@@ -0,0 +1,21 @@
+# Simulation and data analysis code for "Quantum advantage in learning from experiments"
+
+Code to generate main text data for [Quantum advantage in learning from experiments](https://arxiv.org/abs/2112.00778)
+
+Running `python3 -m recirq.qml_lfe.learn_***_* --help` will give a list of all available command line
+flags for each experiment file as well as a short description of what each experiment
+module does.
+
+To generate bitstring data for an 8-qubit depth-5 experiment on learning 1D physical dynamics:
+
+`python3 -m recirq.qml_lfe.learn_dynamics_c --n=8 --depth=5`
+
+`python3 -m recirq.qml_lfe.learn_dynamics_q.py --n=8 --depth=5`
+
+To generate bitstring data for an 8-qubit experiment on learning physical states:
+
+`python3 -m recirq.qml_lfe.learn_states_c.py --n=8`
+
+`python3 -m recirq.qml_lfe.learn_states_q.py --n=8`
+
+

recirq/qml_lfe/circuit_blocks_test.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 import pytest
-from . import circuit_blocks
+from recirq.qml_lfe import circuit_blocks
 import cirq
 import cirq_google
 import numpy as np

recirq/qml_lfe/dynamics_flags.py

@@ -37,7 +37,9 @@
 )
 
 flags.DEFINE_string(
-    "save_dir", "./data", "Path to save experiment data (must already exist)."
+    "save_dir",
+    "./recirq/qml_lfe/data",
+    "Path to save experiment data (must already exist).",
 )
 
 flags.DEFINE_bool("use_engine", False, "Whether or not to use quantum engine.")

recirq/qml_lfe/learn_dynamics_c.py

@@ -30,11 +30,13 @@
 import os
 import cirq
 import numpy as np
-from . import circuit_blocks
-from . import run_config
+
 from absl import app
 from absl import logging
 
+from recirq.qml_lfe import circuit_blocks
+from recirq.qml_lfe import run_config
+
 
 def _build_circuit(
     qubit_pairs: List[List[cirq.Qid]], use_tsym: bool, depth: int
@@ -132,18 +134,18 @@ def run_and_save(
 
 
 def main(_):
-    from . import dynamics_flags
-
     run_and_save(
-        dynamics_flags.n,
-        dynamics_flags.depth,
-        dynamics_flags.n_data,
-        dynamics_flags.batch_size,
-        dynamics_flags.n_shots,
-        dynamics_flags.save_dir,
-        dynamics_flags.use_engine,
+        dynamics_flags.FLAGS.n,
+        dynamics_flags.FLAGS.depth,
+        dynamics_flags.FLAGS.n_data,
+        dynamics_flags.FLAGS.batch_size,
+        dynamics_flags.FLAGS.n_shots,
+        dynamics_flags.FLAGS.save_dir,
+        dynamics_flags.FLAGS.use_engine,
     )
 
 
 if __name__ == "__main__":
+    from recirq.qml_lfe import dynamics_flags
+
     app.run(main)

recirq/qml_lfe/learn_dynamics_c_test.py

@@ -15,7 +15,7 @@
 import os
 import pytest
 import numpy as np
-from . import learn_dynamics_c
+from recirq.qml_lfe import learn_dynamics_c
 
 
 def test_shadows_dont_seperate(tmpdir):

recirq/qml_lfe/learn_dynamics_q.py

@@ -29,11 +29,13 @@
 import os
 import cirq
 import numpy as np
-from . import circuit_blocks
-from . import run_config
+
 from absl import app
 from absl import logging
 
+from recirq.qml_lfe import circuit_blocks
+from recirq.qml_lfe import run_config
+
 
 def _build_circuit(
     qubit_pairs: List[List[cirq.Qid]], use_tsym: bool, depth: int
@@ -148,18 +150,18 @@ def run_and_save(
 
 
 def main(_):
-    from . import dynamics_flags
-
     run_and_save(
-        dynamics_flags.n,
-        dynamics_flags.depth,
-        dynamics_flags.n_data,
-        dynamics_flags.batch_size,
-        dynamics_flags.n_shots,
-        dynamics_flags.save_dir,
-        dynamics_flags.use_engine,
+        dynamics_flags.FLAGS.n,
+        dynamics_flags.FLAGS.depth,
+        dynamics_flags.FLAGS.n_data,
+        dynamics_flags.FLAGS.batch_size,
+        dynamics_flags.FLAGS.n_shots,
+        dynamics_flags.FLAGS.save_dir,
+        dynamics_flags.FLAGS.use_engine,
     )
 
 
 if __name__ == "__main__":
+    from recirq.qml_lfe import dynamics_flags
+
     app.run(main)

recirq/qml_lfe/learn_dynamics_q_test.py

@@ -15,7 +15,7 @@
 import os
 import pytest
 import numpy as np
-from . import learn_dynamics_q
+from recirq.qml_lfe import learn_dynamics_q
 
 
 def test_twocopy_seperates(tmpdir):

recirq/qml_lfe/learn_states_c.py

@@ -29,12 +29,13 @@
 import cirq
 import numpy as np
 import sympy
-from . import circuit_blocks
-from . import run_config
 
 from absl import app
 from absl import logging
 
+from recirq.qml_lfe import circuit_blocks
+from recirq.qml_lfe import run_config
+
 
 def _create_basis_sweeps(
     H_params: List[sympy.Symbol],
@@ -203,17 +204,17 @@ def run_and_save(
 
 
 def main(_):
-    from . import state_flags
-
     run_and_save(
-        state_flags.n,
-        state_flags.n_paulis,
-        state_flags.n_sweeps,
-        state_flags.n_shots,
-        state_flags.save_dir,
-        state_flags.use_engine,
+        state_flags.FLAGS.n,
+        state_flags.FLAGS.n_paulis,
+        state_flags.FLAGS.n_sweeps,
+        state_flags.FLAGS.n_shots,
+        state_flags.FLAGS.save_dir,
+        state_flags.FLAGS.use_engine,
     )
 
 
 if __name__ == "__main__":
+    from recirq.qml_lfe import state_flags
+
     app.run(main)

recirq/qml_lfe/learn_states_c_test.py

@@ -2,7 +2,7 @@
 import pytest
 import tempfile
 import numpy as np
-from . import learn_states_c
+from recirq.qml_lfe import learn_states_c
 
 
 def _predict_exp(data, paulistring, two_copy):

recirq/qml_lfe/learn_states_q.py

@@ -29,12 +29,13 @@
 import cirq
 import numpy as np
 import sympy
-from . import circuit_blocks
-from . import run_config
 
 from absl import app
 from absl import logging
 
+from recirq.qml_lfe import circuit_blocks
+from recirq.qml_lfe import run_config
+
 
 def build_circuit(
     qubit_pairs: List[List[cirq.Qid]],
@@ -152,17 +153,17 @@ def run_and_save(
 
 
 def main(_):
-    from . import state_flags
-
     run_and_save(
-        state_flags.n,
-        state_flags.n_paulis,
-        state_flags.n_sweeps,
-        state_flags.n_shots,
-        state_flags.save_dir,
-        state_flags.use_engine,
+        state_flags.FLAGS.n,
+        state_flags.FLAGS.n_paulis,
+        state_flags.FLAGS.n_sweeps,
+        state_flags.FLAGS.n_shots,
+        state_flags.FLAGS.save_dir,
+        state_flags.FLAGS.use_engine,
     )
 
 
 if __name__ == "__main__":
+    from recirq.qml_lfe import state_flags
+
     app.run(main)

recirq/qml_lfe/learn_states_q_test.py

@@ -15,7 +15,7 @@
 import pytest
 import os
 import numpy as np
-from . import learn_states_q
+from recirq.qml_lfe import learn_states_q
 
 
 def _predict_exp(data, paulistring, two_copy):

recirq/qml_lfe/run_config_test.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 import pytest
 import cirq
-from . import run_config
+from recirq.qml_lfe import run_config
 import numpy as np
 
 

recirq/qml_lfe/state_flags.py

@@ -37,7 +37,9 @@
 )
 
 flags.DEFINE_string(
-    "save_dir", "./data", "Path to save experiment data (must already exist)."
+    "save_dir",
+    "./recirq/qml_lfe/data",
+    "Path to save experiment data (must already exist).",
 )
 
 flags.DEFINE_bool("use_engine", False, "Whether or not to use quantum engine.")