Skip to content

Commit

Permalink
release updates
Browse files Browse the repository at this point in the history
Update lab prod dockerfile to include knowledgebases
Update user docs

References #245


Former-commit-id: d70e16b
  • Loading branch information
hjwilli committed Feb 18, 2020
1 parent 1fd914c commit bd160a3
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 2 deletions.
5 changes: 4 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,8 @@
**/__pycache__
**/tmp
**/.git
data/pmlb*
data/datasets/user
data/datasets/pmlb*
data/knowledgebases/user
mock_experiment/
release/
7 changes: 7 additions & 0 deletions dockers/lab/Dockerfile_production
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ FROM python:3.7.4-stretch
COPY lab /appsrc/lab
COPY ai /appsrc/ai


#nodejs
RUN wget --quiet https://nodejs.org/dist/v11.14.0/node-v11.14.0-linux-x64.tar.xz -O ~/node.tar.xz && \
tar -xvf ~/node.tar.xz -C /opt/ && \
Expand Down Expand Up @@ -81,9 +82,15 @@ RUN dos2unix /root/start.sh \
&& dos2unix /root/entrypoint.sh


# copy knowledgebase
COPY data/knowledgebases/sklearn-benchmark5-data-knowledgebase.tsv.gz /appsrc/data/knowledgebases/
COPY data/knowledgebases/pmlb_metafeatures.csv.gz /appsrc/data/knowledgebases/


# Start the webserver
CMD ["/bin/bash", "/root/start.sh"]


# EXPOSE 443
EXPOSE 5080
WORKDIR /appsrc/lab/
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/userGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ PennAI is a multi-container docker project that uses ([Docker-Compose](https://d
## Using PennAI

### Starting and Stopping
To start PennAI, from the PennAI directory run the command `docker-compose up`. To stop PennAI, kill the process with `ctrl+c` and wait for the server to shut down. It may take a few minutes to build the first time PennAI is run.
To start PennAI, from the command line, navigate to the PennAI directory run the command `docker-compose up`. To stop PennAI, kill the process with `ctrl+c` and wait for the server to shut down. It may take a few minutes to build the first time PennAI is run.

To reset the datasets and experiments in the server, start PennAI with the command `docker-compose up --force-recreate` or run the command `docker-compose down` after the server has stopped.

Expand Down
19 changes: 19 additions & 0 deletions release/userReadme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
PennAI is an easy-to-use data science assistant. It allows researchers without machine learning or coding expertise to run supervised machine learning analysis through a clean web interface. It provides results visualization and reproducible scripts so that the analysis can be taken anywhere. And, it has an AI assistant that can choose the analysis to run for you.


Starting and Stopping
---------------------
PennAI requires that Docker version 17.06.0 or greater be installed.

To start PennAI, from the command line navigate to the PennAI directory and run the command `docker-compose up`. To stop PennAI, kill the process with ctrl+c and wait for the server to shut down. It may take a few minutes to build the first time PennAI is run.

Once the webserver is up, connect to http://localhost:5080/ to access the website. You should see the Datasets page. If it is your first time starting PennAI, there should be a message instructing one to add new datasets.


More Information
----------------
For instructions to get started with performing machine learning analysis, please refer to the Analysis Quickstart Guide:
https://epistasislab.github.io/pennai/quickstart.html

For general usage information, please refer to the User Guide:
https://epistasislab.github.io/pennai/userguide.html#using-pennai

0 comments on commit bd160a3

Please sign in to comment.