Update docs

docs/demo.rst

@@ -1,9 +1,9 @@
 Demo
 ====
 
-The logparser toolkit is implemented with Python and requires a number of `dependency requirements <./installation/dependency.html>`_ installed. Users are encouraged to set up the local environment for logparser. However, for ease of reproducing our benchmark results, we have also build `docker images <https://hub.docker.com/u/logpai/>`_ for the running evironments. Docker is a popular container technology used in production. If you have `docker installed <./install_docker.html>`_, you can easily pull and run docker containers as follows::
+The logparser toolkit is implemented with Python and requires a number of `dependency requirements <./installation/dependency.html>`_ installed. Users are encouraged to set up the local environment for logparser. However, for ease of reproducing our benchmark results, we have also build `docker images <https://hub.docker.com/u/logpai/>`_ for the running evironments. Docker is a popular container technology used in production. If you have `docker installed <./installation/install_docker.html>`_, you can easily pull and run docker containers as follows::
 
-    $ mkdir logparser # Pull the logparser repository into this directory
+    $ mkdir logparser 
     $ docker run --name logparser_py2 -it -v logparser:/logparser logpai/logparser:py2 bash
 
 Note that if you are going to try MoLFI, which requires Python 3, please run the following container::
@@ -15,15 +15,15 @@ Note that if you are going to try MoLFI, which requires Python 3, please run the
 After starting the docker containers, you can run the demos for logparser::
 
     $ git clone https://github.com/logpai/logparser.git /logparser/
-    $ cd /logparser
+    $ cd /logparser/
     $ git checkout dev # checkout dev branch
-    $ cd demo
+    $ cd demo/
     $ python Drain_demo.py
 
-The logparser demo/benchmark scripts will produce both event templates and structured logs in the result directory::
+The logparser demo/benchmark scripts will produce both event templates and structured logs in the result directory:
 
-    - HDFS_2k.log_templates.csv
-    - HDFS_2k.log_structured.csv
+- HDFS_2k.log_templates.csv
+- HDFS_2k.log_structured.csv 
 
 
 

docs/installation/build_docker_image.rst

