Merge pull request #1 from NEASQC/dev

Dev
NEASQC · Apr 8, 2022 · 5d052b3 · 5d052b3
2 parents 91be869 + 2e905c0
commit 5d052b3
Show file tree

Hide file tree

Showing 68 changed files with 17 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -12,10 +12,20 @@ your@user:~$ git clone --depth 1 --releases <tag_name> <copied_url>
 ```
  * The code will be downloaded to the terminal directory
 
+## Repository structure: Pre alpha and Alpha gaps
+
+The repository contains code for the pre alpha and the alpha prototype. For the former, a task consisting of true/false sentence classification was implemented, and
+it can be found under the ´pre_alpha´ folder, along with example jupyter notebooks showing the training pipeline.
+For the latter, some research was made about hybrid quantum-classical algorithms and how quantum could fit in more complex NLP algorithm architectures. This lead to
+creating what XanaduAI calls Dressed Quantm Circuits. For this purpose, pretrained classical models are used as preprocessing layers in a transfer learning fashion. 
+We wanted to implement Neural Networks able to transform pretrained word vectors into usable lower dimensional vectors acting as the parameters for the rotations of
+variational quantum circuits. A first iteration (WIP) of this approach can be found under the folder ´alpha´. A Juyter Notebook can be found where context dependant BERT vectors 
+are retrieved for the words in a sentence, and a neural network reduce the dimensionality of the parameters to encode the sentence as a DisCoCat circuit.
+
 
 ## Jupyter notebooks
 
-The `misc/notebooks` directory contains examples demonstrating how the quantum
+An example of the pre-alpha implementation is found in  `my_lib/alpha/DressedQuantumCircuit` directory, and more examples for the pre-alpha are located in ``my_lib/pre_alpha/notebooks` containing examples demonstrating how the quantum
 and classical NLP modules are used to solve NLP-related problems (currently – a
 sentence classification task).
 
@@ -29,9 +39,11 @@ The instructions below describe the steps to set up an environment for the
 the project's root. The steps for setting up an environement for the **classical
 NLP module** are identical except for the fact that a different requirements
 file –
-[./misc/notebooks/classical/requirements.txt](./misc/notebooks/classical/requirements.txt)
+[./my_lib/pre_alpha/notebooks/classical/requirements.txt](./my_lib/pre_alpha/notebooks/classical/requirements.txt)
 – should be used.
 
+An additional [./my_lib/alpha/DressedQuantumCircuit/requirements.txt](./requirements.txt) needs to be installed to run the Notebook for the Alpha protoype demonstration.
+
 #### Dependencies
 We recommend using `virtualenv` or `anaconda` to create an isolated environment
 for the project's dependencies. Here are instructions for `virtualenv`.
@@ -73,7 +85,7 @@ python -m spacy download en_core_web_lg
 
 ### Running
 To run the the notebooks, start jupyter lab and navigate to the notebooks in
-[misc/notebooks/](./misc/notebooks/)
+[my_lib/pre_alpha/notebooks/](./my_lib/pre_alpha/notebooks/)
 
 ```sh
 # Make sure the virtual environement is activated
@@ -86,7 +98,7 @@ jupyter-lab
 
 ### More information
 Some more information about the notebooks is provided in
-[misc/notebooks/README.md](./misc/notebooks/README.md)
+[my_lib/pre_alpha/notebooks/README.md](./my_lib/pre_alpha/notebooks/README.md)
 
 ## Generating the animal dataset
 Manual dataset generation isn't necessary for running the Jupyter notebooks.
@@ -96,7 +108,7 @@ using the following commands.
 Run
 ```sh
 # Choose a seed number, e.g, 1337, to deterministically randomize the sentence order
