Unclear Docker volume binds for Demo
rcopstein opened this issue · comments
When running the Demo code on Docker, it took me a while before noticing that I needed to bind both $PWD/data
and $PWD/temp
(if I want the raw scores) when running the container. I would suggest adding a section to the README about executing the Demo on Docker and include something like the following snippet:
docker run -it \
--rm \
--name midas \
--volume $PWD/data:/MIDAS/data \
--volume $PWD/temp:/MIDAS/temp \
midas
Any thoughts?
Thanks for the suggestion, I think it should be fine to add such a section. Just I may need some time to test how it works (I'm not quite familiar with Docker). I'll close this issue once it's finished.
Sounds good! Take your time.
The line like --volume $PWD/data:/MIDAS/data \
just tells the container that the folder located in /MIDAS/data
(path after the colon) should mirror the contents of $PWD/data
in the local filesystem. That makes all the dataset files available inside of the container for the demo to run.
In the case of $PWD/temp
, we don't really have any content in there, but when the demo writes to it inside the container, Docker will mirror the contents back to the local filesystem, making it available even after the container exits.
Hope this helps :)