@@ -0,0 +1,52 @@
+Build docker image
+==================
+
+Build logpai/logparser:py2
+::
+
+    $ sudo docker run --name logparser_py2 -it ubuntu:16.04 bash
+
+    $ apt-get update
+    $ apt-get install -y wget bzip2
+    $ apt-get install -y gcc perl git
+    $ rm -rf /var/lib/apt/lists/*
+
+    $ cd /
+    $ mkdir anaconda
+    $ cd anaconda
+    $ wget https://repo.anaconda.com/archive/Anaconda2-5.2.0-Linux-x86_64.sh
+    $ bash Anaconda2-5.2.0-Linux-x86_64.sh 
+    $ source ~/.bashrc
+    $ cd ..
+    $ rm -r anaconda
+    $ exit
+
+    $ docker commit logparser_py2 logpai/logparser:py2
+    $ docker login
+    $ docker push logpai/logparser:py2
+
+    
+Build logpai/logparser:py3
+::
+
+    $ sudo docker run --name logparser_py3 -it ubuntu:16.04 bash
+
+    $ apt-get update
+    $ apt-get install -y wget bzip2 git
+    $ rm -rf /var/lib/apt/lists/*
+
+    $ cd /
+    $ mkdir anaconda
+    $ cd anaconda
+    $ wget https://repo.anaconda.com/archive/Anaconda3-5.1.0-Linux-x86_64.sh
+    $ bash Anaconda3-5.1.0-Linux-x86_64.sh 
+    $ source ~/.bashrc
+    $ cd ..
+    $ rm -r anaconda
+
+    $ pip install deap
+    $ exit
+
+    $ docker commit logparser_py3 logpai/logparser:py3
+    $ docker login
+    $ docker push logpai/logparser:py3

docs/installation/dependency.rst

@@ -2,13 +2,15 @@ Dependency
 ==========
 
 The logparser toolkit has the following requirements by default. We recommend users to use `Anaconda <https://www.anaconda.com/download/#linux>`_, which is a popular Python data science platform with many common packages pre-installed.
+
 - python 2.7
 - scipy 
 - numpy 
 - scikit-learn 
 - pandas
 
 Some tools have additional dependency requirements:
+
 - SLCT: gcc 4.8.5
 - LogCluster: perl 5.22
 - MoLFI: python 3.6, deap 1.2.2

docs/installation/install_docker.rst

@@ -11,7 +11,7 @@ This is a note showing the steps of installing docker on Ubuntu platforms. If yo
 
 - **Ubuntu 14.04**
 
-    Install `linux-image-extra-*` to allow Docker to use the aufs storage drivers.
+    Install `**linux-image-extra-***` to allow Docker to use the aufs storage drivers.
     ::
 
         $ sudo apt-get update

docs/publication.md → docs/publication.rst

@@ -1,17 +1,17 @@
-Reference
-=========
+Publications
+============
 
-1. [**ICPC'18**] Salma Messaoudi, Annibale Panichella, Domenico Bianculli, Lionel Briand, Raimondas Sasnauskas. [A Search-based Approach for Accurate Identification of Log Message Formats](http://publications.uni.lu/bitstream/10993/35286/1/ICPC-2018.pdf), *IEEE/ACM International Conference on Program Comprehension (ICPC)*, 2018.
+#. [**ICPC'18**] Salma Messaoudi, Annibale Panichella, Domenico Bianculli, Lionel Briand, Raimondas Sasnauskas. `A Search-based Approach for Accurate Identification of Log Message Formats <http://publications.uni.lu/bitstream/10993/35286/1/ICPC-2018.pdf>`_, *IEEE/ACM International Conference on Program Comprehension (ICPC)*, 2018.
 
-1. [**ICWS'17**] Pinjia He, Jieming Zhu, Zibin Zheng, and Michael R. Lyu. [Drain: An Online Log Parsing Approach with Fixed Depth Tree](http://jiemingzhu.github.io/pub/pjhe_icws2017.pdf), *IEEE International Conference on Web Services (ICWS)*, 2017.
+#. [**ICWS'17**] Pinjia He, Jieming Zhu, Zibin Zheng, and Michael R. Lyu. `Drain: An Online Log Parsing Approach with Fixed Depth Tree <http://jiemingzhu.github.io/pub/pjhe_icws2017.pdf>`_, *IEEE International Conference on Web Services (ICWS)*, 2017.
 
-1. [**ICDM'16**] Min Du, Feifei Li. [Spell: Streaming Parsing of System Event Logs](https://www.cs.utah.edu/~lifeifei/papers/spell.pdf), *IEEE International Conference on Data Mining (ICDM)*, 2016.
+#. [**ICDM'16**] Min Du, Feifei Li. `Spell: Streaming Parsing of System Event Logs <https://www.cs.utah.edu/~lifeifei/papers/spell.pdf>`_, *IEEE International Conference on Data Mining (ICDM)*, 2016.
 
-1. [**CNSM'15**] Risto Vaarandi, Mauno Pihelgas. [LogCluster - A Data Clustering and Pattern Mining Algorithm for Event Logs](http://ristov.github.io/publications/cnsm15-logcluster-web.pdf), *International Conference on Network and Service Management (CNSM)*, 2015.
+#. [**CNSM'15**] Risto Vaarandi, Mauno Pihelgas. `LogCluster - A Data Clustering and Pattern Mining Algorithm for Event Logs <http://ristov.github.io/publications/cnsm15-logcluster-web.pdf>`_, *International Conference on Network and Service Management (CNSM)*, 2015.
 
-1. [**CNSM'15**] Keiichi Shima. [Length Matters: Clustering System Log Messages using Length of Words](https://arxiv.org/pdf/1611.03213.pdf), *International Conference on Network and Service Management (CNSM)*, 2015.
+#. [**CNSM'15**] Keiichi Shima. `Length Matters: Clustering System Log Messages using Length of Words <https://arxiv.org/pdf/1611.03213.pdf>`_, *International Conference on Network and Service Management (CNSM)*, 2015.
 
-1. Adetokunbo Makanju, A. Nur Zincir-Heywood, Evangelos E. Milios. [A Lightweight Algorithm for Message Type Extraction in System Application Logs](http://ieeexplore.ieee.org/abstract/document/5936060/), *IEEE Transactions on Knowledge and Data Engineering (TKDE)*, 2012.
+#. [**TKDE'12**] Adetokunbo Makanju, A. Nur Zincir-Heywood, Evangelos E. Milios. `A Lightweight Algorithm for Message Type Extraction in System Application Logs <http://ieeexplore.ieee.org/abstract/document/5936060/>`_, *IEEE Transactions on Knowledge and Data Engineering (TKDE)*, 2012.
 
 1. Liang Tang, Tao Li, Chang-Shing Perng. [LogSig: Generating System Events from Raw Textual Logs](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.222.9320&rep=rep1&type=pdf), *ACM International Conference on Information and Knowledge Management (CIKM)*, 2011.