-./my_lib/src/DataPreparation/gen_animal_dataset.py --seed 1337 > outfile
+./my_lib/pre_alpha/src/DataPreparation/gen_animal_dataset.py --seed 1337 > outfile
 ```
 to generate a tab-separated file containing lines of the form
 `<sentence>\t<sentence_type>\t<truth_value>` where `<truth_value>` is 1 if the sentence states a

diff --git a/...books/DressedQuantumCircuit/Attention.png → ...Alpha/DressedQuantumCircuit/Attention.png b/...books/DressedQuantumCircuit/Attention.png → ...Alpha/DressedQuantumCircuit/Attention.png
diff --git a/...sedQuantumCircuit/Dressed_QNLP_demo.ipynb → ...sedQuantumCircuit/Dressed_QNLP_demo.ipynb b/...sedQuantumCircuit/Dressed_QNLP_demo.ipynb → ...sedQuantumCircuit/Dressed_QNLP_demo.ipynb
diff --git a/...data with quantum computers webinar .pptx → ...data with quantum computers webinar .pptx b/...data with quantum computers webinar .pptx → ...data with quantum computers webinar .pptx
diff --git a/...books/DressedQuantumCircuit/QNLP_arch.png → ...Alpha/DressedQuantumCircuit/QNLP_arch.png b/...books/DressedQuantumCircuit/QNLP_arch.png → ...Alpha/DressedQuantumCircuit/QNLP_arch.png
diff --git a/...notebooks/DressedQuantumCircuit/Readme.md → my_lib/Alpha/DressedQuantumCircuit/Readme.md b/...notebooks/DressedQuantumCircuit/Readme.md → my_lib/Alpha/DressedQuantumCircuit/Readme.md
diff --git a/...oks/DressedQuantumCircuit/Transformer.png → ...pha/DressedQuantumCircuit/Transformer.png b/...oks/DressedQuantumCircuit/Transformer.png → ...pha/DressedQuantumCircuit/Transformer.png
diff --git a/...DressedQuantumCircuit/dressed diagram.png → ...DressedQuantumCircuit/dressed diagram.png b/...DressedQuantumCircuit/dressed diagram.png → ...DressedQuantumCircuit/dressed diagram.png
diff --git a/...ks/DressedQuantumCircuit/requirements.txt → ...ha/DressedQuantumCircuit/requirements.txt b/...ks/DressedQuantumCircuit/requirements.txt → ...ha/DressedQuantumCircuit/requirements.txt
diff --git a/my_lib/.DS_Store → my_lib/Pre_alpha/.DS_Store b/my_lib/.DS_Store → my_lib/Pre_alpha/.DS_Store
diff --git a/my_lib/__init__.py → my_lib/Pre_alpha/__init__.py b/my_lib/__init__.py → my_lib/Pre_alpha/__init__.py
diff --git a/misc/notebooks/.DS_Store → my_lib/Pre_alpha/notebooks/.DS_Store b/misc/notebooks/.DS_Store → my_lib/Pre_alpha/notebooks/.DS_Store
diff --git a/...ckpoints/Dataset_example-checkpoint.ipynb → ...ckpoints/Dataset_example-checkpoint.ipynb b/...ckpoints/Dataset_example-checkpoint.ipynb → ...ckpoints/Dataset_example-checkpoint.ipynb
diff --git a/...s/.ipynb_checkpoints/README-checkpoint.md → ...s/.ipynb_checkpoints/README-checkpoint.md b/...s/.ipynb_checkpoints/README-checkpoint.md → ...s/.ipynb_checkpoints/README-checkpoint.md
diff --git a/...checkpoints/SentenceAnsatz-checkpoint.png → ...checkpoints/SentenceAnsatz-checkpoint.png b/...checkpoints/SentenceAnsatz-checkpoint.png → ...checkpoints/SentenceAnsatz-checkpoint.png
diff --git a/.../Single_sentence_example-checkpoint.ipynb → .../Single_sentence_example-checkpoint.ipynb b/.../Single_sentence_example-checkpoint.ipynb → .../Single_sentence_example-checkpoint.ipynb
diff --git a/misc/notebooks/Dataset_example.ipynb → ...Pre_alpha/notebooks/Dataset_example.ipynb b/misc/notebooks/Dataset_example.ipynb → ...Pre_alpha/notebooks/Dataset_example.ipynb
diff --git a/misc/notebooks/README.md → my_lib/Pre_alpha/notebooks/README.md b/misc/notebooks/README.md → my_lib/Pre_alpha/notebooks/README.md
diff --git a/misc/notebooks/SentenceAnsatz.png → ...ib/Pre_alpha/notebooks/SentenceAnsatz.png b/misc/notebooks/SentenceAnsatz.png → ...ib/Pre_alpha/notebooks/SentenceAnsatz.png
diff --git a/misc/notebooks/Single_sentence_example.ipynb → ...a/notebooks/Single_sentence_example.ipynb b/misc/notebooks/Single_sentence_example.ipynb → ...a/notebooks/Single_sentence_example.ipynb
diff --git a/...oks/classical/Classical_classifiers.ipynb → ...oks/classical/Classical_classifiers.ipynb b/...oks/classical/Classical_classifiers.ipynb → ...oks/classical/Classical_classifiers.ipynb
diff --git a/misc/notebooks/classical/requirements.txt → ...lpha/notebooks/classical/requirements.txt b/misc/notebooks/classical/requirements.txt → ...lpha/notebooks/classical/requirements.txt
diff --git a/my_lib/src/.DS_Store → my_lib/Pre_alpha/src/.DS_Store b/my_lib/src/.DS_Store → my_lib/Pre_alpha/src/.DS_Store
diff --git a/my_lib/src/ClassicalNLP/.gitignore → my_lib/Pre_alpha/src/ClassicalNLP/.gitignore b/my_lib/src/ClassicalNLP/.gitignore → my_lib/Pre_alpha/src/ClassicalNLP/.gitignore
diff --git a/...c/ClassicalNLP/Classifier/NNClassifier.py → ...c/ClassicalNLP/Classifier/NNClassifier.py b/...c/ClassicalNLP/Classifier/NNClassifier.py → ...c/ClassicalNLP/Classifier/NNClassifier.py
diff --git a/...taVectorizer/BertVectorizer/.dockerignore → ...taVectorizer/BertVectorizer/.dockerignore b/...taVectorizer/BertVectorizer/.dockerignore → ...taVectorizer/BertVectorizer/.dockerignore
diff --git a/.../DataVectorizer/BertVectorizer/Dockerfile → .../DataVectorizer/BertVectorizer/Dockerfile b/.../DataVectorizer/BertVectorizer/Dockerfile → .../DataVectorizer/BertVectorizer/Dockerfile
diff --git a/...ectorizer/BertVectorizer/requirements.txt → ...ectorizer/BertVectorizer/requirements.txt b/...ectorizer/BertVectorizer/requirements.txt → ...ectorizer/BertVectorizer/requirements.txt
diff --git a/...izer/BertVectorizer/src/BertVectorizer.py → ...izer/BertVectorizer/src/BertVectorizer.py b/...izer/BertVectorizer/src/BertVectorizer.py → ...izer/BertVectorizer/src/BertVectorizer.py
diff --git a/...er/DatasetVectorizer/DatasetVectorizer.py → ...er/DatasetVectorizer/DatasetVectorizer.py b/...er/DatasetVectorizer/DatasetVectorizer.py → ...er/DatasetVectorizer/DatasetVectorizer.py
diff --git a/.../DatasetVectorizer/VectorizerConnector.py → .../DatasetVectorizer/VectorizerConnector.py b/.../DatasetVectorizer/VectorizerConnector.py → .../DatasetVectorizer/VectorizerConnector.py
diff --git a/...ctorizer/FastTextVectorizer/.dockerignore → ...ctorizer/FastTextVectorizer/.dockerignore b/...ctorizer/FastTextVectorizer/.dockerignore → ...ctorizer/FastTextVectorizer/.dockerignore
diff --git a/...aVectorizer/FastTextVectorizer/Dockerfile → ...aVectorizer/FastTextVectorizer/Dockerfile b/...aVectorizer/FastTextVectorizer/Dockerfile → ...aVectorizer/FastTextVectorizer/Dockerfile
diff --git a/...rizer/FastTextVectorizer/requirements.txt → ...rizer/FastTextVectorizer/requirements.txt b/...rizer/FastTextVectorizer/requirements.txt → ...rizer/FastTextVectorizer/requirements.txt
diff --git a/...tTextVectorizer/src/FastTextVectorizer.py → ...tTextVectorizer/src/FastTextVectorizer.py b/...tTextVectorizer/src/FastTextVectorizer.py → ...tTextVectorizer/src/FastTextVectorizer.py
diff --git a/...src/ClassicalNLP/DataVectorizer/README.md → ...src/ClassicalNLP/DataVectorizer/README.md b/...src/ClassicalNLP/DataVectorizer/README.md → ...src/ClassicalNLP/DataVectorizer/README.md
diff --git a/...tasets/dataset_vectorized_bert_cased.json → ...tasets/dataset_vectorized_bert_cased.json b/...tasets/dataset_vectorized_bert_cased.json → ...tasets/dataset_vectorized_bert_cased.json
diff --git a/...sets/dataset_vectorized_bert_uncased.json → ...sets/dataset_vectorized_bert_uncased.json b/...sets/dataset_vectorized_bert_uncased.json → ...sets/dataset_vectorized_bert_uncased.json
diff --git a/...Datasets/dataset_vectorized_fasttext.json → ...Datasets/dataset_vectorized_fasttext.json b/...Datasets/dataset_vectorized_fasttext.json → ...Datasets/dataset_vectorized_fasttext.json
diff --git a/my_lib/src/ClassicalNLP/README.md → my_lib/Pre_alpha/src/ClassicalNLP/README.md b/my_lib/src/ClassicalNLP/README.md → my_lib/Pre_alpha/src/ClassicalNLP/README.md
diff --git a/my_lib/src/DataPreparation/README.md → ...b/Pre_alpha/src/DataPreparation/README.md b/my_lib/src/DataPreparation/README.md → ...b/Pre_alpha/src/DataPreparation/README.md
diff --git a/...src/DataPreparation/gen_animal_dataset.py → ...src/DataPreparation/gen_animal_dataset.py b/...src/DataPreparation/gen_animal_dataset.py → ...src/DataPreparation/gen_animal_dataset.py
diff --git a/...aPreparation/gen_train_test_split_json.py → ...aPreparation/gen_train_test_split_json.py b/...aPreparation/gen_train_test_split_json.py → ...aPreparation/gen_train_test_split_json.py
diff --git a/my_lib/src/Quantum/.DS_Store → my_lib/Pre_alpha/src/Quantum/.DS_Store b/my_lib/src/Quantum/.DS_Store → my_lib/Pre_alpha/src/Quantum/.DS_Store
diff --git a/...ipynb_checkpoints/optimizer-checkpoint.py → ...ipynb_checkpoints/optimizer-checkpoint.py b/...ipynb_checkpoints/optimizer-checkpoint.py → ...ipynb_checkpoints/optimizer-checkpoint.py
diff --git a/my_lib/src/Quantum/Circuit.py → my_lib/Pre_alpha/src/Quantum/Circuit.py b/my_lib/src/Quantum/Circuit.py → my_lib/Pre_alpha/src/Quantum/Circuit.py
diff --git a/my_lib/src/Quantum/Datasets/.DS_Store → .../Pre_alpha/src/Quantum/Datasets/.DS_Store b/my_lib/src/Quantum/Datasets/.DS_Store → .../Pre_alpha/src/Quantum/Datasets/.DS_Store
diff --git a/...ckpoints/Complete_dataset-checkpoint.json → ...ckpoints/Complete_dataset-checkpoint.json b/...ckpoints/Complete_dataset-checkpoint.json → ...ckpoints/Complete_dataset-checkpoint.json
diff --git a/...panded_Transitive_dataset-checkpoint.json → ...panded_Transitive_dataset-checkpoint.json b/...panded_Transitive_dataset-checkpoint.json → ...panded_Transitive_dataset-checkpoint.json
diff --git a/...rc/Quantum/Datasets/Complete_dataset.json → ...rc/Quantum/Datasets/Complete_dataset.json b/...rc/Quantum/Datasets/Complete_dataset.json → ...rc/Quantum/Datasets/Complete_dataset.json
diff --git a/...Datasets/Expanded_Transitive_dataset.json → ...Datasets/Expanded_Transitive_dataset.json b/...Datasets/Expanded_Transitive_dataset.json → ...Datasets/Expanded_Transitive_dataset.json
diff --git a/...asets/Reduced_words_complete_dataset.json → ...asets/Reduced_words_complete_dataset.json b/...asets/Reduced_words_complete_dataset.json → ...asets/Reduced_words_complete_dataset.json
diff --git a/...ets/Reduced_words_transitive_dataset.json → ...ets/Reduced_words_transitive_dataset.json b/...ets/Reduced_words_transitive_dataset.json → ...ets/Reduced_words_transitive_dataset.json
diff --git a/my_lib/src/Quantum/Optimizer.py → my_lib/Pre_alpha/src/Quantum/Optimizer.py b/my_lib/src/Quantum/Optimizer.py → my_lib/Pre_alpha/src/Quantum/Optimizer.py
diff --git a/my_lib/src/Quantum/README.md → my_lib/Pre_alpha/src/Quantum/README.md b/my_lib/src/Quantum/README.md → my_lib/Pre_alpha/src/Quantum/README.md
diff --git a/...uantum/__pycache__/circuit.cpython-38.pyc → ...uantum/__pycache__/circuit.cpython-38.pyc b/...uantum/__pycache__/circuit.cpython-38.pyc → ...uantum/__pycache__/circuit.cpython-38.pyc
diff --git a/...tum/__pycache__/dictionary.cpython-38.pyc → ...tum/__pycache__/dictionary.cpython-38.pyc b/...tum/__pycache__/dictionary.cpython-38.pyc → ...tum/__pycache__/dictionary.cpython-38.pyc
diff --git a/...Quantum/__pycache__/loader.cpython-38.pyc → ...Quantum/__pycache__/loader.cpython-38.pyc b/...Quantum/__pycache__/loader.cpython-38.pyc → ...Quantum/__pycache__/loader.cpython-38.pyc
diff --git a/...ntum/__pycache__/optimizer.cpython-38.pyc → ...ntum/__pycache__/optimizer.cpython-38.pyc b/...ntum/__pycache__/optimizer.cpython-38.pyc → ...ntum/__pycache__/optimizer.cpython-38.pyc
diff --git a/...antum/__pycache__/sentence.cpython-38.pyc → ...antum/__pycache__/sentence.cpython-38.pyc b/...antum/__pycache__/sentence.cpython-38.pyc → ...antum/__pycache__/sentence.cpython-38.pyc
diff --git a/my_lib/src/Quantum/dictionary.py → my_lib/Pre_alpha/src/Quantum/dictionary.py b/my_lib/src/Quantum/dictionary.py → my_lib/Pre_alpha/src/Quantum/dictionary.py
diff --git a/my_lib/src/Quantum/loader.py → my_lib/Pre_alpha/src/Quantum/loader.py b/my_lib/src/Quantum/loader.py → my_lib/Pre_alpha/src/Quantum/loader.py
diff --git a/my_lib/src/Quantum/sentence.py → my_lib/Pre_alpha/src/Quantum/sentence.py b/my_lib/src/Quantum/sentence.py → my_lib/Pre_alpha/src/Quantum/sentence.py
diff --git a/my_lib/test_my_lib.py → my_lib/Pre_alpha/test_my_lib.py b/my_lib/test_my_lib.py → my_lib/Pre_alpha/test_my_lib.py
diff --git a/tests/.DS_Store b/tests/.DS_Store
diff --git a/tests/benchmarking/README.md b/tests/benchmarking/README.md
diff --git a/tests/test_my_lib.py b/tests/test_my_lib.py
diff --git a/tests/unit tests/README.md b/tests/unit tests/README.md