diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 5aeef22..0000000 --- a/.gitattributes +++ /dev/null @@ -1,3 +0,0 @@ -*.zip filter=lfs diff=lfs merge=lfs -text -*.pth filter=lfs diff=lfs merge=lfs -text -*.npy filter=lfs diff=lfs merge=lfs -text diff --git a/.gitignore b/.gitignore index 9a70cc7..c3e298a 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,6 @@ vprtempo/dataset/winter/ vprtempo/dataset/event.csv vprtempo/output/ vprtempo/src/__pycache__/ +vprtempo/models/springfall_VPRTempo_IN3136_FN6272_DB500.pth +vprtempo/models/springfall_VPRTempoQuant_IN3136_FN6272_DB500.pth +tutorials/mats/1_BasicDemo/ diff --git a/README.md b/README.md index a47a25e..3edb173 100644 --- a/README.md +++ b/README.md @@ -126,18 +126,8 @@ Running VPRTempo and VPRTempoQuant is handlded by `main.py`, which can be operat * The VPRTempo dependencies have been installed and/or the conda environment has been activated ### Pretrained models -We provide two pretrained models, for `VPRTempo` and `VPRTempoQuant`, that have learned a 500 place sequence from two Nordland traversals (Spring & Fall) which can be used to inference with Summer or Winter. To get the pretrained models, please download them: +We provide two pretrained models, for `VPRTempo` and `VPRTempoQuant`, that have learned a 500 place sequence from two Nordland traversals (Spring & Fall) which can be used to inference with Summer or Winter. To get the pretrained models, please download them [here](https://www.dropbox.com/scl/fi/ysfz7t7ek6h0pslwq9hd4/VPRTempo_pretrained_models.zip?rlkey=thg0rhn0hjsyov6zov63ni11o&st=nvimet71&dl=0). -```console -# Ensure your directory is set to VPRTempo -cd ~/VPRTempo - -# If not already installed, install Git lfs -git lfs install - -# Download the pretrained models -git lfs pull -``` ### Run the inference network The `main.py` script handles running the inference network, there are two options: diff --git a/tutorials/1_BasicDemo.ipynb b/tutorials/1_BasicDemo.ipynb index 0aa5780..5d72d16 100644 --- a/tutorials/1_BasicDemo.ipynb +++ b/tutorials/1_BasicDemo.ipynb @@ -44,24 +44,7 @@ "id": "66b11853-6e17-4884-ac92-d35d814add42", "metadata": {}, "source": [ - "Next, we will need to get the pretrained weights for the model. To get them and the other materials for the , we will use [Git Large File Storage](https://git-lfs.com/) to download the required materials. Please ensure you have it downloaded on your local machine prior to running these tutorials." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "be03b081", - "metadata": {}, - "outputs": [], - "source": [ - "import subprocess\n", - "\n", - "# Run Git LFS pull command\n", - "try:\n", - " result = subprocess.run(\"git lfs pull\", shell=True, check=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)\n", - " print(\"Git LFS pull successful.\")\n", - "except subprocess.CalledProcessError as e:\n", - " print(f\"Git LFS pull failed with error:\\n{e.stderr}\")" + "Next, we will need to get the pretrained weights for the model. To get them and the other materials, please download them from [here](https://www.dropbox.com/scl/fi/bxbzm47kxl24x979q5r5s/1_BasicDemo.zip?rlkey=0umij016whwgm11frzlk63v5k&st=hncbx0ld&dl=0). Unzip the files into the `./tutorials/mats/` folder." ] }, { diff --git a/tutorials/mats/1_BasicDemo/featureQuantW.npy b/tutorials/mats/1_BasicDemo/featureQuantW.npy deleted file mode 100644 index 1cb1892..0000000 --- a/tutorials/mats/1_BasicDemo/featureQuantW.npy +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:b4724ce2ede2a5da8e147fabaef89a0dd01a972a5c86cccde0c93d3a4c8317e5 -size 19669120 diff --git a/tutorials/mats/1_BasicDemo/featureScales.npy b/tutorials/mats/1_BasicDemo/featureScales.npy deleted file mode 100644 index 4d04f81..0000000 --- a/tutorials/mats/1_BasicDemo/featureScales.npy +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:e0724b6aa310618427b23cd1793c6c78331d54b98c7d5e124007f8bec80eac4b -size 25461 diff --git a/tutorials/mats/1_BasicDemo/featureW.npy b/tutorials/mats/1_BasicDemo/featureW.npy deleted file mode 100644 index d8c5fde..0000000 --- a/tutorials/mats/1_BasicDemo/featureW.npy +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:2750afe9db94eb89bc0092cd853049f137b5b510176b4dd643d8e5521bd9c020 -size 78676096 diff --git a/tutorials/mats/1_BasicDemo/outputQuantW.npy b/tutorials/mats/1_BasicDemo/outputQuantW.npy deleted file mode 100644 index 58cf746..0000000 --- a/tutorials/mats/1_BasicDemo/outputQuantW.npy +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:4d67e54371c7357c97b613093cbbdc1d8115ff5771c8a5f6def18d12c975f791 -size 3136128 diff --git a/tutorials/mats/1_BasicDemo/outputScales.npy b/tutorials/mats/1_BasicDemo/outputScales.npy deleted file mode 100644 index dfa8b37..0000000 --- a/tutorials/mats/1_BasicDemo/outputScales.npy +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:4b2f736d092e2e9b29e9510e69623a2f285ef1c1edddb2ad6f175d56926b367f -size 2374 diff --git a/tutorials/mats/1_BasicDemo/outputW.npy b/tutorials/mats/1_BasicDemo/outputW.npy deleted file mode 100644 index 944c430..0000000 --- a/tutorials/mats/1_BasicDemo/outputW.npy +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:7d903f4762d339084c5336376a71a63a43bfae3468630f7285b7b13a6714fa43 -size 12544128 diff --git a/tutorials/mats/1_BasicDemo/summer.png b/tutorials/mats/1_BasicDemo/summer.png deleted file mode 100644 index 72f953c..0000000 Binary files a/tutorials/mats/1_BasicDemo/summer.png and /dev/null differ diff --git a/tutorials/mats/1_BasicDemo/summer_patchnorm.npy b/tutorials/mats/1_BasicDemo/summer_patchnorm.npy deleted file mode 100644 index 83fcf72..0000000 --- a/tutorials/mats/1_BasicDemo/summer_patchnorm.npy +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:179bcaf73e2a87831c1179ee7a94081956a1299e32d19b98d65debddf7d2ed33 -size 12672 diff --git a/tutorials/mats/README.txt b/tutorials/mats/README.txt new file mode 100644 index 0000000..6399477 --- /dev/null +++ b/tutorials/mats/README.txt @@ -0,0 +1,3 @@ +To download materials for BasicDemo, please visit -> https://www.dropbox.com/scl/fi/bxbzm47kxl24x979q5r5s/1_BasicDemo.zip?rlkey=0umij016whwgm11frzlk63v5k&st=52otrem5&dl=0 + +Extract into the `./tutorials/mats` folder. diff --git a/vprtempo/models/README.txt b/vprtempo/models/README.txt new file mode 100644 index 0000000..6810197 --- /dev/null +++ b/vprtempo/models/README.txt @@ -0,0 +1 @@ +To download pretrained models, please visit -> https://www.dropbox.com/scl/fi/ysfz7t7ek6h0pslwq9hd4/VPRTempo_pretrained_models.zip?rlkey=thg0rhn0hjsyov6zov63ni11o&st=nvimet71&dl=0 diff --git a/vprtempo/models/springfall_VPRTempoQuant_IN3136_FN6272_DB500.pth b/vprtempo/models/springfall_VPRTempoQuant_IN3136_FN6272_DB500.pth deleted file mode 100644 index cb018bd..0000000 --- a/vprtempo/models/springfall_VPRTempoQuant_IN3136_FN6272_DB500.pth +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:ab5aaa92015436b64df05dff469cf70f01fe4797752d672bfb37bee0a57ef057 -size 22945867 diff --git a/vprtempo/models/springfall_VPRTempo_IN3136_FN6272_DB500.pth b/vprtempo/models/springfall_VPRTempo_IN3136_FN6272_DB500.pth deleted file mode 100644 index 7b0c057..0000000 --- a/vprtempo/models/springfall_VPRTempo_IN3136_FN6272_DB500.pth +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:aca23133a42c38d41488cc53af2456c7056f5a83d5f07a83744e7813a1cd4118 -size 91249119