Repository: incubator-systemml Updated Branches: refs/heads/master a312decb7 -> 444e2b03a
[SYSTEMML-134] Update standalone readme.txt Update outdated standalone info. Rename readme.txt to README.txt. Update standalone.xml Closes #51. Project: http://git-wip-us.apache.org/repos/asf/incubator-systemml/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-systemml/commit/444e2b03 Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/444e2b03 Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/444e2b03 Branch: refs/heads/master Commit: 444e2b03a0190e8451a12638244a23dad7808e8b Parents: a312dec Author: Deron Eriksson <[email protected]> Authored: Fri Jan 22 16:47:47 2016 -0800 Committer: Deron Eriksson <[email protected]> Committed: Fri Jan 22 16:47:47 2016 -0800 ---------------------------------------------------------------------- src/assembly/standalone.xml | 2 +- src/main/standalone/README.txt | 65 +++++++++++++++++++++++++++++++++++++ src/main/standalone/readme.txt | 11 ------- 3 files changed, 66 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/444e2b03/src/assembly/standalone.xml ---------------------------------------------------------------------- diff --git a/src/assembly/standalone.xml b/src/assembly/standalone.xml index 2850760..5979d86 100644 --- a/src/assembly/standalone.xml +++ b/src/assembly/standalone.xml @@ -135,7 +135,7 @@ <directory>${basedir}/src/main/standalone</directory> <includes> <include>log4j.properties</include> - <include>readme.txt</include> + <include>README.txt</include> <include>SystemML-config.xml</include> </includes> <outputDirectory>.</outputDirectory> http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/444e2b03/src/main/standalone/README.txt ---------------------------------------------------------------------- diff --git a/src/main/standalone/README.txt b/src/main/standalone/README.txt new file mode 100644 index 0000000..af60940 --- /dev/null +++ b/src/main/standalone/README.txt @@ -0,0 +1,65 @@ +------------------------------------------------------------------------------- +Apache SystemML (incubating) +------------------------------------------------------------------------------- + +SystemML is now an Apache Incubator project! Please see the Apache SystemML +(incubating) website at http://systemml.apache.org/ for more information. The +latest project documentation can be found at the SystemML Documentation website +on GitHub at http://apache.github.io/incubator-systemml/. + +SystemML is a flexible, scalable machine learning system. SystemML's +distinguishing characteristics are: + + 1. Algorithm customizability via R-like and Python-like languages. + 2. Multiple execution modes, including Standalone, Spark Batch, Spark + MLContext, Hadoop Batch, and JMLC. + 3. Automatic optimization based on data and cluster characteristics to ensure + both efficiency and scalability. + + +------------------------------------------------------------------------------- +SystemML in Standalone Mode +------------------------------------------------------------------------------- + +Standalone mode can be run on a single machine in a non-Hadoop environment, +allowing data scientists to develop algorithms locally without need of a +distributed cluster. The Standalone release packages all required libraries +into a single distribution. Standalone mode is not appropriate for large +datasets. + +OS X and Linux users can use the runStandaloneSystemML.sh script to run in +Standalone mode, while Windows users can use the runStandaloneSystemML.bat +script. + + +------------------------------------------------------------------------------- +Hello World Example +------------------------------------------------------------------------------- + +The following example will run a "hello world" DML script on SystemML in +Standalone mode. + +$ echo 'print("hello world");' > helloworld.dml +$ ./runStandaloneSystemML.sh helloworld.dml + + +------------------------------------------------------------------------------- +Running SystemML Algorithms +------------------------------------------------------------------------------- + +Several existing algorithms can be found in the scripts directory in the +Standalone distribution. In the following example, we first obtain Haberman's +Survival Data Set. We create a metadata file for this data. We create a +types.csv file that describes the type of each column along with a +corresponding metadata file. We then run the Univariate Statistics algorithm +on the data in Standalone mode. The results are output to the +data/univarOut.mtx file. + +$ wget -P data/ http://archive.ics.uci.edu/ml/machine-learning-databases/haberman/haberman.data +$ echo '{"rows": 306, "cols": 4, "format": "csv"}' > data/haberman.data.mtd +$ echo '1,1,1,2' > data/types.csv +$ echo '{"rows": 1, "cols": 4, "format": "csv"}' > data/types.csv.mtd +$ ./runStandaloneSystemML.sh scripts/algorithms/Univar-Stats.dml -nvargs X=data/haberman.data TYPES=data/types.csv STATS=data/univarOut.mtx + +For more information, please see the online SystemML documentation. + http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/444e2b03/src/main/standalone/readme.txt ---------------------------------------------------------------------- diff --git a/src/main/standalone/readme.txt b/src/main/standalone/readme.txt deleted file mode 100644 index 15541f5..0000000 --- a/src/main/standalone/readme.txt +++ /dev/null @@ -1,11 +0,0 @@ -SystemML enables declarative, large-scale machine learning (ML) via a high-level language with R-like syntax. Data scientists use this language to express their ML algorithms with full flexibility but without the need to hand-tune distributed runtime execution plans and system configurations. These ML programs are dynamically compiled and optimized based on data and cluster characteristics using rule and cost-based optimization techniques. The compiler automatically generates hybrid runtime execution plans ranging from in-memory, single node execution to distributed MapReduce (MR) computation and data access. - -jSystemML.jar is derived out of SystemML.jar, to work in non-Hadoop desktop/laptop environment just like a Java appln. - -We recommend to use "-exec singlenode" option, in order to force in-memory computation. - -If you see error "java.lang.OutOfMemoryError", then edit the invocation script to adjust JVM memory "-Xmx20g -Xms20g -Xmn1g". - -Please see the help/usage page at :- -java -jar jSystemML.jar -help -java -jar jSystemML.jar -? \ No newline at end of file
