Paper: address review comments (#98)

client/purplecaffeine/widget.py

@@ -110,9 +110,9 @@ def render_trails_list(self):
         We render one button per each trial
         """
         buttons = []
-        for trial in self.trials:
+        for idx, trial in enumerate(self.trials):
             button = widgets.Button(
-                description=f"{trial.name} | {trial.uuid}"[:30],
+                description=f"{self.offset + idx + 1}. {trial.name}"[:30],
                 disabled=False,
                 button_style="",
                 tooltip=trial.uuid,

docs/conf.py

@@ -59,4 +59,8 @@
 nbsphinx_timeout = 180
 nbsphinx_execute = "never"
 nbsphinx_widgets_path = ""
+nbsphinx_thumbnails = {
+    "**": "_static/images/logo.png",
+}
+
 exclude_patterns = ["_build", "**.ipynb_checkpoints"]

docs/index.rst

@@ -68,6 +68,20 @@ Step 2: visualize tracked data
 
 ------------
 
+**Serialization**
+
+Trials are serialized using Python `json` module. We've implemented
+custom `json.JSONEncoder` and `json.JSONDecoder` to handle quantum computing objects
+like `QuantumCircuit`, `Backend`, `Operator`, etc.
+
+Encoders and decoders are using `pickle` module to serialize some classes (`Backend`).
+The pickle module is not secure. Only unpickle data you trust.
+It is possible to construct malicious pickle data which will
+execute arbitrary code during unpickling. Never unpickle data that
+could have come from an untrusted source, or that could have been tampered with.
+
+------------
+
 **Content**
 
 .. toctree::

docs/paper/paper.md

@@ -139,6 +139,19 @@ providing a convenient and interactive environment for researchers.
 
 ![Widget.\label{fig:widget}](./images/widget_updated.png)
 
+## Serialization
+
+`Trial`s are serialized using Python's `json` module. We've implemented
+custom `json.JSONEncoder` and `json.JSONDecoder` to handle quantum computing objects
+like `QuantumCircuit`, `Backend`, `Operator`, etc.
+
+Encoders and decoders are using `pickle` module to serialize some classes (`Backend`).
+The pickle module is not secure. Only unpickle data you trust.
+It is possible to construct malicious pickle data which will
+execute arbitrary code during unpickling. Never unpickle data that
+could have come from an untrusted source, or that could have been tampered with.
+
+
 # Acknowledgements
 
 We would like to express our sincere gratitude to the Qiskit Advocates Mentorship