diff --git a/.idea/VIPlatform.iml b/.idea/VIPlatform.iml deleted file mode 100644 index 18ec59d..0000000 --- a/.idea/VIPlatform.iml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index ef004d1..0000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index 15c7b85..0000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index c8397c9..0000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml deleted file mode 100644 index 0363cad..0000000 --- a/.idea/workspace.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - 1576216590479 - - - - - - - - - \ No newline at end of file diff --git a/README.md b/README.md index 3055791..ad7260c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ # VIPlatform -Welcome to the VI Platform. The VI Platform is run through a series of docker containers which -operate in tandem to provide answers to questions related to popular drama's such as 'Friends'. - +The VI Platform is a Video Intelligence Platform deployed through a series of Docker containers which +operate in tandem to provide answers to questions about video clips from popular TV dramas such as 'Friends'. ## Container Setup -In order to set up the foundation of the VIPlatform, first get the __ViPlatform.tar.gz__ file currently stored on the vic server. This -contains eight tar files which are exports of the docker images needed to run the Platform. +To deploy the Video Intelligence Platform you first have to obtain a copy of the containers. The latest version can be found in the __ViPlatform.tar.gz__ file on the VIC server. This archive contains all eight tar files which are exports of the docker images needed to run the Platform. When you have this file on your desired server, extract the tar.gz file and change into the correct directory. ```console @@ -14,7 +12,7 @@ cd ViPlatform ``` In order to setup the docker images on your local machine, please run the following script with appropriate user privileges. -WARNING! This script may take some time to run and requires 200Gb of free disk space. +WARNING! This script may take some time to run and requires 200GB of free disk space. ```console sh vpp_commands.sh ``` @@ -24,16 +22,18 @@ To verify the script setup correctly run: ```console docker ps ``` -and check that the 8 required containers have been installed and are running correctly +and check that the 8 required containers have been installed and are running correctly. -## VI Platform Usage +If you would like to set up the 8 containers manually you can do so by loading their archives into docker individually. In order to load the container simply do e.g. +``` +docker load -i main.tar +``` -The VI platform is run through 8 different docker containers. The 'container_login.sh' script should be contained in -the 'ViPlatform/' directory you setup in the last step. This can be used to login to the required containers. +## VI Platform Usage +The VI platform is run through 8 different docker containers. The 'container_login.sh' script should be contained in the 'ViPlatform/' directory you setup in the last step. This can be used to login to the required containers. ### Main -The main docker container coordinates all tasks involved in responding to a VI question. -This main process MUST be run before any of the other docker processes. In order to login to the main docker container, run: +The main docker container coordinates all tasks involved in responding to a VI question. This main process MUST be run before any of the other docker processes. In order to login to the main docker container, run: ```console ./container_login.sh main ``` @@ -114,4 +114,4 @@ Next, in order to start this docker container's process; run: ```console cd workspace/Answer_Selection /opt/conda/bin/python3 predict.py -``` \ No newline at end of file +```